> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Twelve Data plugin

> Read quotes, prices and OHLC time series, exchange rates and technical indicators, plus the stock, forex and crypto reference lists.

Use **Twelve Data** through Corsair: one client, typed API calls.

Create a free API key at [https://twelvedata.com/pricing](https://twelvedata.com/pricing), or copy it from your dashboard. The plugin sends the key in the `Authorization: apikey <key>` header, so it never appears in a URL or in an error.

Things to know:

* **A 200 can mean the lookup failed.** An unknown symbol answers HTTP 200 with `{ code: 400, status: 'error', message: ... }`. The plugin reads `status` on every answer and throws `TwelveDataAPIError` when it says `error`, so a resolved promise means the data arrived. HTTP failures (401, 403, 429) come through as core's `ApiError`.
* **Every number is a string.** Twelve Data sends prices and volumes as decimal strings (`"211.66"`), and the plugin keeps that type. Convert with `Number(...)` where arithmetic is needed. The exception is `exchange_rate`, whose `rate` is a JSON number.
* **Plan limits are per endpoint.** A 403 names the plan the endpoint needs, so `earnings`, `splits`, `dividends` and `profile` are left out: they need a paid plan and are not part of this plugin.
* **Paging is `outputsize`.** A time series returns the newest candles by default; `outputsize` caps them and `start_date` / `end_date` set a window. The free plan caps the interval history at 8 requests a minute. `funds` and `bonds` page with `page` and `outputsize`.
* **Indicators return one shape each.** `rsi` answers `values[].rsi`, `macd` answers `macd`, `macd_signal` and `macd_hist`, and so on. Each value is a decimal string, and the schema keeps them as an open record rather than a fixed field list per indicator.
* **Reference lists are open at Twelve Data, but the plugin still needs a key.** `stocks`, `forex_pairs`, `cryptocurrencies`, `exchanges`, `etf`, `funds` and `bonds` answer without a key, which is why their shapes are the best documented here. The plugin sends the stored key on every call, so configure one before using them.
* **Two envelopes.** `stocks`, `forex_pairs`, `cryptocurrencies`, `exchanges` and `etf` answer `{ data: [...] }`. `funds` and `bonds` answer `{ result: { count, list } }`, so their schemas differ.

**What you get:**

* 36 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/twelvedata better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/twelvedata better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/twelvedata better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/twelvedata better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { twelvedata } from '@corsair-dev/twelvedata';

export const corsair = createCorsair({
	plugins: [
		twelvedata(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the Twelve Data API key before the first call: `pnpm corsair setup --plugin=twelvedata --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> twelvedata()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'twelvedata',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**Read the latest quote for a symbol**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.twelvedata.api.market.quote({ symbol: 'AAPL' });
```

**Read the current exchange rate for a currency pair**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.twelvedata.api.market.exchangeRate({ symbol: 'EUR/USD' });
```

See the full list on the [API](https://docs.corsair.dev/plugins/twelvedata/api.md) page.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/twelvedata/api.md)
>
> Every `twelvedata.api.*` operation with input and output types.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.