Twelve Data API

https://twelvedata.com/docs
Admin
Twelve Data provides an API for accessing real-time and historical financial market data, including...
Tokens:143,871
Snippets:1,080
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### Batch Request Example (curl)

Source: https://twelvedata.com/docs/llms/advanced/batch-requests.md

Sends a POST request to the /batch endpoint with a JSON body containing multiple requests, each identified by a unique key (req_1, req_2, etc.) and a URL path. The example includes requests for time series, exchange rate, and currency conversion data.

```bash
curl "curl --location 'https://api.twelvedata.com/batch' \
--header 'Content-Type: application/json' \
--header 'Authorization: apikey demo' \
--data @- << EOF
{
    "req_1": {
        "url": "/time_series?symbol=AAPL&interval=1min&apikey=demo&outputsize=2"
    },
    "req_2": {
        "url": "/exchange_rate?symbol=USD/JPY&apikey=demo"
    },
    "req_3": {
        "url": "/currency_conversion?symbol=USD/JPY&amount=122&apikey=demo"
    }
}
EOF"
```

--------------------------------

### Example Request: curl to forex_pairs endpoint

Source: https://twelvedata.com/docs/llms/asset-catalogs/forex-pairs-list.md

Sends a GET request to the forex_pairs endpoint with an API key. The response is a JSON array of forex pairs.

```bash
curl "https://api.twelvedata.com/forex_pairs?apikey=demo"
```

--------------------------------

### curl Request for Exchange Rate

Source: https://twelvedata.com/docs/llms/currencies/exchange-rate.md

Example curl command to fetch the exchange rate for EUR/USD using the demo API key.

```bash
curl "https://api.twelvedata.com/exchange_rate?symbol=EUR/USD&apikey=demo"
```

--------------------------------

### curl request for key executives

Source: https://twelvedata.com/docs/llms/fundamentals/key-executives.md

Example curl command to fetch key executives for AAPL using the demo API key.

```bash
curl "https://api.twelvedata.com/key_executives?symbol=AAPL&apikey=demo"
```

--------------------------------

### curl request for revenue_estimate endpoint

Source: https://twelvedata.com/docs/llms/analysis/revenue-estimate.md

Example curl command to fetch revenue estimates for AAPL using the demo API key.

```bash
curl "https://api.twelvedata.com/revenue_estimate?symbol=AAPL&apikey=demo"
```

--------------------------------

### cURL Request for Market Movers

Source: https://twelvedata.com/docs/llms/market-data/market-movers.md

Example request to the market_movers endpoint for stocks. Requires an API key and a Pro or Venture plan.

```bash
curl "https://api.twelvedata.com/market_movers/stocks?apikey=your_api_key"
```

--------------------------------

### curl request for tax_info endpoint

Source: https://twelvedata.com/docs/llms/regulatory/tax-info.md

Example curl command to retrieve tax information for symbol SKYQ using the demo API key.

```bash
curl "https://api.twelvedata.com/tax_info?symbol=SKYQ&apikey=demo"
```

--------------------------------

### curl Request for Market State

Source: https://twelvedata.com/docs/llms/markets/market-state.md

Example curl command to retrieve market state data for all exchanges. Uses the demo API key.

```bash
curl "https://api.twelvedata.com/market_state?apikey=demo"
```

--------------------------------

### SAREXT API Request (curl)

Source: https://twelvedata.com/docs/llms/overlap-studies/sarext.md

Sends a GET request to the SAREXT endpoint for AAPL with a 1-minute interval using the demo API key.

```bash
curl "https://api.twelvedata.com/sarext?symbol=AAPL&interval=1min&apikey=demo"
```

--------------------------------

### curl request for market_cap endpoint

Source: https://twelvedata.com/docs/llms/fundamentals/market-cap.md

Example curl command to retrieve market capitalization data for AAPL using the demo API key.

```bash
curl "https://api.twelvedata.com/market_cap?symbol=AAPL&apikey=demo"
```

--------------------------------

### Example Request: curl to fetch countries

Source: https://twelvedata.com/docs/llms/supporting-metadata/countries.md

Use this curl command to request the list of countries from the Twelve Data API. Replace 'demo' with your actual API key. The endpoint requires no parameters and costs 1 credit per request.

```bash
curl "https://api.twelvedata.com/countries?apikey=demo"
```

--------------------------------

### Example Request: curl to fetch stocks

Source: https://twelvedata.com/docs/llms/asset-catalogs/stocks-list.md

Use this curl command to retrieve the list of available stock symbols. Replace the 'demo' API key with your own. The response is in JSON format by default.

