Skip to main content
Twelve Data logo
  • Category: market data
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 107
  • Triggers: 0
  • Slug: TWELVE_DATA
  • Version: 20261101_00
  • Instant: Supported on the latest version. Support varies by tool.

Tools

Slug: TWELVE_DATA_BATCH_GET_QUOTESFetch quotes for 1-8 symbols in one batch, returning success or error for every symbol; partial child failures do not fail successful quotes. Charged per symbol.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requested symbolsDiscount: 79

Input Parameters

array
required
Unique ticker or provider symbols to quote, in desired response order (1-8 symbols). Charged per symbol.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_CASH_FLOWTool to get company cash flow statement. Use when you need operating, investing, and financing cash flow details after selecting a company.

Input Parameters

string
Financial Instrument Global Identifier.
string
International Securities Identification Number.
string
CUSIP identifier.
string ("annual" | "quarterly")
Reporting period; supports ‘annual’ or ‘quarterly’.
string
Ticker symbol to query (e.g., ‘AAPL’).
string
Country where instrument is traded (e.g., ‘US’).
string
Include statements with fiscal_date on or before this date (YYYY-MM-DD).
string
Exchange where the instrument is traded (e.g., ‘NASDAQ’).
string
Market Identifier Code under ISO 10383 (e.g., ‘XNAS’).
integer
Number of records to return.
string
Include statements with fiscal_date on or after this date (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_CASH_FLOW_CONSOLIDATEDRetrieve consolidated cash flow statements for a company, including modeled operating, investing, and financing cash flow details.

Input Parameters

string
Financial Instrument Global Identifier. Required if no other identifier is provided.
string
International Securities Identification Number. Required if no other identifier is provided.
string
CUSIP number. Required if no other identifier is provided.
string ("annual" | "quarterly")
Reporting period; supports ‘annual’ or ‘quarterly’. Default is ‘annual’.
string
Ticker symbol (e.g., ‘AAPL’). Required if no other identifier is provided.
string
Country name or code where instrument is traded, e.g., ‘US’.
string
Filter for statements with fiscal_date on or before this date (YYYY-MM-DD).
string
Exchange where the instrument is traded (e.g., ‘NASDAQ’).
string
Market Identifier Code (ISO 10383), e.g., ‘XNAS’.
integer
Number of records to return. Default is 6.
string
Filter for statements with fiscal_date on or after this date (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_COMMODITIES_LISTRetrieve the complete list of supported commodities.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requestsDiscount: 79

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_CONVERT_CURRENCYConvert an amount from the base to the quote currency using a current or historical forex or cryptocurrency rate.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

string
Optional historical date/time as YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS; omit for the latest rate.
number
required
Positive, finite amount in the base currency to convert into the quote currency.
string
UTC, Exchange, or a case-sensitive IANA timezone used to interpret date.
string
required
Base/quote pair separated by a slash, for example EUR/USD or BTC/ETH.
integer
Number of decimal places in the returned rate and converted amount (0-11).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_CORRELTool to fetch Pearson correlation coefficient between two series over a period. Use after selecting identifiers and interval.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

string
Financial Instrument Global Identifier.
string
International Securities Identification Number.
string
Asset class; e.g., ‘Common Stock’, ‘ETF’, ‘Digital Currency’.
string
CUSIP identifier.
string ("all" | "splits" | "dividends" | "none")
Price adjustments: all, splits, dividends, none.
string
Instrument ticker (e.g., ‘AAPL’).
string
Country where the instrument is traded (e.g., ‘United States’).
string
End datetime filter in YYYY-MM-DD or ISO 8601 format.
string
Exchange where the instrument is traded (e.g., ‘NASDAQ’).
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Time interval for the data.
string
Market Identifier Code (e.g., ‘XNAS’).
string
Timezone for interpreting start_date/end_date (e.g., ‘Asia/Singapore’).
string
Start datetime filter in YYYY-MM-DD or ISO 8601 format.
integer
Window length for correlation; integer between 1 and 800.
string ("close" | "open" | "high" | "low" | "volume")
First price series; supports close, open, high, low, volume.
string ("close" | "open" | "high" | "low" | "volume")
Second price series; supports close, open, high, low, volume.
boolean
Include previous bar’s close in series; default false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_COUNTRIES_LISTRetrieve country metadata including ISO codes, names, capitals, and currencies.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requestsDiscount: 79

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_CROSS_LISTINGSTool to retrieve cross-listed symbols for a security across multiple exchanges. Use when you need to list all market listings of a given instrument.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 API creditsDiscount: 79

Input Parameters

string
required
Ticker symbol of the instrument (e.g., ‘AAPL’).
string
Country to filter results (e.g., ‘United States’).
string
Exchange code to filter results (e.g., ‘NASDAQ’).
string
Market Identifier Code to filter results (ISO 10383, e.g., ‘XNGS’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_CRYPTOCURRENCIESList supported cryptocurrencies. Call with no arguments for the complete catalogue, or provide symbol/outputsize to return a bounded filtered list.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requestsDiscount: 79

Input Parameters

string
Comma-separated cryptocurrency symbol(s) to filter (e.g., ‘BTC,ETH’).
integer
Number of records to return, must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_CRYPTOCURRENCY_EXCHANGES_LIST_GETTool to list supported cryptocurrency exchanges. Use when you need a list of available crypto trading platforms.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requestsDiscount: 79

Input Parameters

string ("JSON" | "CSV")
Response format: JSON (default) or CSV.
string
CSV delimiter; only used when format is ‘CSV’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_CURRENCY_CONVERSIONTool to convert an amount from one currency to another. Use after confirming currency codes to retrieve real-time conversion.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requestsDiscount: 79

Input Parameters

number
required
Non-negative amount in the source currency to convert.
string
required
Three-letter ISO currency code for the target currency (e.g., ‘EUR’).
string
required
Three-letter ISO currency code for the source currency (e.g., ‘USD’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_DIVIDENDSRetrieve dividend history for a specified symbol, optionally over a selected date range. Dividend dates are ex-dates, not payment dates.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 API creditsDiscount: 79

Input Parameters

string
Time range for dividend data. Options: ‘last’, ‘next’, ‘1m’, ‘3m’, ‘6m’, ‘ytd’, ‘1y’, ‘2y’, ‘5y’, or ‘full’. Ignored if start_date is provided.
string
required
Stock ticker symbol (e.g., ‘AAPL’). Use dot delimiter for preferred stocks (e.g., ‘BRK.A’).
string
Country name or alpha code where the instrument is traded (e.g., ‘United States’ or ‘US’).
string
End date in YYYY-MM-DD format. Used together with start_date.
string
Exchange name where the instrument is traded (e.g., ‘NASDAQ’).
string
Market Identifier Code (MIC) per ISO 10383 standard (e.g., ‘XNAS’).
string
Start date in YYYY-MM-DD format. Takes precedence over ‘range’ parameter if both are provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_EARNINGSTool to retrieve earnings data including EPS estimates and actuals. Use when you need detailed earnings history for a selected stock symbol.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 API creditsDiscount: 79

Input Parameters

string ("annual" | "quarterly")
Type of earnings report: ‘annual’ or ‘quarterly’.
string ("JSON" | "CSV")
Response format: ‘JSON’ (default) or ‘CSV’.
string
Optional data source override.
string
required
Ticker symbol of the equity, e.g., ‘AAPL’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_EPS_REVISIONSTool to provide analysts’ revisions of a company’s future EPS over the last week and month. Use after confirming the stock symbol.

Input Parameters

integer
Number of decimal places for numeric values.
string
Response format. Only ‘json’ is supported.
string
required
Stock symbol to request data for (e.g., ‘AAPL’).
string
Exchange code (e.g., ‘NASDAQ’). Auto-detected from symbol if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_EPS_TREND_ACTIONTool to retrieve EPS trend estimates for a specified company. Use after selecting a stock symbol to view how EPS estimates have changed over time. Returns EPS estimates for next quarter, current year, and next year, showing how estimates have evolved from 7, 30, 60, and 90 days ago.

Input Parameters

string
required
The symbol of the instrument (e.g., ‘AAPL’).
string
Country code for the exchange (e.g., ‘US’).
string
Exchange code where the symbol is traded (e.g., ‘NASDAQ’). Auto-detected if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_ETFS_DIRECTORYTool to fetch a daily updated list of exchange-traded funds sorted by total assets. Use when you need a directory of ETFs by exchange or country.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requestsDiscount: 79

Input Parameters

string ("JSON" | "CSV")
Response format: ‘JSON’ (default) or ‘CSV’.
string
Filter ETFs by country code (e.g., ‘US’).
string
Filter ETFs by exchange code (e.g., ‘NASDAQ’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_ETFS_FAMILYRetrieve ETF family names grouped by country, optionally filtered by family name.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requestsDiscount: 79

Input Parameters

string
Name of the ETF family to filter by (e.g., ‘Vanguard’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_ETFS_TYPETool to retrieve ETF categories by market, including types like ‘Equity Precious Metals’. No parameters are needed. Returns a dictionary mapping country names to lists of ETF types available in that country.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requestsDiscount: 79

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_ETFS_WORLDTool to fetch comprehensive ETF analytics (summary, performance, risk, composition). Use when you need a detailed overview of an ETF’s metrics and holdings.

Input Parameters

integer
Decimal places for floating values; range 0–11. Defaults to 5.
string
Financial Instrument Global Identifier.
string
International Securities Identification Number.
string
CUSIP code of the instrument.
string
ETF ticker symbol (e.g., ‘IVV’).
string
Country name or ISO code (e.g., ‘United States’ or ‘US’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_ETFS_WORLD_COMPOSITIONTool to fetch global ETF composition details including sector, country, asset allocations, top holdings, and bond metrics. Use after selecting an ETF to analyze its composition.

Input Parameters

integer
Decimal places for floating values; range [0, 11]. Default is 5.
string
Financial Instrument Global Identifier of the ETF. One of symbol, figi, isin, or cusip is required.
string
International Securities Identification Number of the ETF. One of symbol, figi, isin, or cusip is required.
string
CUSIP identifier of the ETF. One of symbol, figi, isin, or cusip is required.
string
Ticker symbol of the ETF. One of symbol, figi, isin, or cusip is required.
string
Filter composition by country name or alpha code (e.g., ‘United States’ or ‘US’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_ETFS_WORLD_RISKRetrieve global ETF risk metrics, including volatility and valuation ratios. Provider errors may be returned in the response status and message.

Input Parameters

integer
Decimal places for floating values; range 0–11. Defaults to 5.
string
Financial Instrument Global Identifier.
string
International Securities Identification Number.
string
CUSIP code of the instrument.
string
ETF ticker symbol (e.g., ‘IVV’).
string
Country name or ISO code (e.g., ‘United States’ or ‘US’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_EXCHANGESTool to retrieve a list of supported exchanges. Use when you need all available stock and forex exchanges.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requestsDiscount: 79

Input Parameters

string ("json" | "csv")
Response format; allowed values: json, csv
string
Filter exchanges by 2-letter ISO country code, e.g., ‘US’, ‘GB’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_FOREX_PAIRSTool to retrieve a list of all supported forex currency pairs. Use when exploring available forex pairs before making other forex data requests.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requestsDiscount: 79

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_ADTool to retrieve Accumulation/Distribution (AD) indicator data for a financial instrument. The AD line uses closing price, price range, and trading volume to identify buying or selling pressure and assess price movement strength.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.
string
Specifies the exact date to get the data for. Could be the exact date, e.g. ‘2021-10-27’, or in human language ‘today’ or ‘yesterday’.
string
The FIGI of an instrument for which data is requested. This request parameter is available starting with the Ultra plan.
string
Filter by international securities identification number (ISIN). ISIN access is activated in the Data add-ons section.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
Asset class to which the instrument belongs.
string
The CUSIP of an instrument for which data is requested. CUSIP access is activated in the Data add-ons section.
string ("asc" | "desc")
Sorting order of the output.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices.
string ("JSON" | "CSV")
Format of the response data.
string
Symbol ticker of the instrument. E.g. ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’. Either symbol, isin, figi, or cusip must be provided.
string
The country where the instrument is traded, e.g., ‘United States’ or ‘US’.
boolean
Returns quotes that include pre-market and post-market data. Only for Pro and above plans. Available at the 1min, 5min, 15min, and 30min intervals for US equities. Open, high, low, close values are supplied without volume.
string
The ending date and time for data selection. Format ‘2006-01-02’ or ‘2006-01-02T15:04:05’. Works together with start_date.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed. Supports: ‘Exchange’ for local exchange time, ‘UTC’ for universal UTC standard, or timezone name according to IANA Time Zone Database (e.g., ‘America/New_York’, ‘Asia/Singapore’). The IANA Timezone name is case-sensitive.
string
The separator used in the CSV response data. Default is ’;’.
integer
Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set, otherwise set to maximum.
string
Can be used separately and together with end_date. Format ‘2006-01-02’ or ‘2006-01-02T15:04:05’. If timezone is given, start_date will be used in the specified location. Returns all records starting from start_date up to current date or end_date if provided.
boolean
Specify if OHLC values should be added in the output.
boolean
A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_API_USAGERetrieve API credit usage and remaining credits from response headers, with the current plan when present in the response body. The request fails if the required credit headers are missing or invalid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_APOTool to calculate the Absolute Price Oscillator (APO) for a financial instrument. The APO measures the difference between two moving averages to identify price trends and momentum changes. Use when you need to analyze momentum and potential price reversals.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Number of decimal places for floating values (range: 0-11).
string
Exact date to get data for. Format: ‘2021-10-27’, ‘today’, or ‘yesterday’.
string
The FIGI of an instrument. Available starting with the Ultra plan.
string
International securities identification number (ISIN). Requires Data add-ons subscription.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
Asset class types.
string
The CUSIP of an instrument. Requires Data add-ons subscription.
string ("asc" | "desc")
Sorting order for output.
string ("all" | "splits" | "dividends" | "none")
Price adjustment mode.
string ("JSON" | "CSV")
Response format options.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’). Either symbol, isin, figi, or cusip must be provided.
string
The country where the instrument is traded (e.g., ‘United States’ or ‘US’).
string ("SMA" | "EMA" | "WMA" | "DEMA" | "TEMA" | "TRIMA" | "KAMA" | "MAMA" | "T3MA")
Moving average type.
boolean
Include pre-market and post-market data. Only for Pro+ plans at 1min, 5min, 15min, 30min intervals for US equities.
string
Ending date for data selection. See start_date description for format details.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone for output datetime. Options: ‘Exchange’ (local), ‘UTC’, or IANA timezone name (e.g., ‘America/New_York’).
string
The separator used in CSV response data.
integer
Number of data points to retrieve (range: 1-5000). Default 30 when no date parameters are set.
string
Starting date for data selection. Format: ‘2006-01-02’ or ‘2006-01-02T15:04:05’. Can be used with or without end_date.
integer
Number of periods for fast moving average (range: 1-800, default: 12).
string ("close" | "open" | "high" | "low" | "volume")
Price type for technical indicator calculation.
integer
Number of periods for slow moving average (range: 1-800, default: 26).
boolean
Specify if OHLC values should be added in the output.
boolean
Include the previous closing price in time_series data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_AROONTool to retrieve Aroon Indicator data for identifying market trends. Returns Aroon Up and Aroon Down values showing time elapsed since highest high and lowest low. Use when analyzing trend direction and momentum for a specific symbol.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default (-1), the number of decimal places is automatically determined.
string
Specifies the exact date to get the data for. Could be the exact date (e.g., ‘2021-10-27’), or in human language ‘today’ or ‘yesterday’.
string
Financial Instrument Global Identifier (FIGI).
string
International securities identification number (ISIN).
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
Committee on Uniform Securities Identification Procedures (CUSIP) identifier.
string ("asc" | "desc")
Sorting order of the output.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices.
string
The format of the response data.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’). At least one of symbol, isin, figi, or cusip must be provided.
string
The country where the instrument is traded (e.g., ‘United States’ or ‘US’).
boolean
Returns quotes that include pre-market and post-market data. Only for Pro and above plans. Available at the 1min, 5min, 15min, and 30min intervals for US equities.
string
End date for data selection in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed. Supports ‘Exchange’ for local exchange time, ‘UTC’ for UTC standard, or IANA timezone names (e.g., ‘America/New_York’, ‘Asia/Singapore’).
integer
Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set.
string
Start date for data selection in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS. Can be used separately or together with end_date.
integer
Number of periods to average over. Takes values in the range from 1 to 800. Default is 14.
boolean
Specify if OHLC values should be added in the output.
boolean
A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_BALANCE_SHEETTool to retrieve a company’s balance sheet (assets, liabilities, equity). Use when you need annual or quarterly financial position data for a given symbol or identifier.

Input Parameters

string
Filter by FIGI (e.g., ‘BBG01293F5X4’). Required if other identifiers are not provided.
string
Filter by ISIN (e.g., ‘US0378331005’). Required if other identifiers are not provided.
string
Filter by CUSIP (e.g., ‘594918104’). Required if other identifiers are not provided.
string ("annual" | "quarterly")
Reporting period; ‘annual’ or ‘quarterly’. Default is ‘annual’.
string
Ticker of the instrument (e.g., ‘AAPL’). Required if other identifiers are not provided.
string
Country name or two-letter code (e.g., ‘United States’ or ‘US’).
string
Inclusive filter: fiscal_date on or before this date (YYYY-MM-DD).
string
Exchange where the instrument is traded (e.g., ‘NASDAQ’).
string
Market Identifier Code (ISO 10383) (e.g., ‘XNAS’).
integer
Maximum number of periods to return. Default is 6.
string
Inclusive filter: fiscal_date on or after this date (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_BALANCE_SHEET_CONSOLIDATEDTool to get raw consolidated balance sheet data (assets, liabilities, equity) for a company. Use when you need detailed historical balance sheet by period.

Input Parameters

string
Financial Instrument Global Identifier filter.
string
International Securities Identification Number filter.
string
CUSIP filter.
string ("annual" | "quarterly")
Reporting period; supports ‘annual’ or ‘quarterly’. Default is ‘annual’.
string
Ticker symbol of the company (e.g., ‘AAPL’).
string
Country where the instrument is traded (name or code).
string
Filter results with fiscal_date on or before this date (YYYY-MM-DD).
string
Exchange where the instrument is traded.
string
ISO 10383 Market Identifier Code.
integer
Number of periods to return; default is 6.
string
Filter results with fiscal_date on or after this date (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_BBANDSRetrieve Bollinger Bands for a financial instrument, including upper, middle, and lower bands, to assess market volatility and potential price reversals. The moving average type can be selected.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Number of decimal places for floating values. Range: 0-11 inclusive.
number
Number of standard deviations. Must be at least 1.
string
Specific date to get data for. Can be exact date like ‘2021-10-27’, or ‘today’/‘yesterday’.
string
Financial Instrument Global Identifier (FIGI). Available starting with Ultra plan.
string
International Securities Identification Number (ISIN). Requires activation in Data add-ons section.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
Asset class types supported by the API.
string
CUSIP identifier. Requires activation in Data add-ons section.
string ("asc" | "desc")
Sorting order for the output.
string ("all" | "splits" | "dividends" | "none")
Price adjustment mode.
string ("JSON" | "CSV")
Response format type.
string
Symbol ticker of the instrument. E.g. ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’. At least one of symbol, isin, figi, or cusip must be provided.
string
The country where the instrument is traded, e.g., ‘United States’ or ‘US’.
string ("SMA" | "EMA" | "WMA" | "DEMA" | "TEMA" | "TRIMA" | "KAMA" | "MAMA" | "T3MA")
Type of moving average used for Bollinger Bands.
boolean
Include pre-market and post-market data. Only for Pro and above plans. Available at 1min, 5min, 15min, 30min intervals for US equities.
string
End date for data selection. Format: ‘2006-01-02’ or ‘2006-01-02T15:04:05’. See start_date for details.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Time interval between two consecutive data points.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone for datetime display. Supports ‘Exchange’, ‘UTC’, or IANA timezone names like ‘America/New_York’.
string
The separator used in CSV response data.
integer
Number of data points to retrieve. Supports values from 1 to 5000. Default 30 when no date parameters are set.
string
Start date for data selection. Format: ‘2006-01-02’ or ‘2006-01-02T15:04:05’. Can be used with end_date.
string ("close" | "open" | "high" | "low" | "volume")
Price type for technical indicator calculation.
integer
Number of periods to average over. Range: 1 to 800.
boolean
Specify if OHLC (Open, High, Low, Close) values should be added in the output.
boolean
Include the previous closing price in time_series data. Adds previous bar close price value to current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_BONDSRetrieve a list of available bonds with optional symbol, exchange, or country filters. For JSON responses, check the returned status: provider errors can be returned with an empty result list.

Input Parameters

integer
Page number of the results to fetch. Used for pagination.
string ("JSON" | "CSV")
The format of the response data: ‘JSON’ or ‘CSV’.
string
The ticker symbol of a bond for which data is requested (e.g., ‘US2Y’).
string
Filter by country name or alpha code (e.g., ‘United States’ or ‘US’).
string
Filter by exchange name (e.g., ‘NYSE’).
string
The separator used in CSV response data. Only applicable when format is ‘CSV’. Defaults to ’;’ if not specified.
boolean
If true, adds information on which plan the bond symbol is available in.
integer
Determines the number of data points returned in the output. Defaults to 5000 if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_CCITool to retrieve Commodity Channel Index (CCI) values for a specified security. Use when you need to detect potential price reversals by identifying overbought or oversold conditions through momentum analysis.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.
string
Specifies the exact date to get the data for. Could be the exact date, e.g. ‘2021-10-27’, or in human language ‘today’ or ‘yesterday’.
string
The FIGI of an instrument for which data is requested. Available starting with the Ultra plan.
string
Filter by international securities identification number (ISIN). ISIN access is activated in the Data add-ons section.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
The CUSIP of an instrument for which data is requested. CUSIP access is activated in the Data add-ons section.
string ("asc" | "desc")
Sorting order of the output.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices.
string ("JSON" | "CSV")
The format of the response data.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’). Either symbol, isin, figi, or cusip must be provided.
string
The country where the instrument is traded, e.g., ‘United States’ or ‘US’.
boolean
Returns quotes that include pre-market and post-market data. Only for Pro and above plans. Available at the 1min, 5min, 15min, and 30min intervals for US equities. Open, high, low, close values are supplied without volume.
string
The ending date and time for data selection, see start_date description for details.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed. Supports: ‘Exchange’ for local exchange time, ‘UTC’ for datetime at universal UTC standard, or timezone name according to the IANA Time Zone Database (e.g., ‘America/New_York’, ‘Asia/Singapore’). The IANA Timezone name is case-sensitive.
string
The separator used in the CSV response data.
integer
Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set, otherwise set to maximum.
string
Can be used separately and together with end_date. Format ‘2006-01-02’ or ‘2006-01-02T15:04:05’. Both parameters take into account if timezone parameter is provided.
integer
Number of periods to average over. Takes values in the range from 1 to 800. Default is 20.
boolean
Specify if OHLC values should be added in the output.
boolean
A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_CEILTool to retrieve the Ceiling (CEIL) transformation for a time series. Rounds each value in the input data series up to the nearest whole number. Use when you need ceiling-adjusted price data for a symbol.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive.
string
Specifies exact date to get data for. Could be exact date (e.g., ‘2021-10-27’) or in human language (‘today’ or ‘yesterday’).
string
Financial Instrument Global Identifier (FIGI) of the instrument.
string
International Securities Identification Number (ISIN) of the instrument.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
CUSIP identifier of the instrument.
string ("asc" | "desc")
Sorting order of the output. Default is ‘desc’.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices. Default is ‘splits’.
string ("JSON" | "CSV")
The format of the response data. Default is ‘JSON’.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’). At least one of symbol, isin, figi, or cusip must be provided.
string
Country where the instrument is traded (e.g., ‘United States’ or ‘US’).
boolean
Returns quotes that include pre-market and post-market data. Only for Pro and above plans. Available at 1min, 5min, 15min, and 30min intervals for US equities.
string
End date for data selection in format ‘YYYY-MM-DD’ or ‘YYYY-MM-DDTHH:MM:SS’. See start_date for more details.
string
Exchange where the instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Time interval between two consecutive points in the time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed. Supports ‘Exchange’ for local exchange time, ‘UTC’ for universal time, or IANA timezone names (e.g., ‘America/New_York’, ‘Asia/Singapore’).
string
The separator used in the CSV response data. Default is ’;’.
integer
Number of data points to retrieve. Supports values from 1 to 5000. Default is 30 when no date parameters are set.
string
Start date for data selection in format ‘YYYY-MM-DD’ or ‘YYYY-MM-DDTHH:MM:SS’. Can be used separately or together with end_date.
string ("close" | "open" | "high" | "low" | "volume")
Price type on which technical indicator is calculated. Default is ‘close’.
boolean
Specify if OHLC values should be added in the output.
boolean
A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_CMOTool to retrieve Chande Momentum Oscillator (CMO) data for a security. Use when you need to analyze momentum and identify overbought or oversold conditions. Requires at least one instrument identifier (symbol, isin, figi, or cusip) and an interval.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.
string
Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday
string
The FIGI of an instrument for which data is requested. This request parameter is available starting with the Ultra plan.
string
Filter by international securities identification number (ISIN). ISIN access is activated in the Data add-ons section.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs
string
The CUSIP of an instrument for which data is requested. CUSIP access is activated in the Data add-ons section.
string ("asc" | "desc")
Sorting order of the output
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices
string ("JSON" | "CSV")
The format of the response data
string
Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, …
string
The country where the instrument is traded, e.g., United States or US
boolean
Returns quotes that include pre-market and post-market data. Only for Pro and above plans. Available at the 1min, 5min, 15min, and 30min intervals for US equities. Open, high, low, close values are supplied without volume.
string
The ending date and time for data selection, see start_date description for details.
string
Exchange where instrument is traded
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series
string
Market Identifier Code (MIC) under ISO 10383 standard
string
Timezone at which output datetime will be displayed. Supports: Exchange for local exchange time, UTC for datetime at universal UTC standard, or Timezone name according to the IANA Time Zone Database (e.g. America/New_York, Asia/Singapore). The IANA Timezone name is case-sensitive.
string
The separator used in the CSV response data
integer
Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set, otherwise set to maximum.
string
Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02T15:04:05. Default location: Forex and Cryptocurrencies - UTC; Stocks - where exchange is located (e.g. for AAPL it will be America/New_York). Both parameters take into account if timezone parameter is provided.
string ("close" | "open" | "high" | "low" | "volume")
Price type on which technical indicator is calculated
integer
Number of periods to average over. Takes values in the range from 1 to 800
boolean
Specify if OHLC values should be added in the output
boolean
A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_DPOTool to calculate the Detrended Price Oscillator (DPO) for a specified financial instrument. Use when you need to identify short-term price cycles and potential overbought or oversold conditions without long-term trend influence.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values (0 to 11 inclusive).
string
Specifies the exact date to get data for (e.g., ‘2021-10-27’, ‘today’, ‘yesterday’).
string
Financial Instrument Global Identifier (FIGI) for the instrument.
string
International Securities Identification Number (ISIN) filter.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
CUSIP identifier for the instrument.
string ("asc" | "desc")
Sorting order of the output.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices.
string ("JSON" | "CSV")
The format of the response data.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’).
string
The country where the instrument is traded (e.g., ‘United States’ or ‘US’).
boolean
Returns quotes including pre-market and post-market data (Pro plan and above, US equities only).
boolean
Specifies if there should be a shift to match the current price.
string
Ending date and time for data selection in YYYY-MM-DD or ISO 8601 format.
string
Exchange where the instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed (e.g., ‘Exchange’, ‘UTC’, ‘America/New_York’).
string
The separator used in the CSV response data.
integer
Number of data points to retrieve (1 to 5000). Default 30 when no date parameters are set.
string
Starting date and time for data selection in YYYY-MM-DD or ISO 8601 format.
string ("close" | "open" | "high" | "low" | "volume")
Price type on which technical indicator is calculated.
integer
Number of periods to average over (1 to 800).
boolean
Specify if OHLC values should be added in the output.
boolean
Include the previous closing price in the time_series data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_EARLIEST_TIMESTAMPTool to return the first available timestamp for a symbol and interval. Use after selecting instrument identifiers and interval to discover the earliest data point.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requestsDiscount: 79

Input Parameters

string
FIGI identifier. One of symbol/figi/isin/cusip is required.
string
ISIN identifier. One of symbol/figi/isin/cusip is required.
string
CUSIP identifier. One of symbol/figi/isin/cusip is required.
string
Ticker symbol to query (e.g., ‘AAPL’). One of symbol/figi/isin/cusip is required.
string
Exchange where the instrument is traded (optional disambiguation filter).
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "1day" | "1week" | "1month")
required
Interval for data resolution.
string
Market Identifier Code (ISO 10383) to filter results (optional).
string
Output timezone: ‘Exchange’, ‘UTC’, or any IANA timezone name (optional).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_EODRetrieve an end-of-day closing price and metadata for a financial instrument, for a specified date or the most recent available date.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Number of decimal places for floating values. Must be in range [0, 11] inclusive.
string
Specific date for EOD data in YYYY-MM-DD format. If not provided, returns most recent EOD data.
string
Financial Instrument Global Identifier (FIGI). Available starting with the Ultra plan.
string
International Securities Identification Number (ISIN). Must be activated in Data add-ons section.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
Asset class types supported by the API.
string
CUSIP identifier of the instrument. Must be activated in Data add-ons section.
string
Ticker symbol of the instrument (e.g., ‘AAPL’).
string
Country where the instrument is traded (name or alpha code, e.g., ‘United States’ or ‘US’).
boolean
Include pre/post market data. Only for Pro and above plans. Available at 1min, 5min, 15min, and 30min intervals for US equities. Open, high, low, close values supplied without volume.
string
Exchange where the instrument is traded (e.g., ‘NASDAQ’).
string
Market Identifier Code (MIC) under ISO 10383 standard (e.g., ‘XNAS’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_ETFS_WORLD_PERFORMANCERetrieve global ETF performance metrics, including trailing and annual returns. Provider errors may be returned in the response status and message.

Input Parameters

integer
Number of decimal places for floating values; range [0, 11]; defaults to 5.
string
Financial Instrument Global Identifier (FIGI). One of symbol, figi, isin, cusip, or country must be provided.
string
International Securities Identification Number (ISIN). One of symbol, figi, isin, cusip, or country must be provided.
string
CUSIP of the instrument. One of symbol, figi, isin, cusip, or country must be provided.
string
ETF ticker symbol (e.g., ‘IVV’). One of symbol, figi, isin, cusip, or country must be provided.
string
Country name or ISO code (e.g., ‘United States’ or ‘US’). One of symbol, figi, isin, cusip, or country must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_EXCHANGE_RATEReturn the current or historical exchange rate for one forex or cryptocurrency pair.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

string
Optional historical date/time as YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS; omit for the latest rate.
string
UTC, Exchange, or a case-sensitive IANA timezone used to interpret date.
string
required
Base/quote pair separated by a slash, for example EUR/USD or BTC/ETH.
integer
Number of decimal places in the returned rate (0-11).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_EXCHANGE_SCHEDULERetrieve trading sessions and hours for exchanges by date, including pre-market, main, and post-market sessions. A specific plan-restriction response is returned as an empty schedule list.

Input Parameters

string
Date for schedule. Format YYYY-MM-DD, keywords ‘today’ or ‘yesterday’, or full UTC datetime (e.g., ‘2025-04-11 20:00:00’).
string
Filter by country name or alpha code (e.g., ‘United States’ or ‘US’).
string
Filter by ISO 10383 MIC code (e.g., ‘XNGS’).
string
Filter by exchange name (e.g., ‘NASDAQ’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_FUND_HOLDERSTool to retrieve mutual fund holders for a company. Use when you need details about mutual fund ownership including shares held and percentage of outstanding shares.

Input Parameters

string
Filter by financial instrument global identifier (FIGI). Available starting with the Ultra plan. Required if other identifiers are not provided.
string
Filter by international securities identification number (ISIN). ISIN access is activated in the Data add-ons section. Required if other identifiers are not provided.
string
The CUSIP of an instrument for which data is requested. CUSIP access is activated in the Data add-ons section. Required if other identifiers are not provided.
string
Symbol ticker of instrument. For preferred stocks use dot(.) delimiter (e.g., ‘BRK.A’ or ‘BRK.B’). Required if other identifiers are not provided.
string
Country where instrument is traded (e.g., ‘United States’ or ‘US’).
string
Exchange where instrument is traded.
string
Market Identifier Code (MIC) under ISO 10383 standard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_FUNDSTool to fetch a daily updated list of available investment funds. Use when you need a directory of funds with optional filtering by symbol, country, exchange, or other identifiers.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requestsDiscount: 79

Input Parameters

string
The CIK (Central Index Key) of an instrument for which data is requested (e.g., ‘95953’).
string
Filter by financial instrument global identifier (FIGI). Available starting with the Ultra plan (e.g., ‘BBG000BHTMY7’).
string
Filter by international securities identification number (ISIN). ISIN access is activated in the Data add-ons section (e.g., ‘US0378331005’).
integer
Page number of the results to fetch. Default is 1.
string
The CUSIP of an instrument for which data is requested. CUSIP access is activated in the Data add-ons section (e.g., ‘594918104’).
string
The format of the response data. Only JSON is supported.
string
The ticker symbol of an instrument for which data is requested (e.g., ‘FXAIX’).
string
Filter by country name or alpha code, e.g., ‘United States’ or ‘US’.
string
Filter by exchange name (e.g., ‘Nasdaq’).
boolean
Adds information on which plan the symbol is available. When true, each fund includes an ‘access’ object with plan details.
integer
Determines the number of data points returned in the output. Default is 5000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_HEIKINASHI_CANDLESTool to retrieve Heikin Ashi candlestick data that smooths price action by averaging values. Use when you need to identify trends with reduced market noise for technical analysis.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Number of decimal places for floating values (0-11). Default is automatically determined.
string
Exact date to get data for. Format: ‘YYYY-MM-DD’ or human language like ‘today’ or ‘yesterday’.
string
Financial Instrument Global Identifier (FIGI). Available starting with the Ultra plan.
string
International Securities Identification Number (ISIN). Requires Data add-ons activation.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
Asset class of the instrument
string
Committee on Uniform Securities Identification Procedures (CUSIP). Requires Data add-ons activation.
string ("asc" | "desc")
Sorting order of the output
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices
string ("JSON" | "CSV")
Format of the response data
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’). Must provide either symbol, isin, figi, or cusip.
string
Country where the instrument is traded (e.g., ‘United States’ or ‘US’).
boolean
Include pre-market and post-market data. Only for Pro+ plans at 1min, 5min, 15min, 30min intervals for US equities.
string
End date for data selection in format ‘YYYY-MM-DD’ or ‘YYYY-MM-DDTHH:MM:SS’. See start_date description for details.
string
Exchange where the instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Time interval between consecutive data points.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone for output datetime display. Use ‘Exchange’ for local time, ‘UTC’ for universal time, or IANA timezone name (e.g., ‘America/New_York’). Default is ‘Exchange’.
string
Separator used in CSV response data. Default is ’;’.
integer
Number of data points to retrieve (1-5000). Default is 30 when no date parameters are set.
string
Start date for data selection in format ‘YYYY-MM-DD’ or ‘YYYY-MM-DDTHH:MM:SS’. Can be used separately or with end_date.
boolean
Include OHLC (Open, High, Low, Close) values in the output. Default is false.
boolean
Include the previous closing price in the time series data. If true, adds previous bar close price to current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_HLC3Tool to calculate the High, Low, Close Average (HLC3) for a security over a specified period. Use when you need to assess average price trends quickly.

Input Parameters

integer
Number of decimal places for floating values. Range: 0-11. Default is automatic.
string
Specific date to get data for. Can be exact date (e.g., ‘2021-10-27’), or human language (‘today’, ‘yesterday’).
string
Financial Instrument Global Identifier (FIGI) of the instrument (e.g., ‘BBG000B9Y5X2’). Available with Ultra plan and above.
string
International Securities Identification Number (ISIN) of the instrument (e.g., ‘US0378331005’). Requires Data add-ons activation.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
CUSIP identifier of the instrument (e.g., ‘594918104’). Requires Data add-ons activation.
string ("asc" | "desc")
Sorting order of the output data.
string ("all" | "splits" | "dividends" | "none")
Price adjusting mode.
string ("JSON" | "CSV")
Response data format.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’). At least one of symbol, isin, figi, or cusip must be provided.
string
Country where the instrument is traded (e.g., ‘United States’ or ‘US’).
boolean
Include pre-market and post-market data. Only for Pro+ plans at 1min, 5min, 15min, 30min intervals for US equities.
string
End date for data selection in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS. See start_date for timezone handling details.
string
Exchange where the instrument is traded (e.g., ‘NASDAQ’).
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Time interval between consecutive data points in the time series.
string
Market Identifier Code (MIC) under ISO 10383 standard (e.g., ‘XNAS’).
string
Timezone for output datetime display. Supports ‘Exchange’ (local), ‘UTC’, or IANA timezone names (e.g., ‘America/New_York’, ‘Asia/Singapore’).
string
Separator used in CSV response data.
integer
Number of data points to retrieve. Default is 30 when no date parameters are set, otherwise maximum. Range: 1-5000.
string
Start date for data selection in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS. Can be used with or without end_date.
boolean
Include OHLC (Open, High, Low, Close) values in the output.
boolean
Include previous closing price in the time series data. Adds previous bar close to current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_HT_SINEFetch Hilbert Transform Sine Wave (HT_SINE) data for an instrument and interval, including sine and lead-sine components, for analyzing market cycles and potential turning points.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive.
string
Specifies the exact date to get the data for. Could be exact date (e.g., ‘2021-10-27’), or in human language ‘today’ or ‘yesterday’.
string
Financial Instrument Global Identifier (FIGI). One of symbol, isin, figi, or cusip must be provided.
string
International securities identification number (ISIN). One of symbol, isin, figi, or cusip must be provided.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
CUSIP identifier of the instrument. One of symbol, isin, figi, or cusip must be provided.
string ("asc" | "desc")
Sorting order of the output.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices.
string ("JSON" | "CSV")
The format of the response data.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’). One of symbol, isin, figi, or cusip must be provided.
string
The country where the instrument is traded (e.g., ‘United States’ or ‘US’).
boolean
Returns quotes that include pre-market and post-market data. Only for Pro and above plans. Available at 1min, 5min, 15min, and 30min intervals for US equities.
string
End date for data selection in format ‘2006-01-02’ or ‘2006-01-02T15:04:05’. See start_date description for details.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed. Supports: ‘Exchange’ for local exchange time, ‘UTC’ for UTC standard, or IANA timezone names (e.g., ‘America/New_York’, ‘Asia/Singapore’).
string
The separator used in the CSV response data.
integer
Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set.
string
Start date for data selection in format ‘2006-01-02’ or ‘2006-01-02T15:04:05’. Can be used separately or with end_date.
string ("close" | "open" | "high" | "low" | "volume")
Price type on which technical indicator is calculated.
boolean
Specify if OHLC values should be added in the output.
boolean
A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_ICHIMOKUTool to retrieve Ichimoku Kinko Hyo indicator data for analyzing trend direction, support/resistance levels, and trading opportunities. Use when you need to evaluate market trends and identify strategic entry/exit points.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Number of decimal places for floating values. Range [0, 11]. By default, automatically determined.
string
Specifies exact date to get data for. Can be exact date (e.g., ‘2021-10-27’) or human language (‘today’, ‘yesterday’).
string
The FIGI (Financial Instrument Global Identifier) of an instrument. Available starting with the Ultra plan.
string
International Securities Identification Number (ISIN) to filter by. ISIN access requires the Data add-ons section.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs (e.g., ‘Common Stock’, ‘ETF’).
string
The CUSIP of an instrument for which data is requested. CUSIP access requires the Data add-ons section.
string ("asc" | "desc")
Sorting order of the output. Options: ‘asc’ (ascending) or ‘desc’ (descending). Default is ‘desc’.
string ("all" | "splits" | "dividends" | "none")
Price adjustment mode. Options: ‘all’, ‘splits’, ‘dividends’, ‘none’. Default is ‘splits’.
string ("JSON" | "CSV")
Format of the response data. Options: ‘JSON’ or ‘CSV’. Default is ‘JSON’.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’). Use symbol, isin, figi, or cusip to identify the instrument.
string
The country where the instrument is traded (e.g., ‘United States’ or ‘US’).
boolean
Include pre-market and post-market data. Only for Pro and above plans. Available at 1min, 5min, 15min, and 30min intervals for US equities.
string
Ending date for data selection. Format same as start_date. See start_date for timezone handling details.
string
Exchange where the instrument is traded (e.g., ‘NASDAQ’).
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series (e.g., ‘1min’, ‘1day’, ‘1week’).
string
Market Identifier Code (MIC) under ISO 10383 standard (e.g., ‘XNAS’).
string
Timezone for output datetime. Supports ‘Exchange’ (local time), ‘UTC’, or IANA timezone names (e.g., ‘America/New_York’).
string
The separator used in CSV response data. Default is ’;’.
integer
Number of data points to retrieve. Supports values from 1 to 5000. Default is 30 when no date parameters are set.
string
Starting date for data selection in format ‘2006-01-02’ or ‘2006-01-02T15:04:05’. Can be used with or without end_date.
boolean
Specify if OHLC (Open, High, Low, Close) values should be included in the output. Default is false.
boolean
Include previous closing price in time_series data. If true, adds previous bar close price to current object.
integer
Time period for generating the base line (Kijun-sen). Range [1, 800]. Default is 26.
integer
Time period for generating the lagging span line (Chikou Span). Range [1, 800]. Default is 26.
integer
Time period for generating the leading span B line (Senkou Span B). Range [1, 800]. Default is 52.
integer
Time period for generating the conversion line (Tenkan-sen). Range [1, 800]. Default is 9.
boolean
Indicates whether to include ahead span period in the calculation. Default is true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_INCOME_STATEMENTTool to retrieve a company’s income statement data (annual or quarterly). Use when you need detailed income metrics for a given symbol or identifier.

Input Parameters

string
Filter by FIGI (e.g., ‘BBG01293F5X4’). Required if other identifiers are not provided.
string
Filter by ISIN (e.g., ‘US0378331005’). Required if other identifiers are not provided.
string
Filter by CUSIP (e.g., ‘594918104’). Required if other identifiers are not provided.
string ("annual" | "quarterly")
Reporting period; ‘annual’ or ‘quarterly’. Default is ‘annual’.
string
Ticker of the instrument (e.g., ‘AAPL’). Required if other identifiers are not provided.
string
Country name or two-letter code (e.g., ‘United States’ or ‘US’).
string
Inclusive filter: fiscal_date on or before this date (YYYY-MM-DD).
string
Exchange where the instrument is traded (e.g., ‘NASDAQ’).
string
Market Identifier Code (ISO 10383) (e.g., ‘XNAS’).
integer
Maximum number of periods to return. Default is 6.
string
Inclusive filter: fiscal_date on or after this date (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_INSIDER_TRANSACTIONSREQUIRES PRO, ULTRA, OR ENTERPRISE PLAN. Retrieve insider trading transactions for a company including officer/trader names, transaction types (Buy/Sell), dates, share counts, and amounts. Use when you need detailed insider trading activity data. This endpoint is only available to Pro/Ultra/Enterprise subscribers - requests with lower-tier API keys will fail with a 403 error.

Input Parameters

string
Type of the instrument (e.g., ‘Common Stock’).
string
required
Ticker symbol of the company (e.g., ‘AAPL’).
string
Country name or two-letter ISO code where the instrument trades (e.g., ‘US’, ‘United States’).
string
Exchange where the instrument is traded (e.g., ‘NASDAQ’).
integer
Maximum number of insider transaction records to return (1-500). If not specified, all available records are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_INTERVALSTool to retrieve a list of available time intervals supported by the API. Use when you need to know which interval values are valid for time series queries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_KELTNERRetrieve Keltner Channel indicator data for volatility-based technical analysis. The channel uses a moving average and Average True Range and can help assess trends, volatility, and potential overbought or oversold conditions.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Range [0, 11].
string
Specifies exact date to get data for. E.g. ‘2021-10-27’, ‘today’, or ‘yesterday’.
string
The FIGI of an instrument for which data is requested.
string
Filter by international securities identification number (ISIN).
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
The CUSIP of an instrument for which data is requested.
string ("asc" | "desc")
Sorting order of the output.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices.
string
The format of the response data.
string
Symbol ticker of the instrument. E.g. ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’.
string
The country where the instrument is traded, e.g., ‘United States’ or ‘US’.
string ("SMA" | "EMA" | "WMA" | "DEMA" | "TEMA" | "TRIMA" | "KAMA" | "MAMA" | "T3MA")
The type of moving average used.
boolean
Returns quotes including pre-market and post-market data. Only for Pro+ plans.
string
Ending date for data selection. Format: ‘2006-01-02’ or ‘2006-01-02T15:04:05’.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "8h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed. Supports ‘Exchange’, ‘UTC’, or IANA timezone name.
string
The separator used in the CSV response data.
integer
The factor used to adjust the indicator’s sensitivity.
integer
Number of data points to retrieve. Default 30 when no date parameters are set.
string
Starting date for data selection. Format: ‘2006-01-02’ or ‘2006-01-02T15:04:05’.
string ("close" | "open" | "high" | "low" | "volume")
Price type on which technical indicator is calculated.
integer
Number of periods to average over. Takes values in the range from 1 to 800.
boolean
Specify if OHLC values should be added in the output.
boolean
Include the previous closing price in the time_series data.
integer
The time period used for calculating the Average True Range. Range from 1 to 800.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_KEY_EXECUTIVESREQUIRES ULTRA OR ENTERPRISE PLAN. Retrieve company leadership data including executive names, titles, ages, and compensation. Use when you need detailed management info by symbol or other identifier. Costs 1,000 credits per request (Ultra or Enterprise plan only). This endpoint is only available to Ultra/Enterprise subscribers - requests with lower-tier API keys will fail.

Input Parameters

string
Financial Instrument Global Identifier (FIGI).
string
International Securities Identification Number (ISIN).
string
CUSIP code of the instrument.
string
Ticker symbol of the instrument (e.g., ‘AAPL’).
string
Country name or ISO code where the instrument trades (e.g., ‘US’).
string
Exchange where the instrument is traded (e.g., ‘NASDAQ’).
string
Market Identifier Code (MIC) under ISO 10383 (e.g., ‘XNAS’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_LAST_CHANGETool to retrieve the latest update timestamps for a fundamentals dataset. Use when checking recent changes (e.g., dividends, splits).Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requestsDiscount: 79

Input Parameters

integer
Page number for pagination (default 1).
string
Filter by symbol (e.g., ‘AAPL’).
string
Filter by country name or code (e.g., ‘United States’ or ‘US’).
string ("price_target" | "recommendations" | "statistics" | "insider_transactions" | "profile" | "institutional_holders" | "analyst_rating" | "income_statement" | "income_statement_quarterly" | "cash_flow" | "cash_flow_quarterly" | "balance_sheet" | "balance_sheet_quarterly" | "dividends" | "splits" | "mutual_funds_list" | "mutual_funds_world" | "mutual_funds_world_summary" | "mutual_funds_world_sustainability" | "mutual_funds_world_risk" | "mutual_funds_world_purchase_info" | "mutual_funds_world_composition" | "mutual_funds_world_performance" | "etfs_list" | "etfs_world" | "etfs_world_summary" | "etfs_world_performance" | "etfs_world_risk" | "etfs_world_composition")
required
The fundamentals dataset to check for last changes.
string
Filter by exchange (e.g., ‘NASDAQ’).
string
Filter by MIC code (ISO 10383), e.g., ‘XNAS’.
integer
Number of records per page (default 30).
string
Start date/time filter (inclusive) in ‘YYYY-MM-DD HH:MM:SS’ format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_LATEST_PRICEReturn only the latest available price for one market symbol; use Get Quote when OHLC, volume, change, or market status is needed.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

string
required
Ticker or provider symbol for one instrument.
string
Exchange name used to disambiguate the symbol.
string
ISO 10383 market identifier code used to disambiguate the symbol.
integer
Number of decimal places in the returned price (0-11).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_LINEARREGANGLETool to calculate the linear regression angle for a given time series of stock prices. Returns the slope of the trend line expressed in degrees, which helps identify the direction and steepness of a trend over a specified period. Use when you need to detect upward or downward trends in asset prices.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, determined automatically.
string
Specifies the exact date to get the data for. Could be exact date (e.g., ‘2021-10-27’), or in human language ‘today’ or ‘yesterday’.
string
Financial Instrument Global Identifier (FIGI) of the instrument.
string
International Securities Identification Number (ISIN) of the instrument.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
CUSIP identifier of the instrument.
string ("asc" | "desc")
Sorting order of the output. Default is ‘desc’.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices. Default is ‘splits’.
string
The format of the response data. Default is ‘JSON’.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’).
string
The country where the instrument is traded (e.g., ‘United States’ or ‘US’).
boolean
Returns quotes that include pre-market and post-market data. Only for Pro and above plans. Available at 1min, 5min, 15min, and 30min intervals for US equities.
string
End date for data selection in format 2006-01-02 or 2006-01-02T15:04:05. See start_date for details.
string
Exchange where the instrument is traded (e.g., ‘NASDAQ’).
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Time interval between consecutive data points in the time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed. Supports: ‘Exchange’ for local exchange time, ‘UTC’ for universal UTC standard, or IANA timezone name (e.g., ‘America/New_York’, ‘Asia/Singapore’).
string
The separator used in the CSV response data. Default is ’;’.
integer
Number of data points to retrieve. Supports values from 1 to 5000. Default is 30 when no date parameters are set.
string
Start date for data selection in format 2006-01-02 or 2006-01-02T15:04:05. Can be used separately or together with end_date.
string ("close" | "open" | "high" | "low" | "volume")
Price type on which technical indicator is calculated. Default is ‘close’.
integer
Number of periods to average over. Takes values in the range from 1 to 800. Default is 9.
boolean
Specify if OHLC values should be added in the output. Default is false.
boolean
If true, adds previous bar close price value to the current object. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_LINEAR_REG_INTERCEPTRetrieve linear regression intercept indicator values for a financial instrument over a specified period. The indicator represents where the regression line crosses the y-axis.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive.
string
Specifies the exact date to get the data for (e.g., ‘2021-10-27’, ‘today’, ‘yesterday’).
string
The FIGI of an instrument for which data is requested.
string
International securities identification number (ISIN).
string
The asset class to which the instrument belongs.
string
The CUSIP of an instrument for which data is requested.
string ("asc" | "desc")
Sorting order of the output.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices.
string
The format of the response data. Only JSON is supported.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’).
string
The country where the instrument is traded (e.g., ‘United States’ or ‘US’).
boolean
Returns quotes that include pre-market and post-market data. Only for Pro and above plans.
string
Ending date for data selection in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.
string
Exchange where instrument is traded (e.g., ‘NASDAQ’).
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed (e.g., ‘Exchange’, ‘UTC’, ‘America/New_York’).
integer
Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set.
string
Starting date for data selection in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.
string ("close" | "open" | "high" | "low" | "volume")
Price type on which technical indicator is calculated.
integer
Number of periods to average over. Takes values in the range from 1 to 800.
boolean
Specify if OHLC values should be added in the output.
boolean
A boolean parameter to include the previous closing price in the time_series data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_LINEAR_REGSLOPERetrieve linear regression slope indicator values for a financial instrument over a specified period. The slope reflects the rate of change in the data trend and can help assess trend direction and strength.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, determined automatically.
string
Specifies the exact date to get data for. Could be exact date (e.g., ‘2021-10-27’), or human language (‘today’ or ‘yesterday’).
string
FIGI of an instrument for which data is requested. At least one identifier is required.
string
International securities identification number (ISIN). At least one identifier is required.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
Asset class types.
string
CUSIP of an instrument for which data is requested. At least one identifier is required.
string ("asc" | "desc")
Sorting order options.
string ("all" | "splits" | "dividends" | "none")
Price adjustment options.
string ("JSON" | "CSV")
Response format options.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’). At least one identifier (symbol, isin, figi, or cusip) is required.
string
The country where the instrument is traded (e.g., ‘United States’ or ‘US’).
boolean
Returns quotes that include pre-market and post-market data. Only for Pro and above plans. Available at 1min, 5min, 15min, and 30min intervals for US equities.
string
Ending date for data selection. Format: ‘2006-01-02’ or ‘2006-01-02T15:04:05’. See start_date for usage details.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series. Required parameter.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed. Supports: ‘Exchange’ for local exchange time, ‘UTC’ for universal UTC standard, or IANA timezone name (e.g., ‘America/New_York’, ‘Asia/Singapore’). Default is ‘Exchange’.
string
The separator used in the CSV response data. Default is ’;’.
integer
Number of data points to retrieve. Supports values in the range from 1 to 5000. Default is 30 when no date parameters are set.
string
Starting date for data selection. Format: ‘2006-01-02’ or ‘2006-01-02T15:04:05’. Can be used separately or together with end_date.
string ("close" | "open" | "high" | "low" | "volume")
Price type for calculation.
integer
Number of periods to average over. Takes values in the range from 1 to 800. Default is 9.
boolean
Specify if OHLC values should be added in the output. Default is false.
boolean
Include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_LOG10Retrieve base-10 logarithm (LOG10) indicator values for a financial instrument’s selected price or volume series. Use to analyze the series on a logarithmic scale.

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default (-1), the number of decimal places is automatically determined.
string
Specifies the exact date to get the data for. Could be exact date like ‘2021-10-27’ or in human language like ‘today’ or ‘yesterday’.
string
The FIGI of an instrument for which data is requested.
string
Filter by international securities identification number (ISIN).
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
The CUSIP of an instrument for which data is requested.
string ("asc" | "desc")
Sorting order of the output.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices.
string ("JSON" | "CSV")
The format of the response data.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’).
string
The country where the instrument is traded (e.g., ‘United States’ or ‘US’).
boolean
Returns quotes that include pre-market and post-market data. Only for Pro and above plans. Available at 1min, 5min, 15min, and 30min intervals for US equities.
string
Ending date for data selection in format ‘2006-01-02’ or ‘2006-01-02T15:04:05’.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Time interval between two consecutive points in time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed. Supports ‘Exchange’ for local exchange time, ‘UTC’, or IANA timezone names (e.g., ‘America/New_York’, ‘Asia/Singapore’).
string
The separator used in the CSV response data.
integer
Number of data points to retrieve. Supports values from 1 to 5000. Default is 30 when no date parameters are set.
string
Starting date for data selection in format ‘2006-01-02’ or ‘2006-01-02T15:04:05’. Can be used separately or together with end_date.
string ("close" | "open" | "high" | "low" | "volume")
Price type on which technical indicator is calculated.
boolean
Specify if OHLC values should be added in the output.
boolean
A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_LOGOTool to retrieve official logo URLs for a symbol. Use when displaying company, crypto, or forex pair logos in UIs.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

string
required
Ticker or pair identifier (e.g., ‘AAPL’, ‘BTC/USD’, ‘EUR/USD’).
string
Country name or ISO alpha code (e.g., ‘United States’ or ‘US’).
string
Exchange name to narrow lookup (e.g., ‘NASDAQ’, ‘NSE’).
string
Market Identifier Code (ISO 10383) (e.g., ‘XNAS’, ‘XLON’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_MACDTool to calculate the Moving Average Convergence Divergence (MACD) for a specified financial instrument. Returns the MACD line, signal line, and histogram values to identify potential trend reversals and trading opportunities.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive.
string
Specifies the exact date to get the data for. Could be the exact date (e.g., ‘2021-10-27’), or in human language ‘today’ or ‘yesterday’.
string
The FIGI of an instrument for which data is requested.
string
Filter by international securities identification number (ISIN).
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
The CUSIP of an instrument for which data is requested.
string ("asc" | "desc")
Sorting order of the output.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices.
string ("JSON" | "CSV")
The format of the response data.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’). At least one of symbol, isin, figi, or cusip must be provided.
string
The country where the instrument is traded (e.g., ‘United States’ or ‘US’).
boolean
Returns quotes that include pre-market and post-market data. Only for Pro and above plans. Available at 1min, 5min, 15min, and 30min intervals for US equities.
string
End date for data selection. Format: ‘2006-01-02’ or ‘2006-01-02T15:04:05’. See start_date for more details.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed. Supports ‘Exchange’ for local exchange time, ‘UTC’ for universal UTC standard, or IANA timezone name (e.g., ‘America/New_York’, ‘Asia/Singapore’).
string
The separator used in the CSV response data.
integer
Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set.
string
Start date for data selection. Format: ‘2006-01-02’ or ‘2006-01-02T15:04:05’. Can be used separately or together with end_date.
integer
Number of periods for fast moving average. Takes values in the range from 1 to 800.
string ("close" | "open" | "high" | "low" | "volume")
Price type on which technical indicator is calculated.
integer
Number of periods for slow moving average. Takes values in the range from 1 to 800.
boolean
Specify if OHLC values should be added in the output.
integer
The time period used for generating the signal line.
boolean
A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_MAMATool to fetch MESA Adaptive Moving Average (MAMA) indicator data. Use when you need to calculate an adaptive moving average that adjusts to market cycles for trend identification and reversal analysis.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Number of decimal places for floating values. Range 0-11. Default is automatic.
string
Specific date to get data for. Can be exact date (e.g., ‘2021-10-27’), ‘today’, or ‘yesterday’.
string
Financial Instrument Global Identifier (FIGI) of the instrument.
string
International Securities Identification Number (ISIN) of the instrument.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
CUSIP identifier of the instrument.
string ("asc" | "desc")
Sorting order of the output data. Default is ‘desc’.
string ("all" | "splits" | "dividends" | "none")
Price adjusting mode. Default is ‘splits’.
string ("JSON" | "CSV")
Response format. Default is JSON.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’).
string
Country where the instrument is traded (e.g., ‘United States’ or ‘US’).
boolean
Include pre-market and post-market data. Only for Pro plans and above at specific intervals for US equities.
string
Ending date for data selection in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.
string
Exchange where the instrument is traded (e.g., ‘NASDAQ’).
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Time interval between consecutive data points.
string
Market Identifier Code (MIC) under ISO 10383 standard (e.g., ‘XNAS’).
string
Timezone for output datetime display. Supports ‘Exchange’ for local time, ‘UTC’, or IANA timezone names (e.g., ‘America/New_York’).
string
Separator used in CSV response data. Default is semicolon (;).
number
The limit for the fast moving average. Default is 0.5.
integer
Number of data points to retrieve. Supports values from 1 to 5000. Default is 30.
number
The limit for the slow moving average. Default is 0.05.
string
Starting date for data selection in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.
string ("close" | "open" | "high" | "low" | "volume")
Price type on which the technical indicator is calculated. Default is ‘close’.
boolean
Specify if OHLC (Open, High, Low, Close) values should be included in the output. Default is false.
boolean
Include previous closing price in time_series data. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_MARKET_MOVERSRetrieve a snapshot of top gainers or losers for a specified market. Provider responses with an error status are returned with an empty values list and an error message.

