# Twelve Data

Twelve Data provides a comprehensive financial data API offering real-time and historical market data for stocks, forex, cryptocurrencies, ETFs, and indices.

- **Category:** analytics
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 97
- **Triggers:** 0
- **Slug:** `TWELVE_DATA`
- **Version:** 20260316_00

## Tools

### Cash Flow

**Slug:** `TWELVE_DATA_CASH_FLOW`

Tool to get company cash flow statement. Use when you need operating, investing, and financing cash flow details after selecting a company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `figi` | string | No | Financial Instrument Global Identifier. |
| `isin` | string | No | International Securities Identification Number. |
| `cusip` | string | No | CUSIP identifier. |
| `period` | string ("annual" | "quarterly") | No | Reporting period; supports 'annual' or 'quarterly'. |
| `symbol` | string | No | Ticker symbol to query (e.g., 'AAPL'). |
| `country` | string | No | Country where instrument is traded (e.g., 'US'). |
| `end_date` | string | No | Include statements with fiscal_date on or before this date (YYYY-MM-DD). |
| `exchange` | string | No | Exchange where the instrument is traded (e.g., 'NASDAQ'). |
| `mic_code` | string | No | Market Identifier Code under ISO 10383 (e.g., 'XNAS'). |
| `outputsize` | integer | No | Number of records to return. |
| `start_date` | string | No | Include statements with fiscal_date on or after this date (YYYY-MM-DD). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Consolidated Cash Flow

**Slug:** `TWELVE_DATA_CASH_FLOW_CONSOLIDATED`

Tool to get raw consolidated cash flow statements. Use when you need detailed cash flow data for a company.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Commodities

**Slug:** `TWELVE_DATA_COMMODITIES_LIST`

Tool to retrieve a list of supported commodities. Use when you need all available commodities after obtaining a valid API key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Correlation Coefficient

**Slug:** `TWELVE_DATA_CORREL`

Tool to fetch Pearson correlation coefficient between two series over a period. Use after selecting identifiers and interval.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Countries

**Slug:** `TWELVE_DATA_COUNTRIES_LIST`

Tool to retrieve a list of countries with ISO codes, names, capitals, and currencies. Use when you need country metadata after obtaining a valid API key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cross Listings

**Slug:** `TWELVE_DATA_CROSS_LISTINGS`