```bash
curl "https://api.twelvedata.com/stocks?apikey=demo"
```

--------------------------------

### GET /splits_calendar

Source: https://twelvedata.com/docs/llms/fundamentals/splits-calendar.md

Retrieves a calendar of stock split events within a specified date range. Users can filter by symbol, identifiers, exchange, and date range to get split details including ratio and effective date.

```APIDOC
## GET /splits_calendar

### Description
Retrieves a detailed calendar of stock split events within a specified date range. Users can filter by symbol, identifiers, exchange, and date range to get split details including ratio and effective date.

### Method
GET

### Endpoint
https://api.twelvedata.com/splits_calendar

### Parameters
#### Query Parameters
- **symbol** (string) - Optional - Symbol ticker of instrument. For preferred stocks use dot(.) delimiter. E.g. `BRK.A` or `BRK.B` will be correct. Example: `AAPL`
- **figi** (string) - Optional - Filter by financial instrument global identifier (FIGI). Available on Ultra plan (individual) and Enterprise plan (business) and above. Example: `BBG000B9Y5X2`
- **isin** (string) - Optional - Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section. Example: `US0378331005`
- **cusip** (string) - Optional - The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section. Example: `594918104`
- **exchange** (string) - Optional - Exchange where instrument is traded. Example: `NASDAQ`
- **mic_code** (string) - Optional - Market Identifier Code (MIC) under ISO 10383 standard. Example: `XNAS`
- **country** (string) - Optional - Country where instrument is traded, e.g., `United States` or `US`. Example: `United States`
- **start_date** (string) - Optional - The starting date (inclusive) for filtering split events in the calendar. Format `2006-01-02`. Example: `2024-01-01`
- **end_date** (string) - Optional - The ending date (inclusive) for filtering split events in the calendar. Format `2006-01-02`. Example: `2024-12-31`
- **outputsize** (integer) - Optional - Number of data points to retrieve. Supports values in the range from `1` to `500`. Default `100` when no date parameters are set, otherwise set to maximum. Default: `100`
- **page** (string) - Optional - Page number. Default: `1`

### Request Example
```bash
curl "https://api.twelvedata.com/splits_calendar?apikey=your_api_key"
```

### Response
#### Success Response (200)
- **date** (string) - Stands for the split date
- **symbol** (string) - Ticker of the company
- **mic_code** (string) - Market Identifier Code (MIC) under ISO 10383 standard
- **exchange** (string) - Exchange name where the company is listed
- **description** (string) - Specification of the split event
- **ratio** (number) - The ratio by which the number of a company's outstanding shares of stock are increased following a stock split. For example, a `4-for-1 split` results in four times as many outstanding shares, with each share selling at one forth of its pre-split price
- **from_factor** (number) - From factor of the split
- **to_factor** (number) - To factor of the split

#### Response Example
```json
[
    {
        "date": "1987-06-16",
        "symbol": "AAPL",
        "mic_code": "XNGS",
        "exchange": "NASDAQ",
        "description": "2-for-1 split",
        "ratio": 0.5,
        "from_factor": 2,
        "to_factor": 1
    }
]
```
```

--------------------------------

### Example Request: curl to fetch funds

Source: https://twelvedata.com/docs/llms/asset-catalogs/funds-list.md

Use this curl command to request a list of funds from the Twelve Data API. Replace the 'apikey' parameter with your own API key. The response is in JSON format by default.

```bash
curl "https://api.twelvedata.com/funds?apikey=demo"
```

--------------------------------

### GET /etfs/type

Source: https://twelvedata.com/docs/llms/etfs/etf-type-list.md

Retrieves a list of ETF types by country. Supports optional filtering by country and fund type.

```APIDOC
## GET /etfs/type

### Description
Retrieves a list of ETF types by country. Supports optional filtering by country and fund type.

### Method
GET

### Endpoint
https://api.twelvedata.com/etfs/type

### Parameters
#### Query Parameters
- **country** (string) - Optional - Filter by country name or alpha code, e.g., `United States` or `US`. Example value: `United States`
- **fund_type** (string) - Optional - Filter by the type of fund. Example value: `Large Blend`

### Request Example
```bash
curl "https://api.twelvedata.com/etfs/type?apikey=demo"
```

### Response
#### Success Response (200)
- **result** (map (key: string, value: array of string)) - List of fund types by country
- **status** (string) - Status of the response

#### Response Example
```json
{
    "result": {
        "Singapore": [
            "Property - Indirect Asia",
            "Sector Equity Water"
        ],
        "United States": [
            "Asia-Pacific ex-Japan Equity",
            "EUR Flexible Allocation - Global"
        ]
    },
    "status": "ok"
}
```
```