Input Parameters

integer
Decimal places for floating values (0–11). Defaults to 5.
string ("stocks" | "etf" | "mutual_funds" | "forex" | "crypto")
required
Market type for movers. One of: stocks, etf, mutual_funds, forex, crypto.
string
Country filter for non-currency markets; accepts full name or two-letter code.
string ("gainers" | "losers")
Snapshot direction: ‘gainers’ or ‘losers’.
integer
Number of instruments to return (1–50). Defaults to 30.
number
Return instruments with last price strictly greater than this value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_MARKET_STATETool to report current open/closed status for exchanges. Use when you need real-time market status updates after selecting exchanges.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requestsDiscount: 79

Input Parameters

string
Exchange MIC code (e.g., ‘XNYS’).
string
Country name or alpha code (e.g., ‘US’ or ‘United States’).
string
Exchange name (e.g., ‘NYSE’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_MAXRetrieve the maximum-value technical indicator for a financial instrument’s selected price or volume series over a given period. Use it to identify potential resistance levels or extreme price movements.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default (-1), automatically determined based on values.
string
Specifies the exact date to get the data for. Could be exact date (e.g., ‘2021-10-27’), or human language like ‘today’ or ‘yesterday’.
string
The FIGI of an instrument for which data is requested. Available starting with Ultra plan.
string
International securities identification number (ISIN). Requires ISIN add-on activation.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
The CUSIP of an instrument for which data is requested. Requires CUSIP add-on activation.
string ("asc" | "desc")
Sorting order of the output.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices.
string ("JSON" | "CSV")
The format of the response data.
string
Symbol ticker of the instrument. E.g. ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’. At least one of symbol, isin, figi, or cusip must be provided.
string
The country where the instrument is traded, e.g., ‘United States’ or ‘US’.
boolean
Returns quotes that include pre-market and post-market data. Only for Pro and above plans. Available at 1min, 5min, 15min, 30min intervals for US equities.
string
End date for data selection in format ‘2006-01-02’ or ‘2006-01-02T15:04:05’. See start_date description for timezone handling details.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed. Supports: ‘Exchange’ for local exchange time, ‘UTC’ for UTC standard, or IANA timezone name (e.g., ‘America/New_York’, ‘Asia/Singapore’). Case-sensitive.
string
The separator used in the CSV response data.
integer
Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set.
string
Start date for data selection in format ‘2006-01-02’ or ‘2006-01-02T15:04:05’. Can be used separately or together with end_date.
string ("close" | "open" | "high" | "low" | "volume")
Price type on which technical indicator is calculated.
integer
Number of periods to average over. Takes values in the range from 1 to 800.
boolean
Specify if OHLC values should be added in the output.
boolean
A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_MC_GINLEY_DYNAMICTool to calculate the McGinley Dynamic indicator, which provides a refined moving average that adapts to market volatility. Use when tracking price movements with reduced lag and identifying support or resistance levels.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default (-1), the number of decimal places is automatically determined.
string
Specifies the exact date to get the data for. Could be the exact date, e.g. ‘2021-10-27’, or in human language ‘today’ or ‘yesterday’.
string
Financial Instrument Global Identifier (FIGI). Available starting with Ultra plan.
string
International securities identification number (ISIN). Requires Data add-ons subscription.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
CUSIP identifier for the instrument. Requires Data add-ons subscription.
string ("asc" | "desc")
Sorting order of the output.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices.
string ("JSON" | "CSV")
The format of the response data.
string
Symbol ticker of the instrument. E.g. ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’. At least one of symbol, isin, figi, or cusip must be provided.
string
The country where the instrument is traded, e.g., ‘United States’ or ‘US’.
boolean
Returns quotes that include pre-market and post-market data. Only for Pro and above plans. Available at 1min, 5min, 15min, and 30min intervals for US equities.
string
End date for data selection. Format: ‘2006-01-02’ or ‘2006-01-02T15:04:05’. See start_date description for details.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed. Supports ‘Exchange’ for local exchange time, ‘UTC’ for universal UTC standard, or IANA timezone name (e.g., ‘America/New_York’, ‘Asia/Singapore’).
string
The separator used in the CSV response data.
integer
Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set, otherwise set to maximum.
string
Start date for data selection. Format: ‘2006-01-02’ or ‘2006-01-02T15:04:05’. Can be used separately and together with end_date. Takes into account timezone parameter if provided.
integer
Number of periods to average over. Takes values in the range from 1 to 800.
boolean
Specify if OHLC values should be added in the output.
boolean
A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_MEDPRICETool to calculate and retrieve the Median Price (MEDPRICE) technical indicator for a security. MEDPRICE represents the average of high and low prices over a specified period, providing a simplified view of price trends. Use when you need to assess price movements by focusing on the midpoint of price action.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Number of decimal places for floating values. Range [0, 11]. Default is automatically determined.
string
Specifies exact date for data retrieval. Can be exact date like ‘2021-10-27’, or human language like ‘today’ or ‘yesterday’.
string
Financial Instrument Global Identifier (FIGI) of the instrument. Available with Ultra plan or higher.
string
International Securities Identification Number (ISIN) of the instrument. ISIN access requires activation in Data add-ons.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
Asset class types supported by Twelve Data API.
string
CUSIP identifier of the instrument. CUSIP access requires activation in Data add-ons.
string ("asc" | "desc")
Sorting order for output data.
string ("all" | "splits" | "dividends" | "none")
Price adjustment modes.
string ("JSON" | "CSV")
Response format options.
string
Symbol ticker of the instrument. At least one of symbol, isin, figi, or cusip must be provided. E.g. ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’.
string
Country where the instrument is traded, e.g., ‘United States’ or ‘US’.
boolean
Include pre-market and post-market data. Only for Pro and above plans. Available at 1min, 5min, 15min, and 30min intervals for US equities.
string
End date for data selection. Format and behavior same as start_date.
string
Exchange where the instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Time interval between consecutive data points. Required parameter.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone for output datetime. Supports ‘Exchange’ for local exchange time, ‘UTC’ for UTC standard, or IANA timezone names like ‘America/New_York’. Default is ‘Exchange’.
string
Separator used in CSV response data. Default is ’;’.
integer
Number of data points to retrieve. Supports values from 1 to 5000. Default is 30 when no date parameters are set.
string
Start date for data selection in format ‘2006-01-02’ or ‘2006-01-02T15:04:05’. Can be used separately or with end_date. Timezone-aware based on the timezone parameter.
boolean
Specify if OHLC (Open, High, Low, Close) values should be added in the output.
boolean
Include previous closing price in the time series data. If true, adds previous bar close price to current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_MINUS_DITool to calculate and return the Minus Directional Indicator (MINUS_DI) for a security. Use when analyzing bearish trends and assessing downward price movement strength.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive.
string
Specifies the exact date to get data for. Could be exact date (e.g., ‘2021-10-27’), ‘today’, or ‘yesterday’.
string
Financial Instrument Global Identifier (FIGI) of the instrument.
string
International Securities Identification Number (ISIN) of the instrument.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
CUSIP identifier of the instrument.
string ("asc" | "desc")
Sorting order of the output.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices.
string ("JSON" | "CSV")
The format of the response data.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’).
string
Country where the instrument is traded (e.g., ‘United States’ or ‘US’).
boolean
Include pre-market and post-market data. Only for Pro and above plans. Available at 1min, 5min, 15min, and 30min intervals for US equities.
string
Ending date and time for data selection. Format: ‘2006-01-02’ or ‘2006-01-02T15:04:05’.
string
Exchange where the instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone for output datetime display. Supports ‘Exchange’, ‘UTC’, or IANA timezone names (e.g., ‘America/New_York’).
string
The separator used in the CSV response data.
integer
Number of data points to retrieve. Supports values from 1 to 5000. Default is 30 when no date parameters are set.
string
Starting date and time for data selection. Format: ‘2006-01-02’ or ‘2006-01-02T15:04:05’.
integer
Number of periods to average over. Takes values in the range from 1 to 800.
boolean
Specify if OHLC (Open, High, Low, Close) values should be added in the output.
boolean
Include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_MUTUAL_FUNDS_WORLD_PERFORMANCEGet global mutual fund performance metrics, including trailing, annual, quarterly, and load-adjusted returns. API-level errors may be returned in the response with an error status.