Tool to retrieve cross-listed symbols for a security across multiple exchanges. Use when you need to list all market listings of a given instrument.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | Ticker symbol of the instrument (e.g., 'AAPL'). |
| `country` | string | No | Country to filter results (e.g., 'United States'). |
| `exchange` | string | No | Exchange code to filter results (e.g., 'NASDAQ'). |
| `mic_code` | string | No | Market Identifier Code to filter results (ISO 10383, e.g., 'XNGS'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Cryptocurrencies

**Slug:** `TWELVE_DATA_CRYPTOCURRENCIES`

Tool to list all supported cryptocurrencies. Use when you need the complete set of crypto symbols. Use after obtaining a valid API key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `apikey` | string | Yes | Your Twelve Data API key. |
| `symbol` | string | No | Comma-separated cryptocurrency symbol(s) to filter (e.g., 'BTC,ETH'). |
| `outputsize` | integer | No | Number of records to return, must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Cryptocurrency Exchanges

**Slug:** `TWELVE_DATA_CRYPTOCURRENCY_EXCHANGES_LIST_GET`

Tool to list supported cryptocurrency exchanges. Use when you need a list of available crypto trading platforms.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("JSON" | "CSV") | No | Response format: JSON (default) or CSV. |
| `delimiter` | string | No | CSV delimiter; only used when format is 'CSV'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Currency Conversion

**Slug:** `TWELVE_DATA_CURRENCY_CONVERSION`

Tool to convert an amount from one currency to another. Use after confirming currency codes to retrieve real-time conversion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `amount` | number | Yes | Non-negative amount in the source currency to convert. |
| `to_currency` | string | Yes | Three-letter ISO currency code for the target currency (e.g., 'EUR'). |
| `from_currency` | string | Yes | Three-letter ISO currency code for the source currency (e.g., 'USD'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Dividends

**Slug:** `TWELVE_DATA_DIVIDENDS`

Tool to retrieve dividend payout history for a specified symbol. Use when you need historical dividends over multiple years.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Earnings

**Slug:** `TWELVE_DATA_EARNINGS`

Tool to retrieve earnings data including EPS estimates and actuals. Use when you need detailed earnings history for a selected stock symbol.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("annual" | "quarterly") | No | Type of earnings report: 'annual' or 'quarterly'. |
| `format` | string ("JSON" | "CSV") | No | Response format: 'JSON' (default) or 'CSV'. |
| `source` | string | No | Optional data source override. |
| `symbol` | string | Yes | Ticker symbol of the equity, e.g., 'AAPL'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### EPS Revisions

**Slug:** `TWELVE_DATA_EPS_REVISIONS`

Tool to provide analysts’ revisions of a company’s future EPS over the last week and month. Use after confirming the stock symbol.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Number of decimal places for numeric values. |
| `format` | string | No | Response format. Only 'json' is supported. |
| `symbol` | string | Yes | Stock symbol to request data for (e.g., 'AAPL'). |
| `exchange` | string | No | Exchange code (e.g., 'NASDAQ'). Auto-detected from symbol if not provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### EPS Trend

**Slug:** `TWELVE_DATA_EPS_TREND_ACTION`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | The symbol of the instrument (e.g., 'AAPL'). |
| `country` | string | No | Country code for the exchange (e.g., 'US'). |
| `exchange` | string | No | Exchange code where the symbol is traded (e.g., 'NASDAQ'). Auto-detected if not provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### ETFS Directory

**Slug:** `TWELVE_DATA_ETFS_DIRECTORY`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("JSON" | "CSV") | No | Response format: 'JSON' (default) or 'CSV'. |
| `country` | string | No | Filter ETFs by country code (e.g., 'US'). |
| `exchange` | string | No | Filter ETFs by exchange code (e.g., 'NASDAQ'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### ETFS Family

**Slug:** `TWELVE_DATA_ETFS_FAMILY`

Tool to fetch a comprehensive list of ETFs by family. Use when you need to list ETFs managed by a specific investment company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `family` | string | No | Name of the ETF family to filter by (e.g., 'Vanguard'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get ETF Types

**Slug:** `TWELVE_DATA_ETFS_TYPE`

Tool to retrieve ETF categories by market, including types like 'Equity Precious Metals'. Use after confirming API key is set; no parameters are needed. Returns a dictionary mapping country names to lists of ETF types available in that country.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### ETF World

**Slug:** `TWELVE_DATA_ETFS_WORLD`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Decimal places for floating values; range 0–11. Defaults to 5. |
| `figi` | string | No | Financial Instrument Global Identifier. |
| `isin` | string | No | International Securities Identification Number. |
| `cusip` | string | No | CUSIP code of the instrument. |
| `symbol` | string | No | ETF ticker symbol (e.g., 'IVV'). |
| `country` | string | No | Country name or ISO code (e.g., 'United States' or 'US'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### ETF World Composition

**Slug:** `TWELVE_DATA_ETFS_WORLD_COMPOSITION`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### ETF World Risk

**Slug:** `TWELVE_DATA_ETFS_WORLD_RISK`

Tool to get global ETF risk metrics. Use when you need to analyze volatility and valuation ratios for an ETF.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Decimal places for floating values; range 0–11. Defaults to 5. |
| `figi` | string | No | Financial Instrument Global Identifier. |
| `isin` | string | No | International Securities Identification Number. |
| `cusip` | string | No | CUSIP code of the instrument. |
| `symbol` | string | No | ETF ticker symbol (e.g., 'IVV'). |
| `country` | string | No | Country name or ISO code (e.g., 'United States' or 'US'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List supported exchanges

**Slug:** `TWELVE_DATA_EXCHANGES`

Tool to retrieve a list of supported exchanges. Use when you need all available stock and forex exchanges.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("json" | "csv") | No | Response format; allowed values: json, csv |
| `country` | string | No | Filter exchanges by 2-letter ISO country code, e.g., 'US', 'GB' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List supported forex pairs

**Slug:** `TWELVE_DATA_FOREX_PAIRS`

Tool to retrieve a list of all supported forex currency pairs. Use when exploring available forex pairs before making other forex data requests.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get AD Indicator

**Slug:** `TWELVE_DATA_GET_AD`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | 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. |
| `date` | string | No | 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'. |
| `figi` | string | No | The FIGI of an instrument for which data is requested. This request parameter is available starting with the Ultra plan. |
| `isin` | string | No | Filter by international securities identification number (ISIN). ISIN access is activated in the Data add-ons section. |
| `type` | 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") | No | Asset class to which the instrument belongs. |
| `cusip` | string | No | The CUSIP of an instrument for which data is requested. CUSIP access is activated in the Data add-ons section. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. |
| `format` | string ("JSON" | "CSV") | No | Format of the response data. |
| `symbol` | string | No | Symbol ticker of the instrument. E.g. 'AAPL', 'EUR/USD', 'ETH/BTC'. Either symbol, isin, figi, or cusip must be provided. |
| `country` | string | No | The country where the instrument is traded, e.g., 'United States' or 'US'. |
| `prepost` | boolean | No | 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. |
| `end_date` | string | No | The ending date and time for data selection. Format '2006-01-02' or '2006-01-02T15:04:05'. Works together with start_date. |
| `exchange` | string | No | Exchange where instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | 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. |
| `delimiter` | string | No | The separator used in the CSV response data. Default is ';'. |
| `outputsize` | integer | No | 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. |
| `start_date` | string | No | 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. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. |
| `previous_close` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get API Usage

**Slug:** `TWELVE_DATA_GET_API_USAGE`

Tool to retrieve your current plan and remaining API credits. Use when monitoring your subscription usage in real-time.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get APO (Absolute Price Oscillator)

**Slug:** `TWELVE_DATA_GET_APO`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Number of decimal places for floating values (range: 0-11). |
| `date` | string | No | Exact date to get data for. Format: '2021-10-27', 'today', or 'yesterday'. |
| `figi` | string | No | The FIGI of an instrument. Available starting with the Ultra plan. |
| `isin` | string | No | International securities identification number (ISIN). Requires Data add-ons subscription. |
| `type` | 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") | No | Asset class types. |
| `cusip` | string | No | The CUSIP of an instrument. Requires Data add-ons subscription. |
| `order` | string ("asc" | "desc") | No | Sorting order for output. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Price adjustment mode. |
| `format` | string ("JSON" | "CSV") | No | Response format options. |
| `symbol` | string | No | Symbol ticker of the instrument (e.g., 'AAPL', 'EUR/USD', 'ETH/BTC'). Either symbol, isin, figi, or cusip must be provided. |
| `country` | string | No | The country where the instrument is traded (e.g., 'United States' or 'US'). |
| `ma_type` | string ("SMA" | "EMA" | "WMA" | "DEMA" | "TEMA" | "TRIMA" | "KAMA" | "MAMA" | "T3MA") | No | Moving average type. |
| `prepost` | boolean | No | Include pre-market and post-market data. Only for Pro+ plans at 1min, 5min, 15min, 30min intervals for US equities. |
| `end_date` | string | No | Ending date for data selection. See start_date description for format details. |
| `exchange` | string | No | Exchange where instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | Timezone for output datetime. Options: 'Exchange' (local), 'UTC', or IANA timezone name (e.g., 'America/New_York'). |
| `delimiter` | string | No | The separator used in CSV response data. |
| `outputsize` | integer | No | Number of data points to retrieve (range: 1-5000). Default 30 when no date parameters are set. |
| `start_date` | string | No | Starting date for data selection. Format: '2006-01-02' or '2006-01-02T15:04:05'. Can be used with or without end_date. |
| `fast_period` | integer | No | Number of periods for fast moving average (range: 1-800, default: 12). |
| `series_type` | string ("close" | "open" | "high" | "low" | "volume") | No | Price type for technical indicator calculation. |
| `slow_period` | integer | No | Number of periods for slow moving average (range: 1-800, default: 26). |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. |
| `previous_close` | boolean | No | Include the previous closing price in time_series data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Aroon Indicator

**Slug:** `TWELVE_DATA_GET_AROON`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | 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. |
| `date` | string | No | 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'. |
| `figi` | string | No | Financial Instrument Global Identifier (FIGI). |
| `isin` | string | No | International securities identification number (ISIN). |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | Committee on Uniform Securities Identification Procedures (CUSIP) identifier. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. |
| `format` | string | No | The format of the response data. |
| `symbol` | string | No | Symbol ticker of the instrument (e.g., 'AAPL', 'EUR/USD', 'ETH/BTC'). At least one of symbol, isin, figi, or cusip must be provided. |
| `country` | string | No | The country where the instrument is traded (e.g., 'United States' or 'US'). |
| `prepost` | boolean | No | 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. |
| `end_date` | string | No | End date for data selection in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS. |
| `exchange` | string | No | Exchange where instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | 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'). |
| `outputsize` | integer | No | Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set. |
| `start_date` | string | No | 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. |
| `time_period` | integer | No | Number of periods to average over. Takes values in the range from 1 to 800. Default is 14. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. |
| `previous_close` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Balance Sheet

**Slug:** `TWELVE_DATA_GET_BALANCE_SHEET`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Balance Sheet Consolidated

**Slug:** `TWELVE_DATA_GET_BALANCE_SHEET_CONSOLIDATED`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `figi` | string | No | Financial Instrument Global Identifier filter. |
| `isin` | string | No | International Securities Identification Number filter. |
| `cusip` | string | No | CUSIP filter. |
| `period` | string ("annual" | "quarterly") | No | Reporting period; supports 'annual' or 'quarterly'. Default is 'annual'. |
| `symbol` | string | No | Ticker symbol of the company (e.g., 'AAPL'). |
| `country` | string | No | Country where the instrument is traded (name or code). |
| `end_date` | string | No | Filter results with fiscal_date on or before this date (YYYY-MM-DD). |
| `exchange` | string | No | Exchange where the instrument is traded. |
| `mic_code` | string | No | ISO 10383 Market Identifier Code. |
| `outputsize` | integer | No | Number of periods to return; default is 6. |
| `start_date` | string | No | Filter results with fiscal_date on or after this date (YYYY-MM-DD). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bollinger Bands

**Slug:** `TWELVE_DATA_GET_BBANDS`

Tool to calculate Bollinger Bands (BBANDS) for a financial instrument. Returns upper band, lower band, and simple moving average (SMA) to assess market volatility and identify potential price reversals.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bonds

**Slug:** `TWELVE_DATA_GET_BONDS`

Tool to retrieve a daily updated list of available bonds (fixed income securities). Use when you need to fetch bonds with optional filtering by symbol, exchange, or country.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CCI

**Slug:** `TWELVE_DATA_GET_CCI`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | 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. |
| `date` | string | No | 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'. |
| `figi` | string | No | The FIGI of an instrument for which data is requested. Available starting with the Ultra plan. |
| `isin` | string | No | Filter by international securities identification number (ISIN). ISIN access is activated in the Data add-ons section. |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | The CUSIP of an instrument for which data is requested. CUSIP access is activated in the Data add-ons section. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. |
| `format` | string ("JSON" | "CSV") | No | The format of the response data. |
| `symbol` | string | No | Symbol ticker of the instrument (e.g., 'AAPL', 'EUR/USD', 'ETH/BTC'). Either symbol, isin, figi, or cusip must be provided. |
| `country` | string | No | The country where the instrument is traded, e.g., 'United States' or 'US'. |
| `prepost` | boolean | No | 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. |
| `end_date` | string | No | The ending date and time for data selection, see start_date description for details. |
| `exchange` | string | No | Exchange where instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | 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. |
| `delimiter` | string | No | The separator used in the CSV response data. |
| `outputsize` | integer | No | 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. |
| `start_date` | string | No | 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. |
| `time_period` | integer | No | Number of periods to average over. Takes values in the range from 1 to 800. Default is 20. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. |
| `previous_close` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Ceiling (CEIL)

**Slug:** `TWELVE_DATA_GET_CEIL`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. |
| `date` | string | No | Specifies exact date to get data for. Could be exact date (e.g., '2021-10-27') or in human language ('today' or 'yesterday'). |
| `figi` | string | No | Financial Instrument Global Identifier (FIGI) of the instrument. |
| `isin` | string | No | International Securities Identification Number (ISIN) of the instrument. |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | CUSIP identifier of the instrument. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. Default is 'desc'. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. Default is 'splits'. |
| `format` | string ("JSON" | "CSV") | No | The format of the response data. Default is 'JSON'. |
| `symbol` | string | No | Symbol ticker of the instrument (e.g., 'AAPL', 'EUR/USD', 'ETH/BTC'). At least one of symbol, isin, figi, or cusip must be provided. |
| `country` | string | No | Country where the instrument is traded (e.g., 'United States' or 'US'). |
| `prepost` | boolean | No | 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. |
| `end_date` | string | No | End date for data selection in format 'YYYY-MM-DD' or 'YYYY-MM-DDTHH:MM:SS'. See start_date for more details. |
| `exchange` | string | No | Exchange where the instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Time interval between two consecutive points in the time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | 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'). |
| `delimiter` | string | No | The separator used in the CSV response data. Default is ';'. |
| `outputsize` | integer | No | Number of data points to retrieve. Supports values from 1 to 5000. Default is 30 when no date parameters are set. |
| `start_date` | string | No | 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. |
| `series_type` | string ("close" | "open" | "high" | "low" | "volume") | No | Price type on which technical indicator is calculated. Default is 'close'. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. |
| `previous_close` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Chande Momentum Oscillator

**Slug:** `TWELVE_DATA_GET_CMO`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | 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. |
| `date` | string | No | 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` |
| `figi` | string | No | The FIGI of an instrument for which data is requested. This request parameter is available starting with the Ultra plan. |
| `isin` | string | No | Filter by international securities identification number (ISIN). ISIN access is activated in the Data add-ons section. |
| `type` | 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") | No | The asset class to which the instrument belongs |
| `cusip` | string | No | The CUSIP of an instrument for which data is requested. CUSIP access is activated in the Data add-ons section. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices |
| `format` | string ("JSON" | "CSV") | No | The format of the response data |
| `symbol` | string | No | Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ... |
| `country` | string | No | The country where the instrument is traded, e.g., `United States` or `US` |
| `prepost` | boolean | No | 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. |
| `end_date` | string | No | The ending date and time for data selection, see `start_date` description for details. |
| `exchange` | string | No | Exchange where instrument is traded |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard |
| `timezone` | string | No | 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. |
| `delimiter` | string | No | The separator used in the CSV response data |
| `outputsize` | integer | No | 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. |
| `start_date` | string | No | 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. |
| `series_type` | string ("close" | "open" | "high" | "low" | "volume") | No | Price type on which technical indicator is calculated |
| `time_period` | integer | No | Number of periods to average over. Takes values in the range from `1` to `800` |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output |
| `previous_close` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Detrended Price Oscillator

**Slug:** `TWELVE_DATA_GET_DPO`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Specifies the number of decimal places for floating values (0 to 11 inclusive). |
| `date` | string | No | Specifies the exact date to get data for (e.g., '2021-10-27', 'today', 'yesterday'). |
| `figi` | string | No | Financial Instrument Global Identifier (FIGI) for the instrument. |
| `isin` | string | No | International Securities Identification Number (ISIN) filter. |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | CUSIP identifier for the instrument. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. |
| `format` | string ("JSON" | "CSV") | No | The format of the response data. |
| `symbol` | string | No | Symbol ticker of the instrument (e.g., 'AAPL', 'EUR/USD', 'ETH/BTC'). |
| `country` | string | No | The country where the instrument is traded (e.g., 'United States' or 'US'). |
| `prepost` | boolean | No | Returns quotes including pre-market and post-market data (Pro plan and above, US equities only). |
| `centered` | boolean | No | Specifies if there should be a shift to match the current price. |
| `end_date` | string | No | Ending date and time for data selection in YYYY-MM-DD or ISO 8601 format. |
| `exchange` | string | No | Exchange where the instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | Timezone at which output datetime will be displayed (e.g., 'Exchange', 'UTC', 'America/New_York'). |
| `delimiter` | string | No | The separator used in the CSV response data. |
| `outputsize` | integer | No | Number of data points to retrieve (1 to 5000). Default 30 when no date parameters are set. |
| `start_date` | string | No | Starting date and time for data selection in YYYY-MM-DD or ISO 8601 format. |
| `series_type` | string ("close" | "open" | "high" | "low" | "volume") | No | Price type on which technical indicator is calculated. |
| `time_period` | integer | No | Number of periods to average over (1 to 800). |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. |
| `previous_close` | boolean | No | Include the previous closing price in the time_series data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Earliest Timestamp

**Slug:** `TWELVE_DATA_GET_EARLIEST_TIMESTAMP`

Tool to return the first available timestamp for a symbol and interval. Use after selecting instrument identifiers and interval to discover the earliest data point.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get End of Day Price

**Slug:** `TWELVE_DATA_GET_EOD`

Tool to retrieve end of day (EOD) closing price and metadata for a financial instrument. Use when you need daily historical data for stocks, ETFs, or other securities to track performance over time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Number of decimal places for floating values. Must be in range [0, 11] inclusive. |
| `date` | string | No | Specific date for EOD data in YYYY-MM-DD format. If not provided, returns most recent EOD data. |
| `figi` | string | No | Financial Instrument Global Identifier (FIGI). Available starting with the Ultra plan. |
| `isin` | string | No | International Securities Identification Number (ISIN). Must be activated in Data add-ons section. |
| `type` | 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") | No | Asset class types supported by the API. |
| `cusip` | string | No | CUSIP identifier of the instrument. Must be activated in Data add-ons section. |
| `symbol` | string | No | Ticker symbol of the instrument (e.g., 'AAPL'). |
| `country` | string | No | Country where the instrument is traded (name or alpha code, e.g., 'United States' or 'US'). |
| `prepost` | boolean | No | 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. |
| `exchange` | string | No | Exchange where the instrument is traded (e.g., 'NASDAQ'). |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard (e.g., 'XNAS'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Global ETF Performance

**Slug:** `TWELVE_DATA_GET_ETFS_WORLD_PERFORMANCE`

Tool to get global ETF performance metrics (trailing and annual returns). Use when you need detailed performance analytics for an ETF.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get exchange schedule

**Slug:** `TWELVE_DATA_GET_EXCHANGE_SCHEDULE`

Tool to get trading sessions and hours for exchanges. Use when you need pre-market, main, and post-market hours for a given exchange and date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Date for schedule. Format YYYY-MM-DD, keywords 'today' or 'yesterday', or full UTC datetime (e.g., '2025-04-11 20:00:00'). |
| `country` | string | No | Filter by country name or alpha code (e.g., 'United States' or 'US'). |
| `mic_code` | string | No | Filter by ISO 10383 MIC code (e.g., 'XNGS'). |
| `mic_name` | string | No | Filter by exchange name (e.g., 'NASDAQ'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fund Holders

**Slug:** `TWELVE_DATA_GET_FUND_HOLDERS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `figi` | string | No | Filter by financial instrument global identifier (FIGI). Available starting with the Ultra plan. Required if other identifiers are not provided. |
| `isin` | string | No | Filter by international securities identification number (ISIN). ISIN access is activated in the Data add-ons section. Required if other identifiers are not provided. |
| `cusip` | string | No | 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. |
| `symbol` | string | No | Symbol ticker of instrument. For preferred stocks use dot(.) delimiter (e.g., 'BRK.A' or 'BRK.B'). Required if other identifiers are not provided. |
| `country` | string | No | Country where instrument is traded (e.g., 'United States' or 'US'). |
| `exchange` | string | No | Exchange where instrument is traded. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Funds

**Slug:** `TWELVE_DATA_GET_FUNDS`

Tool 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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Heikin Ashi Candles

**Slug:** `TWELVE_DATA_GET_HEIKINASHI_CANDLES`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Number of decimal places for floating values (0-11). Default is automatically determined. |
| `date` | string | No | Exact date to get data for. Format: 'YYYY-MM-DD' or human language like 'today' or 'yesterday'. |
| `figi` | string | No | Financial Instrument Global Identifier (FIGI). Available starting with the Ultra plan. |
| `isin` | string | No | International Securities Identification Number (ISIN). Requires Data add-ons activation. |
| `type` | 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") | No | Asset class of the instrument |
| `cusip` | string | No | Committee on Uniform Securities Identification Procedures (CUSIP). Requires Data add-ons activation. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices |
| `format` | string ("JSON" | "CSV") | No | Format of the response data |
| `symbol` | string | No | Symbol ticker of the instrument (e.g., 'AAPL', 'EUR/USD', 'ETH/BTC'). Must provide either symbol, isin, figi, or cusip. |
| `country` | string | No | Country where the instrument is traded (e.g., 'United States' or 'US'). |
| `prepost` | boolean | No | Include pre-market and post-market data. Only for Pro+ plans at 1min, 5min, 15min, 30min intervals for US equities. |
| `end_date` | string | No | End date for data selection in format 'YYYY-MM-DD' or 'YYYY-MM-DDTHH:MM:SS'. See start_date description for details. |
| `exchange` | string | No | Exchange where the instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Time interval between consecutive data points. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | 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'. |
| `delimiter` | string | No | Separator used in CSV response data. Default is ';'. |
| `outputsize` | integer | No | Number of data points to retrieve (1-5000). Default is 30 when no date parameters are set. |
| `start_date` | string | No | Start date for data selection in format 'YYYY-MM-DD' or 'YYYY-MM-DDTHH:MM:SS'. Can be used separately or with end_date. |
| `include_ohlc` | boolean | No | Include OHLC (Open, High, Low, Close) values in the output. Default is false. |
| `previous_close` | boolean | No | Include the previous closing price in the time series data. If true, adds previous bar close price to current object. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get HLC3 Average

**Slug:** `TWELVE_DATA_GET_HLC3`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Number of decimal places for floating values. Range: 0-11. Default is automatic. |
| `date` | string | No | Specific date to get data for. Can be exact date (e.g., '2021-10-27'), or human language ('today', 'yesterday'). |
| `figi` | string | No | Financial Instrument Global Identifier (FIGI) of the instrument (e.g., 'BBG000B9Y5X2'). Available with Ultra plan and above. |
| `isin` | string | No | International Securities Identification Number (ISIN) of the instrument (e.g., 'US0378331005'). Requires Data add-ons activation. |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | CUSIP identifier of the instrument (e.g., '594918104'). Requires Data add-ons activation. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output data. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Price adjusting mode. |
| `format` | string ("JSON" | "CSV") | No | Response data format. |
| `symbol` | string | No | Symbol ticker of the instrument (e.g., 'AAPL', 'EUR/USD', 'ETH/BTC'). At least one of symbol, isin, figi, or cusip must be provided. |
| `country` | string | No | Country where the instrument is traded (e.g., 'United States' or 'US'). |
| `prepost` | boolean | No | Include pre-market and post-market data. Only for Pro+ plans at 1min, 5min, 15min, 30min intervals for US equities. |
| `end_date` | string | No | End date for data selection in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS. See start_date for timezone handling details. |
| `exchange` | string | No | Exchange where the instrument is traded (e.g., 'NASDAQ'). |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Time interval between consecutive data points in the time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard (e.g., 'XNAS'). |
| `timezone` | string | No | Timezone for output datetime display. Supports 'Exchange' (local), 'UTC', or IANA timezone names (e.g., 'America/New_York', 'Asia/Singapore'). |
| `delimiter` | string | No | Separator used in CSV response data. |
| `outputsize` | integer | No | Number of data points to retrieve. Default is 30 when no date parameters are set, otherwise maximum. Range: 1-5000. |
| `start_date` | string | No | Start date for data selection in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS. Can be used with or without end_date. |
| `include_ohlc` | boolean | No | Include OHLC (Open, High, Low, Close) values in the output. |
| `previous_close` | boolean | No | Include previous closing price in the time series data. Adds previous bar close to current object. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Hilbert Transform Sine Wave

**Slug:** `TWELVE_DATA_GET_HT_SINE`

Tool to fetch Hilbert Transform Sine Wave (HT_SINE) data for an instrument. The HT_SINE provides sine and cosine wave components derived from the dominant market cycle, helping traders pinpoint potential market turning points and assess trend directions by analyzing cyclical patterns. Use when analyzing market cycles for a specific symbol and interval.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. |
| `date` | string | No | 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'. |
| `figi` | string | No | Financial Instrument Global Identifier (FIGI). One of symbol, isin, figi, or cusip must be provided. |
| `isin` | string | No | International securities identification number (ISIN). One of symbol, isin, figi, or cusip must be provided. |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | CUSIP identifier of the instrument. One of symbol, isin, figi, or cusip must be provided. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. |
| `format` | string ("JSON" | "CSV") | No | The format of the response data. |
| `symbol` | string | No | Symbol ticker of the instrument (e.g., 'AAPL', 'EUR/USD', 'ETH/BTC'). One of symbol, isin, figi, or cusip must be provided. |
| `country` | string | No | The country where the instrument is traded (e.g., 'United States' or 'US'). |
| `prepost` | boolean | No | 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. |
| `end_date` | string | No | End date for data selection in format '2006-01-02' or '2006-01-02T15:04:05'. See start_date description for details. |
| `exchange` | string | No | Exchange where instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | 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'). |
| `delimiter` | string | No | The separator used in the CSV response data. |
| `outputsize` | integer | No | Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set. |
| `start_date` | string | No | Start date for data selection in format '2006-01-02' or '2006-01-02T15:04:05'. Can be used separately or with end_date. |
| `series_type` | string ("close" | "open" | "high" | "low" | "volume") | No | Price type on which technical indicator is calculated. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. |
| `previous_close` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Ichimoku Cloud Indicator

**Slug:** `TWELVE_DATA_GET_ICHIMOKU`

Tool 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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Income Statement

**Slug:** `TWELVE_DATA_GET_INCOME_STATEMENT`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Insider Transactions

**Slug:** `TWELVE_DATA_GET_INSIDER_TRANSACTIONS`

REQUIRES 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | No | Type of the instrument (e.g., 'Common Stock'). |
| `symbol` | string | Yes | Ticker symbol of the company (e.g., 'AAPL'). |
| `country` | string | No | Country name or two-letter ISO code where the instrument trades (e.g., 'US', 'United States'). |
| `exchange` | string | No | Exchange where the instrument is traded (e.g., 'NASDAQ'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Available Intervals

**Slug:** `TWELVE_DATA_GET_INTERVALS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Keltner Channel

**Slug:** `TWELVE_DATA_GET_KELTNER`

Tool to retrieve Keltner Channel indicator data for volatility-based technical analysis. Use when you need to identify potential overbought/oversold conditions, assess trend direction, or analyze price volatility using the combination of Exponential Moving Average (EMA) and Average True Range (ATR).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Specifies the number of decimal places for floating values. Range [0, 11]. |
| `date` | string | No | Specifies exact date to get data for. E.g. '2021-10-27', 'today', or 'yesterday'. |
| `figi` | string | No | The FIGI of an instrument for which data is requested. |
| `isin` | string | No | Filter by international securities identification number (ISIN). |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | The CUSIP of an instrument for which data is requested. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. |
| `format` | string | No | The format of the response data. |
| `symbol` | string | No | Symbol ticker of the instrument. E.g. 'AAPL', 'EUR/USD', 'ETH/BTC'. |
| `country` | string | No | The country where the instrument is traded, e.g., 'United States' or 'US'. |
| `ma_type` | string ("SMA" | "EMA" | "WMA" | "DEMA" | "TEMA" | "TRIMA" | "KAMA" | "MAMA" | "T3MA") | No | The type of moving average used. |
| `prepost` | boolean | No | Returns quotes including pre-market and post-market data. Only for Pro+ plans. |
| `end_date` | string | No | Ending date for data selection. Format: '2006-01-02' or '2006-01-02T15:04:05'. |
| `exchange` | string | No | Exchange where instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "8h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | Timezone at which output datetime will be displayed. Supports 'Exchange', 'UTC', or IANA timezone name. |
| `delimiter` | string | No | The separator used in the CSV response data. |
| `multiplier` | integer | No | The factor used to adjust the indicator's sensitivity. |
| `outputsize` | integer | No | Number of data points to retrieve. Default 30 when no date parameters are set. |
| `start_date` | string | No | Starting date for data selection. Format: '2006-01-02' or '2006-01-02T15:04:05'. |
| `series_type` | string ("close" | "open" | "high" | "low" | "volume") | No | Price type on which technical indicator is calculated. |
| `time_period` | integer | No | Number of periods to average over. Takes values in the range from 1 to 800. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. |
| `previous_close` | boolean | No | Include the previous closing price in the time_series data. |
| `atr_time_period` | integer | No | The time period used for calculating the Average True Range. Range from 1 to 800. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Key Executives

**Slug:** `TWELVE_DATA_GET_KEY_EXECUTIVES`

REQUIRES 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. This endpoint costs 1000 credits per request and is only available to Ultra/Enterprise subscribers - requests with lower-tier API keys will fail.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `figi` | string | No | Financial Instrument Global Identifier (FIGI). |
| `isin` | string | No | International Securities Identification Number (ISIN). |
| `cusip` | string | No | CUSIP code of the instrument. |
| `symbol` | string | No | Ticker symbol of the instrument (e.g., 'AAPL'). |
| `country` | string | No | Country name or ISO code where the instrument trades (e.g., 'US'). |
| `exchange` | string | No | Exchange where the instrument is traded (e.g., 'NASDAQ'). |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 (e.g., 'XNAS'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Last Change

**Slug:** `TWELVE_DATA_GET_LAST_CHANGE`

Tool to retrieve the latest update timestamps for a fundamentals dataset. Use when checking recent changes (e.g., dividends, splits).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (default 1). |
| `symbol` | string | No | Filter by symbol (e.g., 'AAPL'). |
| `country` | string | No | Filter by country name or code (e.g., 'United States' or 'US'). |
| `endpoint` | 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") | Yes | The fundamentals dataset to check for last changes. |
| `exchange` | string | No | Filter by exchange (e.g., 'NASDAQ'). |
| `mic_code` | string | No | Filter by MIC code (ISO 10383), e.g., 'XNAS'. |
| `outputsize` | integer | No | Number of records per page (default 30). |
| `start_date` | string | No | Start date/time filter (inclusive) in 'YYYY-MM-DD HH:MM:SS' format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Linear Regression Angle

**Slug:** `TWELVE_DATA_GET_LINEARREGANGLE`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, determined automatically. |
| `date` | string | No | 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'. |
| `figi` | string | No | Financial Instrument Global Identifier (FIGI) of the instrument. |
| `isin` | string | No | International Securities Identification Number (ISIN) of the instrument. |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | CUSIP identifier of the instrument. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. Default is 'desc'. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. Default is 'splits'. |
| `format` | string | No | The format of the response data. Default is 'JSON'. |
| `symbol` | string | No | Symbol ticker of the instrument (e.g., 'AAPL', 'EUR/USD', 'ETH/BTC'). |
| `country` | string | No | The country where the instrument is traded (e.g., 'United States' or 'US'). |
| `prepost` | boolean | No | 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. |
| `end_date` | string | No | End date for data selection in format 2006-01-02 or 2006-01-02T15:04:05. See start_date for details. |
| `exchange` | string | No | Exchange where the instrument is traded (e.g., 'NASDAQ'). |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Time interval between consecutive data points in the time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | 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'). |
| `delimiter` | string | No | The separator used in the CSV response data. Default is ';'. |
| `outputsize` | integer | No | Number of data points to retrieve. Supports values from 1 to 5000. Default is 30 when no date parameters are set. |
| `start_date` | string | No | 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. |
| `series_type` | string ("close" | "open" | "high" | "low" | "volume") | No | Price type on which technical indicator is calculated. Default is 'close'. |
| `time_period` | integer | No | Number of periods to average over. Takes values in the range from 1 to 800. Default is 9. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. Default is false. |
| `previous_close` | boolean | No | If true, adds previous bar close price value to the current object. Default is false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Linear Regression Intercept

**Slug:** `TWELVE_DATA_GET_LINEAR_REG_INTERCEPT`

Tool to calculate the y-intercept of a linear regression line for a given dataset. Returns the value where the regression line crosses the y-axis over a specified period.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Linear Regression Slope

**Slug:** `TWELVE_DATA_GET_LINEAR_REGSLOPE`

Tool to calculate the linear regression slope for a given dataset over a specified period. Returns the slope of a linear regression line, reflecting the rate of change in the data trend. Use when you need to assess the direction and strength of a trend in financial time series data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, determined automatically. |
| `date` | string | No | Specifies the exact date to get data for. Could be exact date (e.g., '2021-10-27'), or human language ('today' or 'yesterday'). |
| `figi` | string | No | FIGI of an instrument for which data is requested. At least one identifier is required. |
| `isin` | string | No | International securities identification number (ISIN). At least one identifier is required. |
| `type` | 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") | No | Asset class types. |
| `cusip` | string | No | CUSIP of an instrument for which data is requested. At least one identifier is required. |
| `order` | string ("asc" | "desc") | No | Sorting order options. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Price adjustment options. |
| `format` | string ("JSON" | "CSV") | No | Response format options. |
| `symbol` | string | No | Symbol ticker of the instrument (e.g., 'AAPL', 'EUR/USD', 'ETH/BTC'). At least one identifier (symbol, isin, figi, or cusip) is required. |
| `country` | string | No | The country where the instrument is traded (e.g., 'United States' or 'US'). |
| `prepost` | boolean | No | 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. |
| `end_date` | string | No | Ending date for data selection. Format: '2006-01-02' or '2006-01-02T15:04:05'. See start_date for usage details. |
| `exchange` | string | No | Exchange where instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. Required parameter. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | 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'. |
| `delimiter` | string | No | The separator used in the CSV response data. Default is ';'. |
| `outputsize` | integer | No | Number of data points to retrieve. Supports values in the range from 1 to 5000. Default is 30 when no date parameters are set. |
| `start_date` | string | No | Starting date for data selection. Format: '2006-01-02' or '2006-01-02T15:04:05'. Can be used separately or together with end_date. |
| `series_type` | string ("close" | "open" | "high" | "low" | "volume") | No | Price type for calculation. |
| `time_period` | integer | No | Number of periods to average over. Takes values in the range from 1 to 800. Default is 9. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. Default is false. |
| `previous_close` | boolean | No | Include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Base-10 Logarithm (LOG10)

**Slug:** `TWELVE_DATA_GET_LOG10`

Tool to compute the base-10 logarithm (LOG10) of a specified input value. Returns the power to which 10 must be raised to obtain the input value. Use when you need to transform data into a logarithmic scale for analyzing exponential growth patterns or compressing large ranges of financial data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | 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. |
| `date` | string | No | 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'. |
| `figi` | string | No | The FIGI of an instrument for which data is requested. |
| `isin` | string | No | Filter by international securities identification number (ISIN). |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | The CUSIP of an instrument for which data is requested. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. |
| `format` | string ("JSON" | "CSV") | No | The format of the response data. |
| `symbol` | string | No | Symbol ticker of the instrument (e.g., 'AAPL', 'EUR/USD', 'ETH/BTC'). |
| `country` | string | No | The country where the instrument is traded (e.g., 'United States' or 'US'). |
| `prepost` | boolean | No | 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. |
| `end_date` | string | No | Ending date for data selection in format '2006-01-02' or '2006-01-02T15:04:05'. |
| `exchange` | string | No | Exchange where instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Time interval between two consecutive points in time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | 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'). |
| `delimiter` | string | No | The separator used in the CSV response data. |
| `outputsize` | integer | No | Number of data points to retrieve. Supports values from 1 to 5000. Default is 30 when no date parameters are set. |
| `start_date` | string | No | 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. |
| `series_type` | string ("close" | "open" | "high" | "low" | "volume") | No | Price type on which technical indicator is calculated. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. |
| `previous_close` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Logo

**Slug:** `TWELVE_DATA_GET_LOGO`

Tool to retrieve official logo URLs for a symbol. Use when displaying company, crypto, or forex pair logos in UIs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | Ticker or pair identifier (e.g., 'AAPL', 'BTC/USD', 'EUR/USD'). |
| `country` | string | No | Country name or ISO alpha code (e.g., 'United States' or 'US'). |
| `exchange` | string | No | Exchange name to narrow lookup (e.g., 'NASDAQ', 'NSE'). |
| `mic_code` | string | No | Market Identifier Code (ISO 10383) (e.g., 'XNAS', 'XLON'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get MACD

**Slug:** `TWELVE_DATA_GET_MACD`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. |
| `date` | string | No | 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'. |
| `figi` | string | No | The FIGI of an instrument for which data is requested. |
| `isin` | string | No | Filter by international securities identification number (ISIN). |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | The CUSIP of an instrument for which data is requested. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. |
| `format` | string ("JSON" | "CSV") | No | The format of the response data. |
| `symbol` | string | No | Symbol ticker of the instrument (e.g., 'AAPL', 'EUR/USD', 'ETH/BTC'). At least one of symbol, isin, figi, or cusip must be provided. |
| `country` | string | No | The country where the instrument is traded (e.g., 'United States' or 'US'). |
| `prepost` | boolean | No | 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. |
| `end_date` | string | No | End date for data selection. Format: '2006-01-02' or '2006-01-02T15:04:05'. See start_date for more details. |
| `exchange` | string | No | Exchange where instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | 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'). |
| `delimiter` | string | No | The separator used in the CSV response data. |
| `outputsize` | integer | No | Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set. |
| `start_date` | string | No | Start date for data selection. Format: '2006-01-02' or '2006-01-02T15:04:05'. Can be used separately or together with end_date. |
| `fast_period` | integer | No | Number of periods for fast moving average. Takes values in the range from 1 to 800. |
| `series_type` | string ("close" | "open" | "high" | "low" | "volume") | No | Price type on which technical indicator is calculated. |
| `slow_period` | integer | No | Number of periods for slow moving average. Takes values in the range from 1 to 800. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. |
| `signal_period` | integer | No | The time period used for generating the signal line. |
| `previous_close` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get MAMA

**Slug:** `TWELVE_DATA_GET_MAMA`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Number of decimal places for floating values. Range 0-11. Default is automatic. |
| `date` | string | No | Specific date to get data for. Can be exact date (e.g., '2021-10-27'), 'today', or 'yesterday'. |
| `figi` | string | No | Financial Instrument Global Identifier (FIGI) of the instrument. |
| `isin` | string | No | International Securities Identification Number (ISIN) of the instrument. |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | CUSIP identifier of the instrument. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output data. Default is 'desc'. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Price adjusting mode. Default is 'splits'. |
| `format` | string ("JSON" | "CSV") | No | Response format. Default is JSON. |
| `symbol` | string | No | Symbol ticker of the instrument (e.g., 'AAPL', 'EUR/USD', 'ETH/BTC'). |
| `country` | string | No | Country where the instrument is traded (e.g., 'United States' or 'US'). |
| `prepost` | boolean | No | Include pre-market and post-market data. Only for Pro plans and above at specific intervals for US equities. |
| `end_date` | string | No | Ending date for data selection in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS. |
| `exchange` | string | No | Exchange where the instrument is traded (e.g., 'NASDAQ'). |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Time interval between consecutive data points. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard (e.g., 'XNAS'). |
| `timezone` | string | No | Timezone for output datetime display. Supports 'Exchange' for local time, 'UTC', or IANA timezone names (e.g., 'America/New_York'). |
| `delimiter` | string | No | Separator used in CSV response data. Default is semicolon (;). |
| `fast_limit` | number | No | The limit for the fast moving average. Default is 0.5. |
| `outputsize` | integer | No | Number of data points to retrieve. Supports values from 1 to 5000. Default is 30. |
| `slow_limit` | number | No | The limit for the slow moving average. Default is 0.05. |
| `start_date` | string | No | Starting date for data selection in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS. |
| `series_type` | string ("close" | "open" | "high" | "low" | "volume") | No | Price type on which the technical indicator is calculated. Default is 'close'. |
| `include_ohlc` | boolean | No | Specify if OHLC (Open, High, Low, Close) values should be included in the output. Default is false. |
| `previous_close` | boolean | No | Include previous closing price in time_series data. Default is false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Market Movers

**Slug:** `TWELVE_DATA_GET_MARKET_MOVERS`

Tool to retrieve a snapshot of top gainers or losers for a specified market. Use when you need to quickly see market movers after choosing a market type.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Market State

**Slug:** `TWELVE_DATA_GET_MARKET_STATE`

Tool to report current open/closed status for exchanges. Use when you need real-time market status updates after selecting exchanges.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Exchange MIC code (e.g., 'XNYS'). |
| `country` | string | No | Country name or alpha code (e.g., 'US' or 'United States'). |
| `exchange` | string | No | Exchange name (e.g., 'NYSE'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Maximum Value

**Slug:** `TWELVE_DATA_GET_MAX`

Tool to calculate and return the highest value within a specified data series over a given period. Use when identifying potential resistance levels or detecting extreme price movements in financial data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default (-1), automatically determined based on values. |
| `date` | string | No | 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'. |
| `figi` | string | No | The FIGI of an instrument for which data is requested. Available starting with Ultra plan. |
| `isin` | string | No | International securities identification number (ISIN). Requires ISIN add-on activation. |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | The CUSIP of an instrument for which data is requested. Requires CUSIP add-on activation. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. |
| `format` | string ("JSON" | "CSV") | No | The format of the response data. |
| `symbol` | string | No | Symbol ticker of the instrument. E.g. 'AAPL', 'EUR/USD', 'ETH/BTC'. At least one of symbol, isin, figi, or cusip must be provided. |
| `country` | string | No | The country where the instrument is traded, e.g., 'United States' or 'US'. |
| `prepost` | boolean | No | 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. |
| `end_date` | string | No | End date for data selection in format '2006-01-02' or '2006-01-02T15:04:05'. See start_date description for timezone handling details. |
| `exchange` | string | No | Exchange where instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | 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. |
| `delimiter` | string | No | The separator used in the CSV response data. |
| `outputsize` | integer | No | Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set. |
| `start_date` | string | No | 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. |
| `series_type` | string ("close" | "open" | "high" | "low" | "volume") | No | Price type on which technical indicator is calculated. |
| `time_period` | integer | No | Number of periods to average over. Takes values in the range from 1 to 800. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. |
| `previous_close` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get McGinley Dynamic Indicator

**Slug:** `TWELVE_DATA_GET_MC_GINLEY_DYNAMIC`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | 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. |
| `date` | string | No | 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'. |
| `figi` | string | No | Financial Instrument Global Identifier (FIGI). Available starting with Ultra plan. |
| `isin` | string | No | International securities identification number (ISIN). Requires Data add-ons subscription. |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | CUSIP identifier for the instrument. Requires Data add-ons subscription. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. |
| `format` | string ("JSON" | "CSV") | No | The format of the response data. |
| `symbol` | string | No | Symbol ticker of the instrument. E.g. 'AAPL', 'EUR/USD', 'ETH/BTC'. At least one of symbol, isin, figi, or cusip must be provided. |
| `country` | string | No | The country where the instrument is traded, e.g., 'United States' or 'US'. |
| `prepost` | boolean | No | 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. |
| `end_date` | string | No | End date for data selection. Format: '2006-01-02' or '2006-01-02T15:04:05'. See start_date description for details. |
| `exchange` | string | No | Exchange where instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | 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'). |
| `delimiter` | string | No | The separator used in the CSV response data. |
| `outputsize` | integer | No | 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. |
| `start_date` | string | No | 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. |
| `time_period` | integer | No | Number of periods to average over. Takes values in the range from 1 to 800. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. |
| `previous_close` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Median Price

**Slug:** `TWELVE_DATA_GET_MEDPRICE`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Number of decimal places for floating values. Range [0, 11]. Default is automatically determined. |
| `date` | string | No | Specifies exact date for data retrieval. Can be exact date like '2021-10-27', or human language like 'today' or 'yesterday'. |
| `figi` | string | No | Financial Instrument Global Identifier (FIGI) of the instrument. Available with Ultra plan or higher. |
| `isin` | string | No | International Securities Identification Number (ISIN) of the instrument. ISIN access requires activation in Data add-ons. |
| `type` | 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") | No | Asset class types supported by Twelve Data API. |
| `cusip` | string | No | CUSIP identifier of the instrument. CUSIP access requires activation in Data add-ons. |
| `order` | string ("asc" | "desc") | No | Sorting order for output data. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Price adjustment modes. |
| `format` | string ("JSON" | "CSV") | No | Response format options. |
| `symbol` | string | No | Symbol ticker of the instrument. At least one of symbol, isin, figi, or cusip must be provided. E.g. 'AAPL', 'EUR/USD', 'ETH/BTC'. |
| `country` | string | No | Country where the instrument is traded, e.g., 'United States' or 'US'. |
| `prepost` | boolean | No | Include pre-market and post-market data. Only for Pro and above plans. Available at 1min, 5min, 15min, and 30min intervals for US equities. |
| `end_date` | string | No | End date for data selection. Format and behavior same as start_date. |
| `exchange` | string | No | Exchange where the instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Time interval between consecutive data points. Required parameter. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | 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'. |
| `delimiter` | string | No | Separator used in CSV response data. Default is ';'. |
| `outputsize` | integer | No | Number of data points to retrieve. Supports values from 1 to 5000. Default is 30 when no date parameters are set. |
| `start_date` | string | No | 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. |
| `include_ohlc` | boolean | No | Specify if OHLC (Open, High, Low, Close) values should be added in the output. |
| `previous_close` | boolean | No | Include previous closing price in the time series data. If true, adds previous bar close price to current object. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Minus Directional Indicator

**Slug:** `TWELVE_DATA_GET_MINUS_DI`

Tool to calculate and return the Minus Directional Indicator (MINUS_DI) for a security. Use when analyzing bearish trends and assessing downward price movement strength.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. |
| `date` | string | No | Specifies the exact date to get data for. Could be exact date (e.g., '2021-10-27'), 'today', or 'yesterday'. |
| `figi` | string | No | Financial Instrument Global Identifier (FIGI) of the instrument. |
| `isin` | string | No | International Securities Identification Number (ISIN) of the instrument. |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | CUSIP identifier of the instrument. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. |
| `format` | string ("JSON" | "CSV") | No | The format of the response data. |
| `symbol` | string | No | Symbol ticker of the instrument (e.g., 'AAPL', 'EUR/USD', 'ETH/BTC'). |
| `country` | string | No | Country where the instrument is traded (e.g., 'United States' or 'US'). |
| `prepost` | boolean | No | Include pre-market and post-market data. Only for Pro and above plans. Available at 1min, 5min, 15min, and 30min intervals for US equities. |
| `end_date` | string | No | Ending date and time for data selection. Format: '2006-01-02' or '2006-01-02T15:04:05'. |
| `exchange` | string | No | Exchange where the instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | Timezone for output datetime display. Supports 'Exchange', 'UTC', or IANA timezone names (e.g., 'America/New_York'). |
| `delimiter` | string | No | The separator used in the CSV response data. |
| `outputsize` | integer | No | Number of data points to retrieve. Supports values from 1 to 5000. Default is 30 when no date parameters are set. |
| `start_date` | string | No | Starting date and time for data selection. Format: '2006-01-02' or '2006-01-02T15:04:05'. |
| `time_period` | integer | No | Number of periods to average over. Takes values in the range from 1 to 800. |
| `include_ohlc` | boolean | No | Specify if OHLC (Open, High, Low, Close) values should be added in the output. |
| `previous_close` | boolean | No | Include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Global Mutual Fund Performance

**Slug:** `TWELVE_DATA_GET_MUTUAL_FUNDS_WORLD_PERFORMANCE`

Tool to get global mutual fund performance metrics (trailing, annual, quarterly, load-adjusted returns). Use when you need detailed performance analytics for a mutual fund.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mutual Funds World Risk

**Slug:** `TWELVE_DATA_GET_MUTUAL_FUNDS_WORLD_RISK`

Tool to fetch global mutual fund risk metrics. Use when you need detailed risk analytics (standard deviation, beta, Sharpe ratio) for a specific mutual fund identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Decimal places for floating values. Must be between 0 and 11. Default is 5. |
| `figi` | string | No | Financial Instrument Global Identifier (FIGI). Required if other identifiers are not provided. |
| `isin` | string | No | International Securities Identification Number (ISIN). Required if other identifiers are not provided. |
| `cusip` | string | No | CUSIP identifier. Required if other identifiers are not provided. |
| `symbol` | string | No | Mutual fund symbol. Required if other identifiers are not provided. |
| `country` | string | No | Country name or alpha code (e.g., 'United States' or 'US'). Required if other identifiers are not provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Global Mutual Fund Summary

**Slug:** `TWELVE_DATA_GET_MUTUAL_FUNDS_WORLD_SUMMARY`

Tool to retrieve a global mutual fund summary snapshot. Use when you need a high-level overview of a fund’s key identifiers and attributes.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Global Mutual Fund Sustainability

**Slug:** `TWELVE_DATA_GET_MUTUAL_FUNDS_WORLD_SUSTAINABILITY`

Tool to get global mutual fund sustainability and ESG metrics. Use when you need fund ESG scores and pillar breakdowns.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Plus Directional Indicator

**Slug:** `TWELVE_DATA_GET_PLUS_DI`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | 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. |
| `date` | string | No | 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'). |
| `figi` | string | No | Financial Instrument Global Identifier (FIGI). Available starting with the Ultra plan. |
| `isin` | string | No | International Securities Identification Number (ISIN). ISIN access is activated in the Data add-ons section. |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | CUSIP identifier. CUSIP access is activated in the Data add-ons section. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. Default is 'desc'. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. Default is 'splits'. |
| `format` | string ("JSON" | "CSV") | No | The format of the response data. Default is 'JSON'. |
| `symbol` | string | No | Symbol ticker of the instrument (e.g., 'AAPL', 'EUR/USD', 'ETH/BTC'). At least one of symbol, isin, figi, or cusip must be provided. |
| `country` | string | No | The country where the instrument is traded (e.g., 'United States' or 'US'). |
| `prepost` | boolean | No | 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. |
| `end_date` | string | No | End date for data selection. Format: '2006-01-02' or '2006-01-02T15:04:05'. See start_date description for details. |
| `exchange` | string | No | Exchange where instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | 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. |
| `delimiter` | string | No | The separator used in the CSV response data. Default is ';'. |
| `outputsize` | integer | No | 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. |
| `start_date` | string | No | 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. |
| `time_period` | integer | No | Number of periods to average over. Takes values in the range from 1 to 800. Default is 9. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. Default is false. |
| `previous_close` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Price

**Slug:** `TWELVE_DATA_GET_PRICE`

Tool to retrieve the latest market price for a specified financial instrument. Use when you need to get the current price after identifying a symbol.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Specifies the number of decimal places for floating values. Should be in range [0,11] inclusive. Default is 5. |
| `figi` | string | No | Filter by financial instrument global identifier (FIGI). Available starting with the Ultra plan. |
| `isin` | string | No | Filter by international securities identification number (ISIN). ISIN access is activated in the Data add-ons section. |
| `type` | 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") | No | Asset class types supported by Twelve Data API. |
| `cusip` | string | No | The CUSIP of an instrument for which data is requested. CUSIP access is activated in the Data add-ons section. |
| `format` | string ("JSON" | "CSV") | No | Response format options. |
| `symbol` | string | No | Symbol ticker of the instrument (e.g., 'AAPL', 'MSFT'). At least one of symbol, figi, isin, or cusip must be provided. |
| `country` | string | No | Country where instrument is traded, e.g., 'United States' or 'US'. |
| `prepost` | boolean | No | Include pre-market and post-market data. Only for Pro and above plans. Available at 1min, 5min, 15min, and 30min intervals for US equities. |
| `exchange` | string | No | Exchange where instrument is traded (e.g., 'NASDAQ', 'NYSE'). |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `delimiter` | string | No | Specify the delimiter used when downloading the CSV file (default is ';'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Price Target

**Slug:** `TWELVE_DATA_GET_PRICE_TARGET`

Tool to fetch analysts' price target dataset for equities. Use when you need the latest and historical price forecasts for a symbol.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | Equity ticker symbol to fetch price target data for (e.g., 'AAPL'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Profile

**Slug:** `TWELVE_DATA_GET_PROFILE`

Tool to retrieve company profile. Use when you need company details like industry, sector, and identifiers after selecting a symbol.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `figi` | string | No | Financial Instrument Global Identifier. Provide one of symbol, figi, isin, or cusip. |
| `isin` | string | No | International Securities Identification Number. Provide one of symbol, figi, isin, or cusip. |
| `cusip` | string | No | CUSIP identifier. Provide one of symbol, figi, isin, or cusip. |
| `symbol` | string | No | Ticker symbol to query (e.g., 'AAPL'). Provide one of symbol, figi, isin, or cusip. |
| `country` | string | No | Country where the instrument is traded (name or alpha code, e.g., 'United States' or 'US'). |
| `exchange` | string | No | Exchange where the instrument is traded (e.g., 'NASDAQ'). |
| `mic_code` | string | No | Market Identifier Code (ISO 10383) for the exchange (e.g., 'XNAS'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Recommendations

**Slug:** `TWELVE_DATA_GET_RECOMMENDATIONS`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | Ticker symbol of the stock (e.g., 'AAPL', 'MSFT', 'GOOGL'). Must be a valid stock symbol traded on a supported exchange. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Rate of Change (ROC)

**Slug:** `TWELVE_DATA_GET_ROC`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Specifies the number of decimal places for floating values. Range [0, 11]. By default, automatically determined. |
| `date` | string | No | Specifies the exact date to get the data for. Could be exact date (e.g., '2021-10-27'), 'today', or 'yesterday'. |
| `figi` | string | No | Financial Instrument Global Identifier (FIGI). Available starting with the Ultra plan. |
| `isin` | string | No | International Securities Identification Number (ISIN). Requires Data add-ons activation. |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | CUSIP identifier. Requires Data add-ons activation. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. |
| `format` | string ("JSON" | "CSV") | No | The format of the response data. |
| `symbol` | string | No | Symbol ticker of the instrument (e.g., 'AAPL', 'EUR/USD', 'ETH/BTC'). At least one of symbol, isin, figi, or cusip must be provided. |
| `country` | string | No | The country where the instrument is traded (e.g., 'United States' or 'US'). |
| `prepost` | boolean | No | 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. |
| `end_date` | string | No | Ending date for data selection. Format: '2006-01-02' or '2006-01-02T15:04:05'. See start_date for details. |
| `exchange` | string | No | Exchange where instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | 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'). |
| `delimiter` | string | No | The separator used in the CSV response data. |
| `outputsize` | integer | No | Number of data points to retrieve. Default 30 when no date parameters are set, otherwise set to maximum. Leave unset to use API defaults. |
| `start_date` | string | No | Starting date for data selection. Format: '2006-01-02' or '2006-01-02T15:04:05'. Can be used separately or together with end_date. |
| `series_type` | string ("close" | "open" | "high" | "low" | "volume") | No | Price type on which technical indicator is calculated. |
| `time_period` | integer | No | Number of periods to average over. Takes values in the range from 1 to 800. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. |
| `previous_close` | boolean | No | Include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get ROCP (Rate of Change Percentage)

**Slug:** `TWELVE_DATA_GET_ROCP`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. Default -1 (automatically determined). |
| `date` | string | No | 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'. |
| `figi` | string | No | The FIGI of an instrument for which data is requested. |
| `isin` | string | No | Filter by international securities identification number (ISIN). |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | The CUSIP of an instrument for which data is requested. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. |
| `format` | string ("JSON" | "CSV") | No | The format of the response data. |
| `symbol` | string | No | Symbol ticker of the instrument. E.g. 'AAPL', 'EUR/USD', 'ETH/BTC'. |
| `country` | string | No | The country where the instrument is traded, e.g., 'United States' or 'US'. |
| `prepost` | boolean | No | Returns quotes that include pre-market and post-market data. Only for Pro and above plans. |
| `end_date` | string | No | End date for data selection. Format '2006-01-02' or '2006-01-02T15:04:05'. |
| `exchange` | string | No | Exchange where instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | Timezone at which output datetime will be displayed. Supports 'Exchange', 'UTC', or IANA timezone names (e.g., 'America/New_York'). |
| `delimiter` | string | No | The separator used in the CSV response data. |
| `outputsize` | integer | No | Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set. |
| `start_date` | string | No | Start date for data selection. Format '2006-01-02' or '2006-01-02T15:04:05'. |
| `series_type` | string ("close" | "open" | "high" | "low" | "volume") | No | Price type on which technical indicator is calculated. |
| `time_period` | integer | No | Number of periods to average over. Takes values in the range from 1 to 800. Default 9. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. |
| `previous_close` | boolean | No | A boolean parameter to include the previous closing price in the time_series data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get ROCR100

**Slug:** `TWELVE_DATA_GET_ROCR100`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | 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. |
| `date` | string | No | 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'. |
| `figi` | string | No | The FIGI of an instrument for which data is requested. Available starting with the Ultra plan. |
| `isin` | string | No | Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section. |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. Default is 'desc'. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. Default is 'splits'. |
| `format` | string ("JSON" | "CSV") | No | The format of the response data. Default is 'JSON'. |
| `symbol` | string | No | Symbol ticker of the instrument. E.g. 'AAPL', 'EUR/USD', 'ETH/BTC'. |
| `country` | string | No | The country where the instrument is traded, e.g., 'United States' or 'US'. |
| `prepost` | boolean | No | 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. |
| `end_date` | string | No | End date for data selection. Format '2006-01-02' or '2006-01-02T15:04:05'. See start_date description for details. |
| `exchange` | string | No | Exchange where instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | 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'). |
| `delimiter` | string | No | The separator used in the CSV response data. Default is ';'. |
| `outputsize` | integer | No | 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. |
| `start_date` | string | No | Start date for data selection. Format '2006-01-02' or '2006-01-02T15:04:05'. Can be used separately and together with end_date. |
| `series_type` | string ("close" | "open" | "high" | "low" | "volume") | No | Price type on which technical indicator is calculated. Default is 'close'. |
| `time_period` | integer | No | Number of periods to average over. Takes values in the range from 1 to 800. Default is 9. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. |
| `previous_close` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Relative Volume

**Slug:** `TWELVE_DATA_GET_RVOL`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | 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. |
| `date` | string | No | 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'. |
| `figi` | string | No | The FIGI of an instrument for which data is requested. Available starting with the Ultra plan. |
| `isin` | string | No | International securities identification number (ISIN). ISIN access is activating in the Data add-ons section. |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. |
| `format` | string ("JSON" | "CSV") | No | The format of the response data. |
| `symbol` | string | No | Symbol ticker of the instrument (e.g., 'AAPL', 'EUR/USD', 'ETH/BTC'). At least one of symbol, isin, figi, or cusip must be provided. |
| `country` | string | No | The country where the instrument is traded (e.g., 'United States' or 'US'). |
| `prepost` | boolean | No | 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. |
| `end_date` | string | No | The ending date and time for data selection. Format: '2006-01-02' or '2006-01-02T15:04:05'. |
| `exchange` | string | No | Exchange where instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. Required field. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | 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'. |
| `delimiter` | string | No | The separator used in the CSV response data. |
| `outputsize` | integer | No | 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. |
| `start_date` | string | No | 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. |
| `time_period` | integer | No | Number of periods to average over. Takes values in the range from 1 to 800. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. |
| `previous_close` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Stock Splits

**Slug:** `TWELVE_DATA_GET_SPLITS`

Tool to retrieve historical stock split events. Use when you need to fetch split history for a particular instrument.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Splits Calendar

**Slug:** `TWELVE_DATA_GET_SPLITS_CALENDAR`

Tool to retrieve a calendar of stock split events. Use when you need to fetch split events for instruments over a date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `figi` | string | No | Filter by FIGI identifier. |
| `isin` | string | No | Filter by ISIN identifier. |
| `page` | integer | No | Page number for paginated results. Defaults to 1. |
| `cusip` | string | No | Filter by CUSIP identifier. |
| `symbol` | string | No | Symbol ticker of the instrument; use dot for preferred shares (e.g., 'BRK.A'). |
| `country` | string | No | Country where the instrument is traded (full name or ISO code). |
| `end_date` | string | No | End date (inclusive) in YYYY-MM-DD format. |
| `exchange` | string | No | Exchange where the instrument is traded (e.g., 'NASDAQ'). |
| `mic_code` | string | No | ISO 10383 Market Identifier Code (e.g., 'XNAS'). |
| `outputsize` | integer | No | Number of records to return (1–500). Defaults to 100 when no date filters. |
| `start_date` | string | No | Start date (inclusive) in YYYY-MM-DD format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Statistics

**Slug:** `TWELVE_DATA_GET_STATISTICS`

Tool to retrieve key company statistics including valuation and financial overview. Use when you need a company financial snapshot after selecting an instrument.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `figi` | string | No | Financial Instrument Global Identifier. Provide one of symbol, figi, isin, or cusip. |
| `isin` | string | No | International Securities Identification Number. Provide one of symbol, figi, isin, or cusip. |
| `cusip` | string | No | CUSIP identifier. Provide one of symbol, figi, isin, or cusip. |
| `symbol` | string | No | Ticker symbol to query (e.g., 'AAPL'). Provide one of symbol, figi, isin, or cusip. |
| `country` | string | No | Country where the instrument is traded (name or alpha code, e.g., 'United States' or 'US'). |
| `exchange` | string | No | Exchange where the instrument is traded (e.g., 'NASDAQ'). |
| `mic_code` | string | No | Market Identifier Code (ISO 10383) for the exchange (e.g., 'XNAS'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Stochastic RSI

**Slug:** `TWELVE_DATA_GET_STOCHRSI`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | 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. |
| `date` | string | No | 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'. |
| `figi` | string | No | The FIGI of an instrument for which data is requested. Available starting with the Ultra plan. |
| `isin` | string | No | Filter by international securities identification number (ISIN). ISIN access is activated in the Data add-ons section. |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | The CUSIP of an instrument for which data is requested. CUSIP access is activated in the Data add-ons section. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. |
| `format` | string ("JSON" | "CSV") | No | The format of the response data. |
| `symbol` | string | No | Symbol ticker of the instrument (e.g., 'AAPL', 'EUR/USD', 'ETH/BTC'). At least one of symbol, isin, figi, or cusip must be provided. |
| `country` | string | No | The country where the instrument is traded, e.g., 'United States' or 'US'. |
| `prepost` | boolean | No | 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. |
| `d_period` | integer | No | Period for smoothing the %D line, which is a moving average of %K. Takes values in the range from 1 to 800. |
| `end_date` | string | No | The ending date and time for data selection, see start_date description for details. |
| `exchange` | string | No | Exchange where instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. |
| `k_period` | integer | No | Period for smoothing the %K line. Takes values in the range from 1 to 800. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | 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. |
| `delimiter` | string | No | The separator used in the CSV response data. |
| `outputsize` | integer | No | 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. |
| `rsi_length` | integer | No | Length of period for calculating the RSI component. Takes values in the range from 1 to 800. |
| `start_date` | string | No | 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. |
| `series_type` | string ("open" | "high" | "low" | "close") | No | Price type for technical indicator calculation. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. |
| `stoch_length` | integer | No | Period length for computing the stochastic oscillator of the RSI. Takes values in the range from 1 to 800. |
| `slow_dma_type` | string | No | Type of moving average for smoothing the %D line. |
| `slow_kma_type` | string | No | Type of moving average for smoothing the %K line. |
| `previous_close` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Summation (SUM)

**Slug:** `TWELVE_DATA_GET_SUM`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | 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. |
| `date` | string | No | 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'. |
| `figi` | string | No | The FIGI of an instrument for which data is requested. This request parameter is available starting with the Ultra plan. |
| `isin` | string | No | Filter by international securities identification number (ISIN). ISIN access is activated in the Data add-ons section. |
| `type` | 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") | No | Asset class to which the instrument belongs. |
| `cusip` | string | No | The CUSIP of an instrument for which data is requested. CUSIP access is activated in the Data add-ons section. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. |
| `format` | string ("JSON" | "CSV") | No | Format of the response data. |
| `symbol` | string | No | Symbol ticker of the instrument. E.g. 'AAPL', 'EUR/USD', 'ETH/BTC'. Either symbol, isin, figi, or cusip must be provided. |
| `country` | string | No | The country where the instrument is traded, e.g., 'United States' or 'US'. |
| `prepost` | boolean | No | 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. |
| `end_date` | string | No | The ending date and time for data selection. Format '2006-01-02' or '2006-01-02T15:04:05'. Works together with start_date. |
| `exchange` | string | No | Exchange where instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | 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. |
| `delimiter` | string | No | The separator used in the CSV response data. Default is ';'. |
| `outputsize` | integer | No | 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. |
| `start_date` | string | No | 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. |
| `series_type` | string ("close" | "open" | "high" | "low" | "volume") | No | Price type on which technical indicator is calculated. |
| `time_period` | integer | No | Number of periods to average over. Takes values in the range from 1 to 800. Default is 9. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. |
| `previous_close` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Technical Indicators List

**Slug:** `TWELVE_DATA_GET_TECHNICAL_INDICATORS_LIST`

Tool to retrieve a comprehensive list of available technical indicators. Use when you need to discover which technical analysis tools are available.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get TEMA (Triple Exponential Moving Average)

**Slug:** `TWELVE_DATA_GET_TEMA`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Number of decimal places for floating values (range: 0-11). |
| `date` | string | No | Exact date to get data for. Format: '2021-10-27', 'today', or 'yesterday'. |
| `figi` | string | No | The FIGI of an instrument. Available starting with the Ultra plan. |
| `isin` | string | No | International securities identification number (ISIN). Requires Data add-ons subscription. |
| `type` | 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") | No | Asset class types. |
| `cusip` | string | No | The CUSIP of an instrument. Requires Data add-ons subscription. |
| `order` | string ("asc" | "desc") | No | Sorting order for output. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Price adjustment mode. |
| `format` | string ("JSON" | "CSV") | No | Response format options. |
| `symbol` | string | No | Symbol ticker of the instrument (e.g., 'AAPL', 'EUR/USD', 'ETH/BTC'). Either symbol, isin, figi, or cusip must be provided. |
| `country` | string | No | The country where the instrument is traded (e.g., 'United States' or 'US'). |
| `prepost` | boolean | No | Include pre-market and post-market data. Only for Pro+ plans at 1min, 5min, 15min, 30min intervals for US equities. |
| `end_date` | string | No | Ending date for data selection. See start_date description for format details. |
| `exchange` | string | No | Exchange where instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | Timezone for output datetime. Options: 'Exchange' (local), 'UTC', or IANA timezone name (e.g., 'America/New_York'). |
| `delimiter` | string | No | The separator used in CSV response data. |
| `outputsize` | integer | No | Number of data points to retrieve (range: 1-5000). Default 30 when no date parameters are set. |
| `start_date` | string | No | Starting date for data selection. Format: '2006-01-02' or '2006-01-02T15:04:05'. Can be used with or without end_date. |
| `series_type` | string ("close" | "open" | "high" | "low" | "volume") | No | Price type for technical indicator calculation. |
| `time_period` | integer | No | The time period used for calculation in the indicator. Default is 9. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. |
| `previous_close` | boolean | No | Include the previous closing price in time_series data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Variance (VAR)

**Slug:** `TWELVE_DATA_GET_VAR`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | 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. |
| `date` | string | No | 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'. |
| `figi` | string | No | The FIGI of an instrument for which data is requested. Available starting with the Ultra plan. |
| `isin` | string | No | Filter by international securities identification number (ISIN). ISIN access is activated in the Data add-ons section. |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | The CUSIP of an instrument for which data is requested. CUSIP access is activated in the Data add-ons section. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. |
| `format` | string ("JSON" | "CSV") | No | The format of the response data. |
| `symbol` | string | No | Symbol ticker of the instrument (e.g., 'AAPL', 'EUR/USD', 'ETH/BTC'). Either symbol, isin, figi, or cusip must be provided. |
| `country` | string | No | The country where the instrument is traded, e.g., 'United States' or 'US'. |
| `prepost` | boolean | No | 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. |
| `end_date` | string | No | The ending date and time for data selection, see start_date description for details. |
| `exchange` | string | No | Exchange where instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | 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. |
| `delimiter` | string | No | The separator used in the CSV response data. |
| `outputsize` | integer | No | 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. |
| `start_date` | string | No | 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. |
| `series_type` | string ("close" | "open" | "high" | "low" | "volume") | No | Price type on which technical indicator is calculated. |
| `time_period` | integer | No | Number of periods to average over. Takes values in the range from 1 to 800. Default is 9. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. |
| `previous_close` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Weighted Close Price

**Slug:** `TWELVE_DATA_GET_WCLPRICE`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Number of decimal places for floating values. Range [0, 11]. Default is automatically determined. |
| `date` | string | No | Specifies exact date for data retrieval. Can be exact date like '2021-10-27', or human language like 'today' or 'yesterday'. |
| `figi` | string | No | Financial Instrument Global Identifier (FIGI) of the instrument. Available with Ultra plan or higher. |
| `isin` | string | No | International Securities Identification Number (ISIN) of the instrument. ISIN access requires activation in Data add-ons. |
| `type` | 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") | No | Asset class types supported by Twelve Data API. |
| `cusip` | string | No | CUSIP identifier of the instrument. CUSIP access requires activation in Data add-ons. |
| `order` | string ("asc" | "desc") | No | Sorting order for output data. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Price adjustment modes. |
| `format` | string ("JSON") | No | Response format options. |
| `symbol` | string | No | Symbol ticker of the instrument. At least one of symbol, isin, figi, or cusip must be provided. E.g. 'AAPL', 'EUR/USD', 'ETH/BTC'. |
| `country` | string | No | Country where the instrument is traded, e.g., 'United States' or 'US'. |
| `prepost` | boolean | No | Include pre-market and post-market data. Only for Pro and above plans. Available at 1min, 5min, 15min, and 30min intervals for US equities. |
| `end_date` | string | No | End date for data selection. Format and behavior same as start_date. |
| `exchange` | string | No | Exchange where the instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Time interval between consecutive data points. Required parameter. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | 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'. |
| `delimiter` | string | No | Separator used in CSV response data. Default is ';'. |
| `outputsize` | integer | No | Number of data points to retrieve. Supports values from 1 to 5000. Default is 30 when no date parameters are set. |
| `start_date` | string | No | 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. |
| `include_ohlc` | boolean | No | Specify if OHLC (Open, High, Low, Close) values should be added in the output. |
| `previous_close` | boolean | No | Include previous closing price in the time series data. If true, adds previous bar close price to current object. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Weighted Moving Average (WMA)

**Slug:** `TWELVE_DATA_GET_WMA`

Tool 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dp` | integer | No | Number of decimal places for floating values. Range: 0-11. By default, automatically determined. |
| `date` | string | No | Specifies exact date to get data for. Can be exact date (e.g., '2021-10-27') or human language ('today' or 'yesterday'). |
| `figi` | string | No | Financial Instrument Global Identifier (FIGI). Available starting with Ultra plan. |
| `isin` | string | No | International Securities Identification Number (ISIN). Requires activation in Data add-ons. |
| `type` | 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") | No | The asset class to which the instrument belongs. |
| `cusip` | string | No | CUSIP identifier. Requires activation in Data add-ons. |
| `order` | string ("asc" | "desc") | No | Sorting order of the output. Default is 'desc'. |
| `adjust` | string ("all" | "splits" | "dividends" | "none") | No | Adjusting mode for prices. Default is 'splits'. |
| `format` | string ("JSON" | "CSV") | No | The format of the response data. Default is 'JSON'. |
| `symbol` | string | No | Symbol ticker of the instrument. E.g. 'AAPL', 'EUR/USD', 'ETH/BTC'. At least one of symbol, isin, figi, or cusip must be provided. |
| `country` | string | No | The country where the instrument is traded, e.g., 'United States' or 'US'. |
| `prepost` | boolean | No | Include pre-market and post-market data. Only for Pro+ plans at 1min/5min/15min/30min intervals for US equities. |
| `end_date` | string | No | End date for data selection. Format: 'YYYY-MM-DD' or 'YYYY-MM-DDTHH:MM:SS'. See start_date description for details. |
| `exchange` | string | No | Exchange where instrument is traded. |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "45min" | "1h" | "2h" | "4h" | "5h" | "1day" | "1week" | "1month") | Yes | Interval between two consecutive points in time series. |
| `mic_code` | string | No | Market Identifier Code (MIC) under ISO 10383 standard. |
| `timezone` | string | No | Timezone for output datetime. Supports 'Exchange', 'UTC', or IANA timezone name (e.g., 'America/New_York'). Default is 'Exchange'. |
| `delimiter` | string | No | The separator used in CSV response data. Default is ';'. |
| `outputsize` | integer | No | Number of data points to retrieve. Range: 1-5000. Default is 30 when no date parameters are set. |
| `start_date` | string | No | Start date for data selection. Format: 'YYYY-MM-DD' or 'YYYY-MM-DDTHH:MM:SS'. Can be used with or without end_date. |
| `series_type` | string ("close" | "open" | "high" | "low" | "volume") | No | Price type on which technical indicator is calculated. Default is 'close'. |
| `time_period` | integer | No | Number of periods to average over. Range: 1-800. Default is 9. |
| `include_ohlc` | boolean | No | Specify if OHLC values should be added in the output. Default is false. |
| `previous_close` | boolean | No | Include previous closing price in time_series data. If true, adds previous bar close price to current object. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List market indices

**Slug:** `TWELVE_DATA_INDICES`

Tool to retrieve a list of market indices. Use when you need to fetch available indices filtered by country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string | No | Response format. Only 'json' is supported. |
| `country` | string | No | Filter indices by 2-letter ISO country code, e.g., 'US', 'GB' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Institutional Holders

**Slug:** `TWELVE_DATA_INSTITUTIONAL_HOLDERS`

Tool to retrieve institutional holders positions for a company. Use when you need summary ownership metrics and top institutions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `figi` | string | No | Filter by FIGI (e.g., 'BBG01293F5X4'). Required if other identifiers are not provided. |
| `isin` | string | No | Filter by ISIN (e.g., 'US0378331005'). Required if other identifiers are not provided. |
| `cusip` | string | No | Filter by CUSIP (e.g., '594918104'). Required if other identifiers are not provided. |
| `symbol` | string | No | Ticker of the instrument (e.g., 'AAPL'). Required if other identifiers are not provided. |
| `country` | string | No | Country name or two-letter code (e.g., 'US'). |
| `exchange` | string | No | Exchange where the instrument is traded (e.g., 'NASDAQ'). |
| `mic_code` | string | No | Market Identifier Code (e.g., 'XNAS'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mutual Funds Family

**Slug:** `TWELVE_DATA_MUTUAL_FUNDS_FAMILY`

Tool to list all available mutual fund families. Use when you need a comprehensive list of mutual fund families managed by investment companies after obtaining a valid API key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mutual Funds List

**Slug:** `TWELVE_DATA_MUTUAL_FUNDS_LIST`

Tool to retrieve a daily updated list of mutual funds sorted by total assets. Use when you need to enumerate available mutual funds for analysis.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | No | Filter mutual funds by type (e.g., 'Open Ended'). |
| `format` | string ("json" | "csv") | No | Output format: 'json' or 'csv'. Default is 'json'. |
| `country` | string | No | Filter mutual funds by country (e.g., 'US'). |
| `exchange` | string | No | Filter mutual funds by exchange (e.g., 'NASDAQ'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mutual Funds World Composition

**Slug:** `TWELVE_DATA_MUTUAL_FUNDS_WORLD_COMPOSITION`

Tool to fetch global mutual fund portfolio composition including sectors, asset allocation, top holdings, and bond metrics. Use after selecting a mutual fund to analyze its composition.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Options Chain

**Slug:** `TWELVE_DATA_OPTIONS_CHAIN_ACTION`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Expiration date in YYYY-MM-DD format. Omit to retrieve all available expiration dates. |
| `symbol` | string | Yes | Ticker symbol for the option's underlying asset. |
| `includeGreeks` | boolean | No | Whether to include Greeks data (delta, gamma, etc.). Default is false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Options Expiration

**Slug:** `TWELVE_DATA_OPTIONS_EXPIRATION`

Tool to retrieve available option expiration dates. Use when exploring available expiration dates for a given options symbol.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | Ticker symbol of the underlying security for options expiration lookup. |
| `exchange` | string | No | Exchange code where the security is listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Quote

**Slug:** `TWELVE_DATA_QUOTE`

Tool to retrieve the latest market data for a specified symbol. Use when you need a quick real-time quote after selecting a symbol.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("JSON" | "CSV") | No | Response format: 'JSON' or 'CSV'. Default is JSON. |
| `source` | string | No | Optional data source override, e.g., 'docs'. |
| `symbol` | string | Yes | Ticker symbol to query (e.g., 'AAPL', 'MSFT', 'BTC/USD'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Stocks

**Slug:** `TWELVE_DATA_STOCKS_LIST`

Tool to retrieve a list of stocks. Use when you need to fetch securities with optional filtering by exchange, country, type, or symbol.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | No | Type of security to filter (e.g., 'Common Stock'). |
| `format` | string ("json" | "csv") | No | Response format: 'json' or 'csv'. |
| `symbol` | string | No | Specific stock symbol to filter by (e.g., 'AAPL'). |
| `country` | string | No | Country code to filter by (e.g., 'United States'). |
| `exchange` | string | No | Exchange code to filter results (e.g., 'NYSE'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Symbol Search

**Slug:** `TWELVE_DATA_SYMBOL_SEARCH`

Tool to search for financial instruments by symbol or company name. Use when you need to discover available symbols before making further data requests.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | Symbol or company name to search for, supports partial matches. |
| `exchange` | string | No | Exchange code to filter results (optional). |
| `outputsize` | integer | No | Maximum number of results to return (1-10000). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Technical Indicators

**Slug:** `TWELVE_DATA_TECHNICAL_INDICATORS`

Tool to fetch time-series data for a specific technical indicator. Use when you have a symbol, interval, and indicator name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | Symbol to compute the indicator for (e.g., 'AAPL', 'BTC/USD'). |
| `interval` | string ("1min" | "5min" | "15min" | "30min" | "1h" | "2h" | "4h" | "1day" | "1week" | "1month") | Yes | Time interval for the data. |
| `indicator` | string | Yes | Name of the technical indicator (e.g., 'sma', 'ema', 'rsi'). |
| `outputsize` | integer | No | Number of data points to return, between 1 and 5000. |
| `indicator_params` | object | No | Additional indicator-specific parameters (e.g., period, series_type). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Time Series

**Slug:** `TWELVE_DATA_TIME_SERIES`

Tool 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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