--------------------------------

### GET /symbol_search

Source: https://twelvedata.com/docs/llms/discovery/symbol-search.md

Searches for financial instruments by symbol or ISIN. Returns a list of matching symbols ordered by relevance.

```APIDOC
## GET /symbol_search

### Description
Searches for financial instruments by symbol or ISIN. Returns a list of matching symbols ordered by relevance.

### Method
GET

### Endpoint
https://api.twelvedata.com/symbol_search

### Parameters
#### Query Parameters
- **symbol** (string) - Required - Symbol to search. Supports ticker symbol, ISIN, FIGI (Ultra/Enterprise plans), Composite FIGI (Ultra/Enterprise plans), Share Class FIGI (Ultra/Enterprise plans). Example: `AAPL`
- **outputsize** (integer) - Optional - Number of matches in response. Max 120. Default: `30`
- **show_plan** (boolean) - Optional - Adds info on which plan symbol is available. Default: `false`

### Request Example
```bash
curl "https://api.twelvedata.com/symbol_search?symbol=AAPL&apikey=demo"
```

### Response
#### Success Response (200)
- **data** (array of object) - List of symbols matching the search criteria
  - **symbol** (string) - Ticker symbol of instrument
  - **instrument_name** (string) - Name of exchange
  - **exchange** (string) - Exchange where instrument is traded
  - **mic_code** (string) - Market identifier code (MIC) under ISO 10383 standard
  - **exchange_timezone** (string) - Time zone where exchange is located
  - **instrument_type** (string) - Type of instrument
  - **country** (string) - Country to which stock exchange belongs to
  - **currency** (string) - Currency in which the instrument is traded
  - **access** (object) - Info on which plan symbol is available (displayed when `show_plan` is `true`)
    - **global** (string) - Level of access to the symbol
    - **plan** (string) - The individual plan name for the symbol
    - **plan_business** (string) - The business plan name for the symbol
- **status** (string) - Status of the response

#### Response Example
```json
{
    "data": [
        {
            "symbol": "AA",
            "instrument_name": "Alcoa Corp",
            "exchange": "NYSE",
            "mic_code": "XNYS",
            "exchange_timezone": "America/New_York",
            "instrument_type": "Common Stock",
            "country": "United States",
            "currency": "USD",
            "access": {
                "global": "Basic",
                "plan": "Basic",
                "plan_business": "Basic"
            }
        }
    ],
    "status": "ok"
}
```
```

--------------------------------

### IPO Calendar API Request (curl)

Source: https://twelvedata.com/docs/llms/fundamentals/ipo-calendar.md

Example curl command to fetch IPO calendar data. Requires an API key and the Grow or Venture plan.

```bash
curl "https://api.twelvedata.com/ipo_calendar?apikey=your_api_key"
```

--------------------------------

### Example Request: curl command for mutual funds summary

Source: https://twelvedata.com/docs/llms/mutual-funds/mf-summary.md

Use this curl command to request a summary for a mutual fund by symbol. Replace the symbol and apikey as needed. The endpoint requires at least one of symbol, figi, isin, or cusip.

```bash
curl "https://api.twelvedata.com/mutual_funds/world/summary?symbol=1535462D&apikey=demo"
```

--------------------------------

### GET /dividends

Source: https://twelvedata.com/docs/llms/fundamentals/dividends.md

Retrieves historical dividend data for a specified stock. Returns dividend payouts including ex-date and amount.