Input Parameters

integer
Number of decimal places for floating values; range [0, 11]; defaults to 5.
string
Financial Instrument Global Identifier (FIGI). One of symbol, figi, isin, cusip, or country must be provided.
string
International Securities Identification Number (ISIN). One of symbol, figi, isin, cusip, or country must be provided.
string
CUSIP identifier. One of symbol, figi, isin, cusip, or country must be provided.
string
Mutual fund ticker symbol (e.g., ‘VFIAX’). One of symbol, figi, isin, cusip, or country must be provided.
string
Country name or alpha code (e.g., ‘United States’ or ‘US’). One of symbol, figi, isin, cusip, or country must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_MUTUAL_FUNDS_WORLD_RISKFetch global mutual fund risk metrics, including standard deviation, beta, and Sharpe ratio. API-level errors may be returned in the response with an error status.

Input Parameters

integer
Decimal places for floating values. Must be between 0 and 11. Default is 5.
string
Financial Instrument Global Identifier (FIGI). Required if other identifiers are not provided.
string
International Securities Identification Number (ISIN). Required if other identifiers are not provided.
string
CUSIP identifier. Required if other identifiers are not provided.
string
Mutual fund symbol. Required if other identifiers are not provided.
string
Country name or alpha code (e.g., ‘United States’ or ‘US’). Required if other identifiers are not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_MUTUAL_FUNDS_WORLD_SUMMARYRetrieve a global mutual fund summary snapshot with key identifiers and attributes. API-level errors may be returned in the response with an error status.

