# Chart Kit Developer Guide

Install React Native Chart Kit, test a chart, and read documentation through Markdown, the API, or the CLI.

Last updated: September 6, 2026

## When to use Chart Kit

Use Chart Kit to add line, area, bar, pie, donut, progress, or contribution heatmap charts to a React Native app. It fits mobile dashboards, reports, trends, category comparisons, and activity screens. Use the modern API for new screens. Keep the root import when maintaining a legacy chart. Check the migration guide before changing an existing screen.

Chart Kit renders charts locally in your app. The website provides documentation and live examples. The HTTP API below serves documentation. It does not accept chart data or render chart images.

## Quickstart

```
npm install react-native-chart-kit react-native-svg
```

Import modern components from `react-native-chart-kit/v2`. Follow the [installation guide](https://chartkit.io/docs/react-native/getting-started/installation) for the current React Native requirements and a complete first chart. The [line chart playground](https://chartkit.io/docs/react-native/charts/line) provides an interactive example where you can test chart properties in the browser.

The public package uses the MIT license. Pro workflows use the separate `@chart-kit/pro` package. Read [Pro installation](https://chartkit.io/docs/react-native/charts/pro-installation) and [pricing](https://chartkit.io/docs/react-native/charts/pricing) before you select a commercial feature.

## Authentication and API keys

Public documentation, Markdown files, and the documentation API need no authentication or API key. Installing the public library needs no Chart Kit account. Pro license terms apply to production use of Pro packages. A Pro license is separate from access to the public documentation API.

## Documentation API

Use [GET /api/v1/docs](https://chartkit.io/api/v1/docs) to list the available paths. Use [GET /api/v1/docs/page?path=/docs/react-native/charts/line](https://chartkit.io/api/v1/docs/page?path=/docs/react-native/charts/line) to read one page as Markdown inside JSON. The [OpenAPI 3.1 specification](https://chartkit.io/openapi.json) defines unique operation IDs, parameters, and response schemas for function calling.

```
curl -H 'Accept: application/json' 'https://chartkit.io/api/v1/docs/page?path=/docs/react-native/charts/line'
```

The API supports GET and HEAD. Errors use JSON with `error.code`, `error.message`, and `error.hint`. A missing page returns 404. An invalid path parameter returns 400. An unsupported method returns 405. The API has no account quota. Cloudflare traffic protections can apply. Cache documentation in your client and avoid repeated bulk requests.

## Markdown and agent instructions

Start with [llms.txt](https://chartkit.io/llms.txt) to select a task and a page. Read [agent-instructions.md](https://chartkit.io/agent-instructions.md) for package and licensing rules. Public pages support `Accept: text/markdown` and a `.md` URL. The homepage Markdown URL is [/index.md](https://chartkit.io/index.md). Use [llms-full.txt](https://chartkit.io/llms-full.txt) only when you need the full public content.

```
curl -H 'Accept: text/markdown' https://chartkit.io/docs/react-native/charts/line
```

## Official CLI

The `chart-kit` CLI ships in `react-native-chart-kit` from version 7.0.4. It reads the public documentation API and writes Markdown or JSON to standard output. It makes no changes to your app and needs no API key.

```
npx --package=react-native-chart-kit chart-kit docs /docs/react-native/charts/line
```

Use `chart-kit docs` to list pages, or add `--json` for structured output. Run `chart-kit --help` for examples. Failures write a JSON error to standard error and return a nonzero exit code.

## More resources

Read the [documentation index](https://chartkit.io/docs/react-native), [migration guide](https://chartkit.io/docs/react-native/migration/from-v1), [troubleshooting guide](https://chartkit.io/docs/react-native/troubleshooting), and [contributor guide](https://chartkit.io/docs/react-native/getting-started/contributing). Browse the [public source](https://github.com/chart-kit/react-native-chart-kit) or [contact Chart Kit](https://chartkit.io/contact) for support.