```APIDOC
## GET /dividends

### Description
Retrieves historical dividend data for a specified stock. Returns dividend payouts including ex-date and amount.

### Method
GET

### Endpoint
https://api.twelvedata.com/dividends

### Parameters
#### Query Parameters
- **symbol** (string) - Optional - Symbol ticker of instrument. For preferred stocks use dot(.) delimiter. E.g. `BRK.A` or `BRK.B` will be correct. Example: `AAPL`
- **figi** (string) - Optional - Filter by financial instrument global identifier (FIGI). Available on Ultra plan (individual) and Enterprise plan (business) and above. Example: `BBG000B9Y5X2`
- **isin** (string) - Optional - Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section. Example: `US0378331005`
- **cusip** (string) - Optional - The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section. Example: `594918104`
- **exchange** (string) - Optional - Exchange where instrument is traded. Example: `NASDAQ`
- **mic_code** (string) - Optional - Market Identifier Code (MIC) under ISO 10383 standard. Example: `XNAS`
- **country** (string) - Optional - Country where instrument is traded, e.g., `United States` or `US`. Example: `US`
- **range** (string) - Optional - Specifies the time range for which to retrieve dividend data. Accepts values such as `last` (most recent dividend), `next` (upcoming dividend), `1m` - `5y` for respective periods, or `full` for all available data. If provided together with `start_date` and/or `end_date`, this parameter takes precedence. Available values: `last`, `next`, `1m`, `3m`, `6m`, `ytd`, `1y`, `2y`, `5y`, `full`. Default: `last`
- **start_date** (string) - Optional - Start date for the dividend data query. Only dividends with dates on or after this date will be returned. Format `2006-01-02`. If provided together with `range` parameter, `range` will take precedence. Example: `2024-01-01`
- **end_date** (string) - Optional - End date for the dividend data query. Only dividends with dates on or before this date will be returned. Format `2006-01-02`. If provided together with `range` parameter, `range` will take precedence. Example: `2024-12-31`
- **adjust** (boolean) - Optional - Specifies if there should be an adjustment. Default: `true`

**Notes:** At least one of the following parameters is required: `symbol`, `figi`, `isin`, `cusip`.

### Request Example
```bash
curl "https://api.twelvedata.com/dividends?symbol=AAPL&apikey=demo"
```

### Response
#### Success Response (200)
- **meta** (object) - Json object with request general information
  - **symbol** (string) - Ticker symbol of instrument
  - **name** (string) - Name of symbol
  - **currency** (string) - Currency in which instrument is traded
  - **exchange** (string) - Exchange where instrument is traded
  - **mic_code** (string) - Market identifier code (MIC) under ISO 10383 standard
  - **exchange_timezone** (string) - Timezone of the exchange
- **dividends** (array of object) - List of dividends
  - **ex_date** (string) - Stands for the ex date
  - **amount** (number) - Stands for the payment amount

#### Response Example
```json
{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "exchange_timezone": "America/New_York"
    },
    "dividends": [
        {
            "ex_date": "2021-08-06",
            "amount": 0.22
        }
    ]
}
```
```

--------------------------------

### GET /countries

Source: https://twelvedata.com/docs/llms/supporting-metadata/countries.md

Retrieves a comprehensive list of countries including ISO codes, official names, capitals, and currencies. No parameters are required.

```APIDOC
## [GET] /countries

### Description
Retrieves a comprehensive list of countries including ISO codes, official names, capitals, and currencies. No parameters are required.

### Method
GET

### Endpoint
https://api.twelvedata.com/countries

### Parameters
No parameters are required.

### Request Example
curl "https://api.twelvedata.com/countries?apikey=demo"

### Response
#### Success Response (200)
- **data** (array of object) - List of countries with their ISO codes, names, capital, and currency
  - **iso2** (string) - Two-letter country code defined in ISO 3166
  - **iso3** (string) - Three-letter country code defined in ISO 3166
  - **numeric** (string) - Numeric country code defined in ISO 3166
  - **name** (string) - The full name of country
  - **official_name** (string) - Official name of country
  - **capital** (string) - Capital of country
  - **currency** (string) - Currency of country

#### Response Example
{
    "data": [
        {
            "iso2": "US",
            "iso3": "USA",
            "numeric": "840",
            "name": "United States",
            "official_name": "United States of America",
            "capital": "Washington D.C.",
            "currency": "USD"
        }
    ]
}
```

--------------------------------

### KST API Response (JSON)

Source: https://twelvedata.com/docs/llms/momentum-indicators/kst.md

Example JSON response from the KST endpoint, showing metadata with indicator parameters and a values array with KST and signal values.

```json
{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "KST - Know Sure Thing",
            "roc_period_1": 10,
            "roc_period_2": 15,
            "roc_period_3": 20,
            "roc_period_4": 30,
            "sma_period_1": 10,
            "sma_period_2": 10,
            "sma_period_3": 10,
            "sma_period_4": 15,
            "signal_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "kst": "-4.58644",
            "kst_signal": "-2.05236",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}
```

--------------------------------

### curl request to money_market_funds/list

Source: https://twelvedata.com/docs/llms/money-market-funds/money-market-funds-list.md

Example request to the money market funds directory endpoint using curl. Replace 'demo' with your API key. Returns a list of money market funds.

```bash
curl "https://api.twelvedata.com/money_market_funds/list?apikey=demo"
```

--------------------------------

### GET /sqrt

Source: https://twelvedata.com/docs/llms/price-transform/sqrt.md

Computes the square root of a specified numerical input. Returns a single numerical value representing the square root.