Input Parameters

integer
Number of decimal places for floating values; range [0,11]; defaults to 5.
string
Financial Instrument Global Identifier (FIGI). One of symbol, figi, isin, cusip, or country must be provided.
string
International Securities Identification Number (ISIN). One of symbol, figi, isin, cusip, or country must be provided.
string
CUSIP identifier. One of symbol, figi, isin, cusip, or country must be provided.
string
Mutual fund ticker symbol (e.g., ‘VFIAX’). One of symbol, figi, isin, cusip, or country must be provided.
string
Country name or alpha code (e.g., ‘United States’ or ‘US’). One of symbol, figi, isin, cusip, or country must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_MUTUAL_FUNDS_WORLD_SUSTAINABILITYGet global mutual fund sustainability and ESG metrics, including scores and pillar breakdowns. API-level errors may be returned in the response with an error status.

Input Parameters

integer
Number of decimal places for floating values; range [0, 11]; defaults to 5.
string
Financial Instrument Global Identifier (FIGI). One of symbol, figi, isin, cusip, or country must be provided.
string
International Securities Identification Number (ISIN). One of symbol, figi, isin, cusip, or country must be provided.
string
CUSIP identifier. One of symbol, figi, isin, cusip, or country must be provided.
string
Mutual fund ticker symbol (e.g., ‘VFIAX’). One of symbol, figi, isin, cusip, or country must be provided.
string
Country name or alpha code (e.g., ‘United States’ or ‘US’). One of symbol, figi, isin, cusip, or country must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_PLUS_DITool to fetch the Plus Directional Indicator (PLUS_DI) time series data for a security. Use when you need to assess the strength and intensity of upward price movements over a specified period.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.
string
Specifies the exact date to get the data for. Could be the exact date (e.g., ‘2021-10-27’), or in human language (‘today’ or ‘yesterday’).
string
Financial Instrument Global Identifier (FIGI). Available starting with the Ultra plan.
string
International Securities Identification Number (ISIN). ISIN access is activated in the Data add-ons section.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
CUSIP identifier. CUSIP access is activated in the Data add-ons section.
string ("asc" | "desc")
Sorting order of the output. Default is ‘desc’.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices. Default is ‘splits’.
string ("JSON" | "CSV")
The format of the response data. Default is ‘JSON’.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’). At least one of symbol, isin, figi, or cusip must be provided.
string
The country where the instrument is traded (e.g., ‘United States’ or ‘US’).
boolean
Returns quotes that include pre-market and post-market data. Only for Pro and above plans. Available at 1min, 5min, 15min, and 30min intervals for US equities. Open, high, low, close values are supplied without volume.
string
End date for data selection. Format: ‘2006-01-02’ or ‘2006-01-02T15:04:05’. See start_date description for details.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed. Supports: ‘Exchange’ for local exchange time, ‘UTC’ for universal time, or IANA timezone names (e.g., ‘America/New_York’). Default is ‘Exchange’. Note that IANA timezone names are case-sensitive.
string
The separator used in the CSV response data. Default is ’;’.
integer
Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set, otherwise set to maximum.
string
Start date for data selection. Format: ‘2006-01-02’ or ‘2006-01-02T15:04:05’. Can be used separately or together with end_date. Takes timezone parameter into account.
integer
Number of periods to average over. Takes values in the range from 1 to 800. Default is 9.
boolean
Specify if OHLC values should be added in the output. Default is false.
boolean
A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_PRICETool to retrieve the latest market price for a specified financial instrument. Use when you need to get the current price after identifying a symbol.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0,11] inclusive. Default is 5.
string
Filter by financial instrument global identifier (FIGI). Available starting with the Ultra plan.
string
Filter by international securities identification number (ISIN). ISIN access is activated in the Data add-ons section.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
Asset class types supported by Twelve Data API.
string
The CUSIP of an instrument for which data is requested. CUSIP access is activated in the Data add-ons section.
string ("JSON" | "CSV")
Response format options.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘MSFT’). At least one of symbol, figi, isin, or cusip must be provided.
string
Country where instrument is traded, e.g., ‘United States’ or ‘US’.
boolean
Include pre-market and post-market data. Only for Pro and above plans. Available at 1min, 5min, 15min, and 30min intervals for US equities.
string
Exchange where instrument is traded (e.g., ‘NASDAQ’, ‘NYSE’).
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Specify the delimiter used when downloading the CSV file (default is ’;’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_PRICE_TARGETTool to fetch analysts’ price target dataset for equities. Use when you need the latest and historical price forecasts for a symbol.

Input Parameters

string
required
Equity ticker symbol to fetch price target data for (e.g., ‘AAPL’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_PROFILETool to retrieve company profile. Use when you need company details like industry, sector, and identifiers after selecting a symbol.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 API creditsDiscount: 79

Input Parameters

string
Financial Instrument Global Identifier. Provide one of symbol, figi, isin, or cusip.
string
International Securities Identification Number. Provide one of symbol, figi, isin, or cusip.
string
CUSIP identifier. Provide one of symbol, figi, isin, or cusip.
string
Ticker symbol to query (e.g., ‘AAPL’). Provide one of symbol, figi, isin, or cusip.
string
Country where the instrument is traded (name or alpha code, e.g., ‘United States’ or ‘US’).
string
Exchange where the instrument is traded (e.g., ‘NASDAQ’).
string
Market Identifier Code (ISO 10383) for the exchange (e.g., ‘XNAS’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_QUOTEReturn the latest quote for one symbol, including OHLC, volume when available, change, market-open status, and 52-week range.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

string
required
Ticker or provider symbol for one instrument, for example AAPL, EUR/USD, or ETH/BTC.
string
Exchange name used to disambiguate the symbol, for example NASDAQ.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "8h" | "1day" | "1week" | "1month")
Optional bar interval for the quote. Omit for the provider default.
string
ISO 10383 market identifier code used to disambiguate the symbol, for example XNAS.
string
Exchange, UTC, or a case-sensitive IANA timezone; daily and longer intervals remain in exchange-local time.
boolean
When true, return the closed day’s quote rather than the current quote.
integer
Number of decimal places in returned market values (0-11).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_RECOMMENDATIONSRetrieve aggregated analyst recommendations for a stock. Returns buy/sell/hold consensus ratings across multiple time periods (current month, previous month, 2 and 3 months ago). Use this to understand Wall Street sentiment and analyst opinions about a company.

Input Parameters

string
required
Ticker symbol of the stock (e.g., ‘AAPL’, ‘MSFT’, ‘GOOGL’). Must be a valid stock symbol traded on a supported exchange.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_ROCTool to retrieve Rate of Change (ROC) indicator data for a security. ROC calculates the percentage change in price over a defined period, returning a time series of values that help track momentum. Use after selecting a symbol and interval to identify potential price movements.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Range [0, 11]. By default, automatically determined.
string
Specifies the exact date to get the data for. Could be exact date (e.g., ‘2021-10-27’), ‘today’, or ‘yesterday’.
string
Financial Instrument Global Identifier (FIGI). Available starting with the Ultra plan.
string
International Securities Identification Number (ISIN). Requires Data add-ons activation.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
CUSIP identifier. Requires Data add-ons activation.
string ("asc" | "desc")
Sorting order of the output.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices.
string ("JSON" | "CSV")
The format of the response data.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’). At least one of symbol, isin, figi, or cusip must be provided.
string
The country where the instrument is traded (e.g., ‘United States’ or ‘US’).
boolean
Returns quotes that include pre-market and post-market data. Only for Pro and above plans. Available at 1min, 5min, 15min, and 30min intervals for US equities.
string
Ending date for data selection. Format: ‘2006-01-02’ or ‘2006-01-02T15:04:05’. See start_date for details.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed. Supports ‘Exchange’ for local exchange time, ‘UTC’ for UTC standard, or IANA timezone name (e.g., ‘America/New_York’).
string
The separator used in the CSV response data.
integer
Number of data points to retrieve. Default 30 when no date parameters are set, otherwise set to maximum. Leave unset to use API defaults.
string
Starting date for data selection. Format: ‘2006-01-02’ or ‘2006-01-02T15:04:05’. Can be used separately or together with end_date.
string ("close" | "open" | "high" | "low" | "volume")
Price type on which technical indicator is calculated.
integer
Number of periods to average over. Takes values in the range from 1 to 800.
boolean
Specify if OHLC values should be added in the output.
boolean
Include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_ROCPTool to calculate and return the Rate of Change Percentage (ROCP) for a financial security. Use when you need to identify shifts in price momentum and potential trend reversals.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. Default -1 (automatically determined).
string
Specifies the exact date to get the data for. Could be exact date (e.g., ‘2021-10-27’), or in human language ‘today’ or ‘yesterday’.
string
The FIGI of an instrument for which data is requested.
string
Filter by international securities identification number (ISIN).
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
The CUSIP of an instrument for which data is requested.
string ("asc" | "desc")
Sorting order of the output.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices.
string ("JSON" | "CSV")
The format of the response data.
string
Symbol ticker of the instrument. E.g. ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’.
string
The country where the instrument is traded, e.g., ‘United States’ or ‘US’.
boolean
Returns quotes that include pre-market and post-market data. Only for Pro and above plans.
string
End date for data selection. Format ‘2006-01-02’ or ‘2006-01-02T15:04:05’.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed. Supports ‘Exchange’, ‘UTC’, or IANA timezone names (e.g., ‘America/New_York’).
string
The separator used in the CSV response data.
integer
Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set.
string
Start date for data selection. Format ‘2006-01-02’ or ‘2006-01-02T15:04:05’.
string ("close" | "open" | "high" | "low" | "volume")
Price type on which technical indicator is calculated.
integer
Number of periods to average over. Takes values in the range from 1 to 800. Default 9.
boolean
Specify if OHLC values should be added in the output.
boolean
A boolean parameter to include the previous closing price in the time_series data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_ROCR100Tool to calculate the Rate of Change Ratio 100 (ROCR100) for a security. The ROCR100 calculates the percentage change in a security’s price over a specified period, expressed as a ratio to 100. Use when you need to assess the momentum and direction of a security’s price trend over time.

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined.
string
Specifies the exact date to get the data for. Could be the exact date, e.g. ‘2021-10-27’, or in human language ‘today’ or ‘yesterday’.
string
The FIGI of an instrument for which data is requested. Available starting with the Ultra plan.
string
Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section.
string ("asc" | "desc")
Sorting order of the output. Default is ‘desc’.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices. Default is ‘splits’.
string ("JSON" | "CSV")
The format of the response data. Default is ‘JSON’.
string
Symbol ticker of the instrument. E.g. ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’.
string
The country where the instrument is traded, e.g., ‘United States’ or ‘US’.
boolean
Returns quotes that include pre-market and post-market data. Only for Pro and above plans. Available at the 1min, 5min, 15min, and 30min intervals for US equities.
string
End date for data selection. Format ‘2006-01-02’ or ‘2006-01-02T15:04:05’. See start_date description for details.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed. Supports: ‘Exchange’ for local exchange time, ‘UTC’ for universal UTC standard, or timezone name according to the IANA Time Zone Database (e.g., ‘America/New_York’, ‘Asia/Singapore’).
string
The separator used in the CSV response data. Default is ’;’.
integer
Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set, otherwise set to maximum.
string
Start date for data selection. Format ‘2006-01-02’ or ‘2006-01-02T15:04:05’. Can be used separately and together with end_date.
string ("close" | "open" | "high" | "low" | "volume")
Price type on which technical indicator is calculated. Default is ‘close’.
integer
Number of periods to average over. Takes values in the range from 1 to 800. Default is 9.
boolean
Specify if OHLC values should be added in the output.
boolean
A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_RVOLTool to fetch relative volume (RVOL) data for a security. RVOL provides a ratio comparing a security’s current trading volume to its average volume over a specified period, helping detect unusual trading activity and assess the strength of price movements.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.
string
Specifies the exact date to get the data for. Could be the exact date (e.g., ‘2021-10-27’), or in human language ‘today’ or ‘yesterday’.
string
The FIGI of an instrument for which data is requested. Available starting with the Ultra plan.
string
International securities identification number (ISIN). ISIN access is activating in the Data add-ons section.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section.
string ("asc" | "desc")
Sorting order of the output.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices.
string ("JSON" | "CSV")
The format of the response data.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’). At least one of symbol, isin, figi, or cusip must be provided.
string
The country where the instrument is traded (e.g., ‘United States’ or ‘US’).
boolean
Returns quotes that include pre-market and post-market data. Only for Pro and above plans. Available at the 1min, 5min, 15min, and 30min intervals for US equities.
string
The ending date and time for data selection. Format: ‘2006-01-02’ or ‘2006-01-02T15:04:05’.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series. Required field.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed. Supports: ‘Exchange’ for local exchange time, ‘UTC’ for universal UTC standard, or IANA timezone name (e.g., ‘America/New_York’, ‘Asia/Singapore’). Default is ‘Exchange’.
string
The separator used in the CSV response data.
integer
Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set, otherwise set to maximum.
string
Can be used separately and together with end_date. Format: ‘2006-01-02’ or ‘2006-01-02T15:04:05’. If timezone parameter is provided, start_date will be used in the specified location.
integer
Number of periods to average over. Takes values in the range from 1 to 800.
boolean
Specify if OHLC values should be added in the output.
boolean
A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_SIMPLE_MOVING_AVERAGEReturn a bounded simple moving average series for one symbol, interval, price field, and averaging period.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

