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 readsstatuson every answer and throwsTwelveDataAPIErrorwhen it sayserror, so a resolved promise means the data arrived. HTTP failures (401, 403, 429) come through as core’sApiError. - Every number is a string. Twelve Data sends prices and volumes as decimal strings (
"211.66"), and the plugin keeps that type. Convert withNumber(...)where arithmetic is needed. The exception isexchange_rate, whoserateis a JSON number. - Plan limits are per endpoint. A 403 names the plan the endpoint needs, so
earnings,splits,dividendsandprofileare 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;outputsizecaps them andstart_date/end_dateset a window. The free plan caps the interval history at 8 requests a minute.fundsandbondspage withpageandoutputsize. - Indicators return one shape each.
rsianswersvalues[].rsi,macdanswersmacd,macd_signalandmacd_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,fundsandbondsanswer 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,exchangesandetfanswer{ data: [...] }.fundsandbondsanswer{ result: { count, list } }, so their schemas differ.
- 36 typed API operations
Setup
1
Install
2
Add the plugin
corsair.ts
multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.3
Choose authentication
- API Key (Recommended)
Store the Twelve Data API key before the first call: More: API Key
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.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.
Example API calls
Read the latest quote for a symbolWhat’s next
API reference
Every
twelvedata.api.* operation with input and output types.Connect / OAuth
createLink, Hub delivery, and tenant connect flows.
Use with agents
Expose this plugin’s operations as MCP tools.