```APIDOC
## GET /sqrt

### Description
Computes the square root of a specified numerical input. Returns a single numerical value representing the square root.

### Method
GET

### Endpoint
/sqrt

### Parameters
#### Query Parameters
- **symbol** (string) - Optional - Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`. Example: `AAPL`
- **figi** (string) - Optional - The FIGI of an instrument. Available on Ultra and Enterprise plans. Example: `BBG000B9Y5X2`
- **isin** (string) - Optional - Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section. Example: `US0378331005`
- **cusip** (string) - Optional - The CUSIP of an instrument. CUSIP access is activating in the Data add-ons section. Example: `594918104`
- **interval** (string) - Required - Interval between two consecutive points in time series. Available values: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `8h`, `1day`, `1week`, `1month`. Example: `1min`
- **exchange** (string) - Optional - Exchange where instrument is traded. Example: `NASDAQ`
- **mic_code** (string) - Optional - Market Identifier Code (MIC) under ISO 10383 standard. Example: `XNAS`
- **country** (string) - Optional - The country where the instrument is traded, e.g., `United States` or `US`. Example: `United States`
- **series_type** (string) - Optional - Price type on which technical indicator is calculated. Available values: `close`, `open`, `high`, `low`, `volume`. Default: `close`
- **type** (string) - Optional - The asset class to which the instrument belongs. Available values: `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`. Example: `Common Stock`
- **outputsize** (integer) - Optional - Number of data points to retrieve. Range: `1` to `5000`. Default: `30` when no date parameters are set, otherwise set to maximum.
- **format** (string) - Optional - The format of the response data. Available values: `JSON`, `CSV`. Default: `JSON`
- **delimiter** (string) - Optional - The separator used in the CSV response data. Default: `;`
- **prepost** (boolean) - Optional - Returns quotes that include pre-market and post-market data. Only for Pro and Venture plans and above. Available at `1min`, `5min`, `15min`, and `30min` intervals for US equities. Open, high, low, close values are supplied without volume. Default: `false`
- **dp** (integer) - Optional - Specifies the number of decimal places for floating values. Range: [0, 11] inclusive. Default: `-1` (auto)
- **order** (string) - Optional - Sorting order of the output. Available values: `asc`, `desc`. Default: `desc`
- **include_ohlc** (boolean) - Optional - Specify if OHLC values should be added in the output. Available values: `true`, `false`. Default: `false`
- **timezone** (string) - Optional - Timezone at which output datetime will be displayed. Supports: Exchange (local exchange time), UTC, or IANA Time Zone Database names (e.g., America/New_York). Only applicable for intraday intervals. Default: `Exchange`
- **date** (string) - Optional - Specifies the exact date to get the data for. Could be exact date (e.g., `2021-10-27`) or human language (`today`, `yesterday`). Example: `2021-10-27`
- **start_date** (string) - Optional - 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.
- **end_date** (string) - Optional - Can be used separately and together with `start_date`. Format: `2006-01-02` or `2006-01-02T15:04:05`. Default location: Forex and Cryptocurrencies - UTC; Stocks - where exchange is located.

### Response
#### Success Response (200)
Returns a single numerical value representing the square root.

#### Response Example
{
  "value": 1.41421356
}

```

--------------------------------

### GET /ichimoku

Source: https://twelvedata.com/docs/llms/overlap-studies/ichimoku.md

Retrieves Ichimoku Cloud indicator data for a specified symbol. Supports various parameters to customize the calculation and output.

```APIDOC
## GET /ichimoku

### Description
Retrieves Ichimoku Cloud indicator data for a specified symbol. Returns key components such as Tenkan-sen, Kijun-sen, Senkou Span A, Senkou Span B, and Chikou Span.

### Method
GET

### Endpoint
/ichimoku