string ("asc" | "desc")
Sort points oldest-first (asc) or newest-first (desc).
string
required
Ticker or provider symbol for one instrument, for example AAPL, EUR/USD, or ETH/BTC.
string
Optional inclusive end date/time as YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "8h" | "1day" | "1week" | "1month")
required
Time between consecutive SMA points.
string
Exchange, UTC, or a case-sensitive IANA timezone; daily and longer intervals use exchange-local time.
string
Optional inclusive start date/time as YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.
integer
Maximum SMA points in this bounded response window (1-5000); no continuation token is available.
string ("close" | "open" | "high" | "low" | "volume")
OHLCV source field on which to calculate the SMA.
integer
Number of source periods averaged into each SMA point (1-800).
boolean
Include source OHLC fields beside each SMA value when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_SPLITSTool to retrieve historical stock split events. Use when you need to fetch split history for a particular instrument.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 API creditsDiscount: 79

Input Parameters

string
Filter by FIGI (e.g., ‘BBG01293F5X4’). Required if other identifiers are not provided.
string
Filter by ISIN (e.g., ‘US0378331005’). Required if other identifiers are not provided.
string
Filter by CUSIP (e.g., ‘594918104’). Required if other identifiers are not provided.
string ("last" | "1m" | "3m" | "6m" | "ytd" | "1y" | "2y" | "5y" | "full")
Data range (one of last, 1m, 3m, 6m, ytd, 1y, 2y, 5y, full). Default is ‘last’.
string
Ticker of the instrument (e.g., ‘AAPL’). Required if other identifiers are not provided.
string
Country name or two-letter code (e.g., ‘United States’ or ‘US’).
string
Inclusive end date for the split events (YYYY-MM-DD).
string
Exchange where the instrument is traded (e.g., ‘NASDAQ’).
string
Market Identifier Code (ISO 10383) (e.g., ‘XNAS’).
string
Inclusive start date for the split events (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_SPLITS_CALENDARTool to retrieve a calendar of stock split events. Use when you need to fetch split events for instruments over a date range.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 API creditsDiscount: 79

Input Parameters

string
Filter by FIGI identifier.
string
Filter by ISIN identifier.
integer
Page number for paginated results. Defaults to 1.
string
Filter by CUSIP identifier.
string
Symbol ticker of the instrument; use dot for preferred shares (e.g., ‘BRK.A’).
string
Country where the instrument is traded (full name or ISO code).
string
End date (inclusive) in YYYY-MM-DD format.
string
Exchange where the instrument is traded (e.g., ‘NASDAQ’).
string
ISO 10383 Market Identifier Code (e.g., ‘XNAS’).
integer
Number of records to return (1–500). Defaults to 100 when no date filters.
string
Start date (inclusive) in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_STATISTICSTool to retrieve key company statistics including valuation and financial overview. Use when you need a company financial snapshot after selecting an instrument.

Input Parameters

string
Financial Instrument Global Identifier. Provide one of symbol, figi, isin, or cusip.
string
International Securities Identification Number. Provide one of symbol, figi, isin, or cusip.
string
CUSIP identifier. Provide one of symbol, figi, isin, or cusip.
string
Ticker symbol to query (e.g., ‘AAPL’). Provide one of symbol, figi, isin, or cusip.
string
Country where the instrument is traded (name or alpha code, e.g., ‘United States’ or ‘US’).
string
Exchange where the instrument is traded (e.g., ‘NASDAQ’).
string
Market Identifier Code (ISO 10383) for the exchange (e.g., ‘XNAS’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_STOCHRSITool to calculate the Stochastic Relative Strength Index (Stochastic RSI) for a specified financial instrument. Returns %K and %D line values to identify overbought or oversold conditions and potential price reversals. Use when you need to refine entry and exit points by analyzing momentum indicators.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.
string
Specifies the exact date to get the data for. Could be the exact date, e.g. ‘2021-10-27’, or in human language ‘today’ or ‘yesterday’.
string
The FIGI of an instrument for which data is requested. Available starting with the Ultra plan.
string
Filter by international securities identification number (ISIN). ISIN access is activated in the Data add-ons section.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
The CUSIP of an instrument for which data is requested. CUSIP access is activated in the Data add-ons section.
string ("asc" | "desc")
Sorting order of the output.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices.
string ("JSON" | "CSV")
The format of the response data.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’). At least one of symbol, isin, figi, or cusip must be provided.
string
The country where the instrument is traded, e.g., ‘United States’ or ‘US’.
boolean
Returns quotes that include pre-market and post-market data. Only for Pro and above plans. Available at the 1min, 5min, 15min, and 30min intervals for US equities. Open, high, low, close values are supplied without volume.
integer
Period for smoothing the %D line, which is a moving average of %K. Takes values in the range from 1 to 800.
string
The ending date and time for data selection, see start_date description for details.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series.
integer
Period for smoothing the %K line. Takes values in the range from 1 to 800.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed. Supports: ‘Exchange’ for local exchange time, ‘UTC’ for datetime at universal UTC standard, or timezone name according to the IANA Time Zone Database (e.g., ‘America/New_York’, ‘Asia/Singapore’). The IANA Timezone name is case-sensitive.
string
The separator used in the CSV response data.
integer
Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set, otherwise set to maximum.
integer
Length of period for calculating the RSI component. Takes values in the range from 1 to 800.
string
Can be used separately and together with end_date. Format ‘2006-01-02’ or ‘2006-01-02T15:04:05’. Both parameters take into account if timezone parameter is provided.
string ("open" | "high" | "low" | "close")
Price type for technical indicator calculation.
boolean
Specify if OHLC values should be added in the output.
integer
Period length for computing the stochastic oscillator of the RSI. Takes values in the range from 1 to 800.
string
Type of moving average for smoothing the %D line.
string
Type of moving average for smoothing the %K line.
boolean
A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_SUMTool to calculate the cumulative total (Summation) of a specified data series over a defined time period. Returns numerical values representing the sum of financial data such as stock prices or trading volumes. Use when you need to track the aggregate value of a dataset for further analysis.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.
string
Specifies the exact date to get the data for. Could be the exact date, e.g. ‘2021-10-27’, or in human language ‘today’ or ‘yesterday’.
string
The FIGI of an instrument for which data is requested. This request parameter is available starting with the Ultra plan.
string
Filter by international securities identification number (ISIN). ISIN access is activated in the Data add-ons section.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
Asset class to which the instrument belongs.
string
The CUSIP of an instrument for which data is requested. CUSIP access is activated in the Data add-ons section.
string ("asc" | "desc")
Sorting order of the output.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices.
string ("JSON" | "CSV")
Format of the response data.
string
Symbol ticker of the instrument. E.g. ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’. Either symbol, isin, figi, or cusip must be provided.
string
The country where the instrument is traded, e.g., ‘United States’ or ‘US’.
boolean
Returns quotes that include pre-market and post-market data. Only for Pro and above plans. Available at the 1min, 5min, 15min, and 30min intervals for US equities. Open, high, low, close values are supplied without volume.
string
The ending date and time for data selection. Format ‘2006-01-02’ or ‘2006-01-02T15:04:05’. Works together with start_date.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed. Supports: ‘Exchange’ for local exchange time, ‘UTC’ for universal UTC standard, or timezone name according to IANA Time Zone Database (e.g., ‘America/New_York’, ‘Asia/Singapore’). The IANA Timezone name is case-sensitive.
string
The separator used in the CSV response data. Default is ’;’.
integer
Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set, otherwise set to maximum.
string
Can be used separately and together with end_date. Format ‘2006-01-02’ or ‘2006-01-02T15:04:05’. If timezone is given, start_date will be used in the specified location. Returns all records starting from start_date up to current date or end_date if provided.
string ("close" | "open" | "high" | "low" | "volume")
Price type on which technical indicator is calculated.
integer
Number of periods to average over. Takes values in the range from 1 to 800. Default is 9.
boolean
Specify if OHLC values should be added in the output.
boolean
A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_TECHNICAL_INDICATORS_LISTTool to retrieve a comprehensive list of available technical indicators. Use when you need to discover which technical analysis tools are available.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requestsDiscount: 79

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_TEMATool to calculate the Triple Exponential Moving Average (TEMA) for a financial instrument. TEMA applies three layers of exponential smoothing to price data, providing a smoother trend line with reduced lag compared to simple moving averages. Use when you need to identify trends with minimal delay for trading signals.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Number of decimal places for floating values (range: 0-11).
string
Exact date to get data for. Format: ‘2021-10-27’, ‘today’, or ‘yesterday’.
string
The FIGI of an instrument. Available starting with the Ultra plan.
string
International securities identification number (ISIN). Requires Data add-ons subscription.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
Asset class types.
string
The CUSIP of an instrument. Requires Data add-ons subscription.
string ("asc" | "desc")
Sorting order for output.
string ("all" | "splits" | "dividends" | "none")
Price adjustment mode.
string ("JSON" | "CSV")
Response format options.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’). Either symbol, isin, figi, or cusip must be provided.
string
The country where the instrument is traded (e.g., ‘United States’ or ‘US’).
boolean
Include pre-market and post-market data. Only for Pro+ plans at 1min, 5min, 15min, 30min intervals for US equities.
string
Ending date for data selection. See start_date description for format details.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone for output datetime. Options: ‘Exchange’ (local), ‘UTC’, or IANA timezone name (e.g., ‘America/New_York’).
string
The separator used in CSV response data.
integer
Number of data points to retrieve (range: 1-5000). Default 30 when no date parameters are set.
string
Starting date for data selection. Format: ‘2006-01-02’ or ‘2006-01-02T15:04:05’. Can be used with or without end_date.
string ("close" | "open" | "high" | "low" | "volume")
Price type for technical indicator calculation.
integer
The time period used for calculation in the indicator. Default is 9.
boolean
Specify if OHLC values should be added in the output.
boolean
Include the previous closing price in time_series data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_TIME_SERIESReturn a bounded OHLCV history window for one symbol and interval; this does not paginate or fetch an unbounded history.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