### Parameters
#### Query Parameters
- **symbol** (string) - Optional - Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`. Example: `AAPL`
- **figi** (string) - Optional - The FIGI of an instrument. Available on Ultra plan (individual) and Enterprise plan (business) and above. Example: `BBG000B9Y5X2`
- **isin** (string) - Optional - Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section. Example: `US0378331005`
- **cusip** (string) - Optional - The CUSIP of an instrument. CUSIP access is activating in the Data add-ons section. Example: `594918104`
- **interval** (string) - Required - Interval between two consecutive points in time series. Available values: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `8h`, `1day`, `1week`, `1month`. Example: `1min`
- **exchange** (string) - Optional - Exchange where instrument is traded. Example: `NASDAQ`
- **mic_code** (string) - Optional - Market Identifier Code (MIC) under ISO 10383 standard. Example: `XNAS`
- **country** (string) - Optional - The country where the instrument is traded, e.g., `United States` or `US`. Example: `United States`
- **conversion_line_period** (integer) - Optional - The time period used for generating the conversation line. Range: 1 to 800. Default: `9`
- **base_line_period** (integer) - Optional - The time period used for generating the base line. Range: 1 to 800. Default: `26`
- **leading_span_b_period** (integer) - Optional - The time period used for generating the leading span B line. Range: 1 to 800. Default: `52`
- **lagging_span_period** (integer) - Optional - The time period used for generating the lagging span line. Range: 1 to 800. Default: `26`
- **include_ahead_span_period** (boolean) - Optional - Indicates whether to include ahead span period. Default: `true`
- **type** (string) - Optional - The asset class to which the instrument belongs. Available values: `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`. Example: `Common Stock`
- **outputsize** (integer) - Optional - Number of data points to retrieve. Range: 1 to 5000. Default: `30` when no date parameters are set, otherwise set to maximum.
- **format** (string) - Optional - The format of the response data. Available values: `JSON`, `CSV`. Default: `JSON`
- **delimiter** (string) - Optional - The separator used in the CSV response data. Default: `;`
- **prepost** (boolean) - Optional - Returns quotes that include pre-market and post-market data. Only for Pro plan (individual) and Venture plan (business) and above. Available at `1min`, `5min`, `15min`, and `30min` intervals for US equities. Open, high, low, close values are supplied without volume. Default: `false`
- **dp** (integer) - Optional - Specifies the number of decimal places for floating values. Range: [0, 11] inclusive. Default: `-1` (auto)
- **order** (string) - Optional - Sorting order of the output. Available values: `asc`, `desc`. Default: `desc`
- **include_ohlc** (boolean) - Optional - Specify if OHLC values should be added in the output. Available values: `true`, `false`. Default: `false`
- **timezone** (string) - Optional - 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).

### Request Example
GET /ichimoku?symbol=AAPL&interval=1day&format=JSON

### Response
#### Success Response (200)
Returns Ichimoku Cloud indicator data including Tenkan-sen, Kijun-sen, Senkou Span A, Senkou Span B, and Chikou Span.

#### Response Example
{
  "meta": {
    "symbol": "AAPL",
    "interval": "1day",
    "type": "Common Stock"
  },
  "values": [
    {
      "datetime": "2023-01-01",
      "tenkan_sen": "...",
      "kijun_sen": "...",
      "senkou_span_a": "...",
      "senkou_span_b": "...",
      "chikou_span": "..."
    }
  ],
  "status": "ok"
}
```

--------------------------------

### Example Request: curl for dividends_calendar

Source: https://twelvedata.com/docs/llms/fundamentals/dividends-calendar.md

Use this curl command to request the dividends calendar. Replace 'your_api_key' with your actual API key. The endpoint returns a list of dividend events.

```bash
curl "https://api.twelvedata.com/dividends_calendar?apikey=your_api_key"
```

--------------------------------

### GET /exchange_schedule

Source: https://twelvedata.com/docs/llms/markets/exchange-schedule.md

Retrieves the trading schedule for stock exchanges. Optionally filter by date, exchange name, MIC code, or country.

```APIDOC
## [GET] /exchange_schedule

### Description
Retrieves the trading schedule for stock exchanges. Optionally filter by date, exchange name, MIC code, or country.

### Method
GET

### Endpoint
https://api.twelvedata.com/exchange_schedule

### Parameters
#### Query Parameters
- **date** (string) - Optional - If a date is provided, the API returns the schedule for the specified date; otherwise, it returns the default (common) schedule. The date can be specified in one of the following formats: an exact date (e.g., 2021-10-27), a human-readable keyword: today or yesterday, or a full datetime string in UTC (e.g., 2025-04-11T20:00:00) to retrieve the schedule corresponding to the day in the specified time. Example value: `2021-10-27`
- **mic_name** (string) - Optional - Filter by exchange name. Example value: `NASDAQ`
- **mic_code** (string) - Optional - Filter by market identifier code (MIC) under ISO 10383 standard. Example value: `XNGS`
- **country** (string) - Optional - Filter by country name or alpha code, e.g., `United States` or `US`. Example value: `United States`

### Request Example
```bash
curl "https://api.twelvedata.com/exchange_schedule?apikey=your_api_key"
```

### Response
#### Success Response (200)
- **data** (array of object) - List of exchange schedules
  - **title** (string) - Official name of exchange
  - **name** (string) - Name of exchange
  - **code** (string) - Market identifier code (MIC) under ISO 10383 standard
  - **country** (string) - Country to which stock exchange belongs to
  - **time_zone** (string) - Time zone where exchange is located
  - **sessions** (array of object) - Exchange trading hours
    - **open_time** (string) - Opening time of the session
    - **close_time** (string) - Closing time of the session
    - **session_name** (string) - Name of the session
    - **session_type** (string) - Type of the session

#### Response Example
```json
{
    "data": [
        {
            "title": "NASDAQ/NGS (Global Select Market)",
            "name": "NASDAQ",
            "code": "XNYS",
            "country": "United States",
            "time_zone": "America/New_York",
            "sessions": [
                {
                    "open_time": "04:00:00",
                    "close_time": "09:30:00",
                    "session_name": "Pre market",
                    "session_type": "pre"
                }
            ]
        }
    ]
}
```

### Notes
- API credits cost: 100 per request
- This API endpoint is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
```

--------------------------------

### curl request for cash_flow/consolidated

Source: https://twelvedata.com/docs/llms/fundamentals/cash-flow-consolidated.md

Sends a GET request to the Twelve Data cash_flow/consolidated endpoint for symbol AAPL with the demo API key.

```bash
curl "https://api.twelvedata.com/cash_flow/consolidated?symbol=AAPL&apikey=demo"
```

--------------------------------

### curl Request for Logo Endpoint

Source: https://twelvedata.com/docs/llms/fundamentals/logo.md

Example curl command to retrieve the logo for BTC/USD using the demo API key. The symbol parameter is required; the response costs 1 API credit.

```bash
curl "https://api.twelvedata.com/logo?symbol=BTC/USD&apikey=demo"
```

--------------------------------

### GET /etfs/world/risk

Source: https://twelvedata.com/docs/llms/etfs/etf-risk.md

Retrieves risk metrics for a specified ETF. Requires at least one of symbol, figi, isin, or cusip parameters.

```APIDOC
## [GET] /etfs/world/risk

### Description
Retrieves risk metrics for a specified ETF, including volatility measures and valuation metrics.

### Method
GET

### Endpoint
https://api.twelvedata.com/etfs/world/risk

### Parameters
#### Query Parameters
- **symbol** (string) - Optional - Symbol ticker of ETF. Example: `IVV`
- **figi** (string) - Optional - Financial instrument global identifier (FIGI). Example: `BBG000BVZ697`
- **isin** (string) - Optional - International securities identification number (ISIN). Example: `US4642872000`
- **cusip** (string) - Optional - CUSIP of the instrument. Example: `464287200`
- **country** (string) - Optional - Filter by country name or alpha code. Example: `United States`
- **dp** (integer) - Optional - Number of decimal places for floating values. Range [0,11]. Default: `5`

**Notes:** At least one of `symbol`, `figi`, `isin`, `cusip` is required.

### Request Example
```bash
curl "https://api.twelvedata.com/etfs/world/risk?symbol=IVV&apikey=demo"
```

### Response
#### Success Response (200)
- **etf** (object) - ETF information
  - **risk** (object) - Risk metrics of the ETF
    - **volatility_measures** (array of object) - Risk and volatility statistics over different periods
      - **period** (string) - Period of the measure
      - **alpha** (number) - Alpha score of the fund
      - **alpha_category** (number) - Average alpha score of the fund's category
      - **beta** (number) - Beta score of the fund
      - **beta_category** (number) - Average beta score of the fund's category
      - **mean_annual_return** (number) - Mean annual return of the fund
      - **mean_annual_return_category** (number) - Average mean annual return of the fund's category
      - **r_squared** (number) - R-squared metric of the fund
      - **r_squared_category** (number) - Average r-squared metric of the fund's category
      - **std** (number) - Standard deviation of the fund
      - **std_category** (number) - Average standard deviation of the fund's category
      - **sharpe_ratio** (number) - Sharpe ratio of the fund
      - **sharpe_ratio_category** (number) - Average Sharpe ratio of the fund's category
      - **treynor_ratio** (number) - Treynor ratio of the fund
      - **treynor_ratio_category** (number) - Average Treynor ratio of the fund's category
    - **valuation_metrics** (object) - Valuation ratios and metrics
      - **price_to_earnings** (number) - Fund price to earnings metric
      - **price_to_book** (number) - Fund price to book metric
      - **price_to_sales** (number) - Fund price to sales metric
      - **price_to_cashflow** (number) - Fund price to cashflow metric
- **status** (string) - Status of the response

#### Response Example
```json
{
    "etf": {
        "risk": {
            "volatility_measures": [
                {
                    "period": "3_year",
                    "alpha": -0.03,
                    "alpha_category": -0.02,
                    "beta": 1,
                    "beta_category": 0.01,
                    "mean_annual_return": 1.58,
                    "mean_annual_return_category": 0.01,
                    "r_squared": 100,
                    "r_squared_category": 0.95,
                    "std": 18.52,
                    "std_category": 0.19,
                    "sharpe_ratio": 0.95,
                    "sharpe_ratio_category": 0.01,
                    "treynor_ratio": 17.41,
                    "treynor_ratio_category": 0.16
                }
            ],
            "valuation_metrics": {
                "price_to_earnings": 26.46,
                "price_to_book": 4.42,
                "price_to_sales": 2.96,
                "price_to_cashflow": 17.57
            }
        }
    },
    "status": "ok"
}
```

```