string ("asc" | "desc")
Sort bars oldest-first (asc) or newest-first (desc).
string
required
Ticker or provider symbol for one instrument, for example AAPL, EUR/USD, or ETH/BTC.
string
Optional inclusive end date/time as YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS in the selected timezone.
string
Exchange name used to disambiguate the symbol.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "8h" | "1day" | "1week" | "1month")
required
Time between consecutive bars.
string
ISO 10383 market identifier code used to disambiguate the symbol.
string
Exchange, UTC, or a case-sensitive IANA timezone; daily and longer intervals ignore this and use exchange-local time.
string
One exact date such as 2026-08-07, today, or yesterday; mutually exclusive with start_date and end_date.
string
Optional inclusive start date/time as YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS in the selected timezone.
integer
Maximum bars in this bounded response window (1-5000); no continuation token is available.
integer
Decimal places for numeric strings (0-11), or -1 for provider-selected precision.
boolean
Include the previous bar’s close on each returned bar when supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_USAGE_LIMITSRetrieve the connected key’s current minute usage, limit, and timestamp, along with daily usage, daily limit, and plan category when available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_VARTool to calculate the statistical variance of a financial data series. Use when you need to measure the volatility or dispersion of security prices over a specified period to assess risk.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default (when -1), the number of decimal places is automatically determined based on the values provided.
string
Specifies the exact date to get the data for. Could be the exact date, e.g. ‘2021-10-27’, or in human language ‘today’ or ‘yesterday’.
string
The FIGI of an instrument for which data is requested. Available starting with the Ultra plan.
string
Filter by international securities identification number (ISIN). ISIN access is activated in the Data add-ons section.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
The CUSIP of an instrument for which data is requested. CUSIP access is activated in the Data add-ons section.
string ("asc" | "desc")
Sorting order of the output.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices.
string ("JSON" | "CSV")
The format of the response data.
string
Symbol ticker of the instrument (e.g., ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’). Either symbol, isin, figi, or cusip must be provided.
string
The country where the instrument is traded, e.g., ‘United States’ or ‘US’.
boolean
Returns quotes that include pre-market and post-market data. Only for Pro and above plans. Available at the 1min, 5min, 15min, and 30min intervals for US equities. Open, high, low, close values are supplied without volume.
string
The ending date and time for data selection, see start_date description for details.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone at which output datetime will be displayed. Supports: ‘Exchange’ for local exchange time, ‘UTC’ for datetime at universal UTC standard, or timezone name according to the IANA Time Zone Database (e.g., ‘America/New_York’, ‘Asia/Singapore’). The IANA Timezone name is case-sensitive.
string
The separator used in the CSV response data.
integer
Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set, otherwise set to maximum.
string
Can be used separately and together with end_date. Format ‘2006-01-02’ or ‘2006-01-02T15:04:05’. Both parameters take into account if timezone parameter is provided.
string ("close" | "open" | "high" | "low" | "volume")
Price type on which technical indicator is calculated.
integer
Number of periods to average over. Takes values in the range from 1 to 800. Default is 9.
boolean
Specify if OHLC values should be added in the output.
boolean
A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_WCLPRICETool to calculate and retrieve the Weighted Close Price (WCLPRICE) for a security. WCLPRICE gives additional weight to the closing price using the formula (High + Low + Close * 2) / 4. Use when you need to analyze price trends with emphasis on closing values.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Number of decimal places for floating values. Range [0, 11]. Default is automatically determined.
string
Specifies exact date for data retrieval. Can be exact date like ‘2021-10-27’, or human language like ‘today’ or ‘yesterday’.
string
Financial Instrument Global Identifier (FIGI) of the instrument. Available with Ultra plan or higher.
string
International Securities Identification Number (ISIN) of the instrument. ISIN access requires activation in Data add-ons.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
Asset class types supported by Twelve Data API.
string
CUSIP identifier of the instrument. CUSIP access requires activation in Data add-ons.
string ("asc" | "desc")
Sorting order for output data.
string ("all" | "splits" | "dividends" | "none")
Price adjustment modes.
string ("JSON")
Response format options.
string
Symbol ticker of the instrument. At least one of symbol, isin, figi, or cusip must be provided. E.g. ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’.
string
Country where the instrument is traded, e.g., ‘United States’ or ‘US’.
boolean
Include pre-market and post-market data. Only for Pro and above plans. Available at 1min, 5min, 15min, and 30min intervals for US equities.
string
End date for data selection. Format and behavior same as start_date.
string
Exchange where the instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Time interval between consecutive data points. Required parameter.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone for output datetime. Supports ‘Exchange’ for local exchange time, ‘UTC’ for UTC standard, or IANA timezone names like ‘America/New_York’. Default is ‘Exchange’.
string
Separator used in CSV response data. Default is ’;’.
integer
Number of data points to retrieve. Supports values from 1 to 5000. Default is 30 when no date parameters are set.
string
Start date for data selection in format ‘2006-01-02’ or ‘2006-01-02T15:04:05’. Can be used separately or with end_date. Timezone-aware based on the timezone parameter.
boolean
Specify if OHLC (Open, High, Low, Close) values should be added in the output.
boolean
Include previous closing price in the time series data. If true, adds previous bar close price to current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_GET_WMATool to calculate and retrieve the Weighted Moving Average (WMA) for a security over a specified period. Use when you need to analyze short-term price trends with recent prices having higher influence.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

integer
Number of decimal places for floating values. Range: 0-11. By default, automatically determined.
string
Specifies exact date to get data for. Can be exact date (e.g., ‘2021-10-27’) or human language (‘today’ or ‘yesterday’).
string
Financial Instrument Global Identifier (FIGI). Available starting with Ultra plan.
string
International Securities Identification Number (ISIN). Requires activation in Data add-ons.
string ("American Depositary Receipt" | "Bond" | "Bond Fund" | "Closed-end Fund" | "Common Stock" | "Depositary Receipt" | "Digital Currency" | "ETF" | "Exchange-Traded Note" | "Global Depositary Receipt" | "Limited Partnership" | "Mutual Fund" | "Physical Currency" | "Preferred Stock" | "REIT" | "Right" | "Structured Product" | "Trust" | "Unit" | "Warrant")
The asset class to which the instrument belongs.
string
CUSIP identifier. Requires activation in Data add-ons.
string ("asc" | "desc")
Sorting order of the output. Default is ‘desc’.
string ("all" | "splits" | "dividends" | "none")
Adjusting mode for prices. Default is ‘splits’.
string ("JSON" | "CSV")
The format of the response data. Default is ‘JSON’.
string
Symbol ticker of the instrument. E.g. ‘AAPL’, ‘EUR/USD’, ‘ETH/BTC’. At least one of symbol, isin, figi, or cusip must be provided.
string
The country where the instrument is traded, e.g., ‘United States’ or ‘US’.
boolean
Include pre-market and post-market data. Only for Pro+ plans at 1min/5min/15min/30min intervals for US equities.
string
End date for data selection. Format: ‘YYYY-MM-DD’ or ‘YYYY-MM-DDTHH:MM:SS’. See start_date description for details.
string
Exchange where instrument is traded.
string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month")
required
Interval between two consecutive points in time series.
string
Market Identifier Code (MIC) under ISO 10383 standard.
string
Timezone for output datetime. Supports ‘Exchange’, ‘UTC’, or IANA timezone name (e.g., ‘America/New_York’). Default is ‘Exchange’.
string
The separator used in CSV response data. Default is ’;’.
integer
Number of data points to retrieve. Range: 1-5000. Default is 30 when no date parameters are set.
string
Start date for data selection. Format: ‘YYYY-MM-DD’ or ‘YYYY-MM-DDTHH:MM:SS’. Can be used with or without end_date.
string ("close" | "open" | "high" | "low" | "volume")
Price type on which technical indicator is calculated. Default is ‘close’.
integer
Number of periods to average over. Range: 1-800. Default is 9.
boolean
Specify if OHLC values should be added in the output. Default is false.
boolean
Include previous closing price in time_series data. If true, adds previous bar close price to current object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_INDICESTool to retrieve a list of market indices. Use when you need to fetch available indices filtered by country.