--------------------------------

### GET /cross_listings

Source: https://twelvedata.com/docs/llms/discovery/cross-listings.md

Retrieves a list of cross-listed symbols for a specified financial instrument. Use this endpoint to identify all exchanges where a security is traded.

```APIDOC
## [GET] /cross_listings

### Description
Retrieves a daily updated list of cross-listed symbols for a specified financial instrument. Cross-listed symbols represent the same security available on multiple exchanges.

### Method
GET

### Endpoint
https://api.twelvedata.com/cross_listings

### Parameters
#### Query Parameters
- **symbol** (string) - Required - The ticker symbol of an instrument for which data is requested. Example: `AAPL`
- **exchange** (string) - Optional - Exchange where instrument is traded. Example: `NASDAQ`
- **mic_code** (string) - Optional - Market identifier code (MIC) under ISO 10383 standard. Example: `XNGS`
- **country** (string) - Optional - Country to which stock exchange belongs to. Example: `United States`

### Request Example
```bash
curl "https://api.twelvedata.com/cross_listings?symbol=AAPL&apikey=demo"
```

### Response
#### Success Response (200)
- **result** (object) - Represents the result of cross listings
  - **count** (integer) - Number of cross listings found
  - **list** (array of object) - List of cross listings
    - **symbol** (string) - Ticker symbol of instrument
    - **name** (string) - Name of symbol
    - **exchange** (string) - Exchange where instrument is traded
    - **mic_code** (string) - Market identifier code (MIC) under ISO 10383 standard

#### Response Example
```json
{
    "result": {
        "count": 4,
        "list": [
            {
                "exchange": "NASDAQ",
                "mic_code": "XNGS",
                "name": "NVIDIA Corporation",
                "symbol": "NVDA"
            },
            {
                "exchange": "VSE",
                "mic_code": "XWBO",
                "name": "NVIDIA Corporation",
                "symbol": "NVDA"
            },
            {
                "exchange": "BVS",
                "mic_code": "XSGO",
                "name": "NVIDIA Corporation",
                "symbol": "NVDACL"
            },
            {
                "exchange": "BVS",
                "mic_code": "XSGO",
                "name": "NVIDIA Corporation",
                "symbol": "NVDA"
            }
        ]
    }
}
```

```

--------------------------------

### Example Request: curl for Dividends API

Source: https://twelvedata.com/docs/llms/fundamentals/dividends.md

Use this curl command to request dividend data for a symbol. Replace 'demo' with your API key. The 'symbol' parameter is required unless using figi, isin, or cusip.

```bash
curl "https://api.twelvedata.com/dividends?symbol=AAPL&apikey=demo"
```

--------------------------------

### curl request for price target

Source: https://twelvedata.com/docs/llms/analysis/price-target.md

Example curl command to fetch price target data for AAPL using the demo API key. Requires the Ultra or Enterprise plan.

```bash
curl "https://api.twelvedata.com/price_target?symbol=AAPL&apikey=demo"
```

--------------------------------

### Splits API curl request

Source: https://twelvedata.com/docs/llms/fundamentals/splits.md

Example request to the Splits endpoint using curl. Requires an API key and a symbol parameter.

```bash
curl "https://api.twelvedata.com/splits?symbol=AAPL&apikey=demo"
```

--------------------------------

### Currency Conversion Request (curl)

Source: https://twelvedata.com/docs/llms/currencies/currency-conversion.md

Example curl command to request currency conversion for EUR/USD with an amount of 100. Uses the demo API key.

```bash
curl "https://api.twelvedata.com/currency_conversion?symbol=EUR/USD&amount=100&apikey=demo"
```

--------------------------------

### Beta API Request (curl)

Source: https://twelvedata.com/docs/llms/statistic-functions/beta.md

Use this curl command to fetch beta data from the Twelve Data API. Replace the symbol, interval, and apikey parameters as needed.

```bash
curl "https://api.twelvedata.com/beta?symbol=AAPL&interval=1min&apikey=demo"
```
Tokens:
Raw