Input Parameters

string
Response format. Only ‘json’ is supported.
string
Filter indices by 2-letter ISO country code, e.g., ‘US’, ‘GB’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_INSTITUTIONAL_HOLDERSTool to retrieve institutional holders positions for a company. Use when you need summary ownership metrics and top institutions.

Input Parameters

string
Filter by FIGI (e.g., ‘BBG01293F5X4’). Required if other identifiers are not provided.
string
Filter by ISIN (e.g., ‘US0378331005’). Required if other identifiers are not provided.
string
Filter by CUSIP (e.g., ‘594918104’). Required if other identifiers are not provided.
string
Ticker of the instrument (e.g., ‘AAPL’). Required if other identifiers are not provided.
string
Country name or two-letter code (e.g., ‘US’).
string
Exchange where the instrument is traded (e.g., ‘NASDAQ’).
string
Market Identifier Code (e.g., ‘XNAS’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_LIST_STOCKSList and filter stocks in Twelve Data’s reference directory, one explicit page at a time. Increment page while has_more is true. Each page is charged separately; this tool never fetches additional pages automatically.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requestsDiscount: 79

Input Parameters

integer
One-based page number to fetch. Increment this value to request the next page.
integer
Stocks to request on this page (1-5000).
string
Optional exact ticker filter.
string
Optional country name or alpha-code filter, for example United States or US.
string
Optional exchange-name filter, for example NASDAQ.
string
Optional ISO 10383 market identifier filter, for example XNAS.
boolean
Include delisted stock identifiers when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_MUTUAL_FUNDS_FAMILYList the mutual fund families available from investment companies.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requestsDiscount: 79

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_MUTUAL_FUNDS_LISTTool to retrieve a daily updated list of mutual funds sorted by total assets. Use when you need to enumerate available mutual funds for analysis.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requestsDiscount: 79

Input Parameters

string
Filter mutual funds by type (e.g., ‘Open Ended’).
string ("json" | "csv")
Output format: ‘json’ or ‘csv’. Default is ‘json’.
string
Filter mutual funds by country (e.g., ‘US’).
string
Filter mutual funds by exchange (e.g., ‘NASDAQ’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_MUTUAL_FUNDS_WORLD_COMPOSITIONFetch global mutual fund portfolio composition, including sectors, asset allocation, top holdings, and bond metrics. API-level errors may be returned in the response with an error status.

Input Parameters

integer
Number of decimal places for floating values; range [0-11]; defaults to 5.
string
Financial Instrument Global Identifier. One of symbol, figi, isin, or cusip is required.
string
International Securities Identification Number. One of symbol, figi, isin, or cusip is required.
string
CUSIP identifier. One of symbol, figi, isin, or cusip is required.
string
Symbol ticker of the mutual fund. One of symbol, figi, isin, or cusip is required.
string
Filter by country name or alpha code (e.g., ‘United States’ or ‘US’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_OPTIONS_CHAIN_ACTIONTool to retrieve the options chain for a given symbol and optional expiration date. Use when you need detailed option contract data and Greeks. Omitting date returns all expirations.

Input Parameters

string
Expiration date in YYYY-MM-DD format. Omit to retrieve all available expiration dates.
string
required
Ticker symbol for the option’s underlying asset.
boolean
Whether to include Greeks data (delta, gamma, etc.). Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_OPTIONS_EXPIRATIONTool to retrieve available option expiration dates. Use when exploring available expiration dates for a given options symbol.

Input Parameters

string
required
Ticker symbol of the underlying security for options expiration lookup.
string
Exchange code where the security is listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_QUOTERetrieve the latest available market quote for a specified symbol. Real-time access depends on the data covered by the user’s plan.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

string ("JSON" | "CSV")
Response format: ‘JSON’ or ‘CSV’. Default is JSON.
string
Optional data source override, e.g., ‘docs’.
string
required
Ticker symbol to query (e.g., ‘AAPL’, ‘MSFT’, ‘BTC/USD’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_SEARCH_SYMBOLSFind tradable instrument symbols and exchange identifiers by ticker or name; returns a bounded match list with no pagination.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requestsDiscount: 79

Input Parameters

integer
Maximum matches to return in this bounded response (1-120).
string
required
Ticker or instrument-name text to search, for example AAPL or Apple.
boolean
Include the minimum plan information reported for each symbol when available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_STOCKS_LISTTool to retrieve a list of stocks. Use when you need to fetch securities with optional filtering by exchange, country, type, or symbol.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requestsDiscount: 79

Input Parameters

string
Type of security to filter (e.g., ‘Common Stock’).
string ("json" | "csv")
Response format: ‘json’ or ‘csv’.
string
Specific stock symbol to filter by (e.g., ‘AAPL’).
string
Country code to filter by (e.g., ‘United States’).
string
Exchange code to filter results (e.g., ‘NYSE’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_SYMBOL_SEARCHTool to search for financial instruments by symbol or company name. Use when you need to discover available symbols before making further data requests.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requestsDiscount: 79

Input Parameters

string
required
Symbol or company name to search for, supports partial matches.
string
Exchange code to filter results (optional).
integer
Maximum number of results to return (1-10000).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_TECHNICAL_INDICATORSTool to fetch time-series data for a specific technical indicator. Use when you have a symbol, interval, and indicator name.

Input Parameters

string
required
Symbol to compute the indicator for (e.g., ‘AAPL’, ‘BTC/USD’).
string ("1min" | "5min" | "15min" | "30min" | "1h" | "2h" | "4h" | "1day" | "1week" | "1month")
required
Time interval for the data.
string
required
Name of the technical indicator (e.g., ‘sma’, ‘ema’, ‘rsi’).
integer
Number of data points to return, between 1 and 5000.
object
Additional indicator-specific parameters (e.g., period, series_type).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWELVE_DATA_TIME_SERIESTool to retrieve historical and real-time time series data for a specified symbol. Use when you need to fetch price data over a time range after selecting a symbol. Response data points are not guaranteed to be in chronological or reverse-chronological order; always sort by timestamp before indexing.Instant: Supported on the latest version.Instant pricing: $0.001 per 100 requests, charged per symbol requestedDiscount: 79

Input Parameters

string ("JSON" | "CSV")
Response format: ‘JSON’ or ‘CSV’.
string
required
Ticker symbol to query (e.g., ‘AAPL’).
string
Inclusive end date for the data, in YYYY-MM-DD or ISO 8601 format.
string ("1min" | "5min" | "15min" | "30min" | "1h" | "4h" | "1day" | "1week" | "1month")
required
Time interval between data points.
string
Timezone for the timestamps, e.g., ‘UTC’ or ‘America/New_York’.
integer
Maximum number of data points to return (default 30, maximum 5000).
string
Inclusive start date for the data, in YYYY-MM-DD or ISO 8601 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not