API Documentation - Twelve Data

Getting started

Welcome to the Twelve Data! You can use this API to access world financial markets including stocks, forex, ETFs, and cryptocurrencies. Most of the exchanges are available in real-time, while others have some delays. Over 20+ years of end-of-day data and a couple of years for intraday historical data.

If you are unfamiliar with APIs and requests, check this tutorial on how to make requests as part of the How-to tutorials.

Authentication

Twelve Data authenticates users by valid API keys for both API and WebSocket. It can be specified in two ways:

At query string, as &apikey=your_api_key
At header, as Authorization="apikey your_api_key"

A demo API key is used for sample requests to familiarize yourself with the API format. Complete access to API is available with your API key, which can be obtained for free by signing up for the Basic plan. Specific endpoints are available starting only from Grow, Pro, Ultra or Enterprise plans. However, they all can be tested as trial symbols across all markets. API will return an error if the key is invalid or has insufficient permissions.

Endpoints

API endpoints are prefixed with https://api.twelvedata.com

WebSocket endpoints are prefixed with wss://ws.twelvedata.com

Parameters

How to separate

Parameters are ampersand(&) separated. E.g. ?symbol=AAPL&interval=5min&outputsize=200

Casting

Word casing doesn‘t matter when passing parameters. E.g. ?symbol=AAPL, ?symbol=AaPl, or ?symbol=aapl will all correctly work.

CSV

When the format parameter is set to CSV, additional filename parameter might be used to specify the custom name of the output file. E.g. ?format=CSV&filename=my_own_csv_name

Dates

To get the most use of start_date, end_date, and outputsize parameters when accessing historical data, refer to this tutorial.

Response

Empty values

For data returned in JSON format, in certain cases, instead of numerical values or objects, the response may include a null value. It is important to note that this is not an error; rather, it indicates that there is no available data for the specified metric. Users should handle null values appropriately in their applications to ensure smooth functionality and accurate data representation.

Errors

Twelve Data API uses a unified error response scheme. Consisting of a JSON object with code, message and status keys.

Possible output error codes are:

Code	Status	Meaning
400	Bad Request	There is an error with one or multiple parameters.
401	Unauthorized	Your API key is wrong or not valid.
403	Forbidden	Your API key is valid but has no permissions to make request available on the upper plans.
404	Not Found	The specified data can not be found.
414	Parameter Too Long	The parameter which accepts multiple values is out of range.
429	Too Many Requests	You've reached your API request limits.
500	Internal Server Error	There is an error on the server-side. Try again later.

How to overcome the errors:

400 Follow message instructions in response. Usually, it will arise if one of the input parameters is set incorrectly. Try to read over API Documentation and modify the parameter.
401 Invalid API key is used. If you don't have one yet - get it here.
403 Upgrade your API key to an upper plan here.
404 Query parameters are set too strict and accordingly, data can not be loaded. Try to set less rigid parameters values.
414 Arises when the parameter accepts an array of values and length of the array is larger than the maximum number allowed. Follow the message instructions and set the parameter accordingly.
429 API key minute limit is reached. Either wait for a while or increase your API key limits here
500 Very rare to appear, signifying some server-side errors. In this case, contact us and we will settle down the issue.

HTTP request example:

https://api.twelvedata.com/time_series?symbol=AAPL&interval=0.99min&apikey=your_api_key

This request with incorrect interval set will return JSON with the following structure:

{
"code": 400,
"message": "Invalid **interval** provided: 0.99min. Supported intervals: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month",
"status": "error"
}

Roadmap

We continuously make Twelve Data the only place where all users can obtain the necessary financial data. If you have any questions or ideas about improvement, contact us.

Libraries

Here, we publish libraries created to get the most of Twelve Data. We work towards making the industry the best SDKs for the most popular languages. Large releases are coming soon. A full list can be found on GitHub.

Official libraries and Add-ins

Language	URL
Python	twelvedata-python
R	twelvedata-r-sdk
Excel	Excel Add-in
Google Sheets	Google Sheets Add-on

Third-party libraries

Language	URL
C#	TwelveDataSharp
JavaScript	twelvedata
PHP	twelvedata
Go	twelvedata

The same list can also be accessed at the Support Center.

Support

Please refer to the Help Center for general assistance. If your question has not been answered yet drop a message to us.

Reference data

Reference Data returns general data that can be used to enhance your project generalization.

Stocks list

/stocks

This API call returns an array of symbols available at Twelve Data API. This list is updated daily.

API credits cost

1 per request

Parameters Response

symbol

string

The ticker symbol of an instrument for which data is requested

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG000B9Y5X2

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Filter by exchange name

Example: NASDAQ

mic_code

string

Filter by market identifier code (MIC) under ISO 10383 standard

Example: XNGS

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

type

string

The asset class to which the instrument belongs

Supports: American Depositary Receipt, Bond, Bond Fund, Closed-end Fund, Common Stock, Depositary Receipt, Digital Currency, ETF, Exchange-Traded Note, Global Depositary Receipt, Index, Limited Partnership, Mutual Fund, Physical Currency, Preferred Stock, REIT, Right, Structured Product, Trust, Unit, Warrant

Example: Common Stock

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

show_plan

boolean

Adds info on which plan symbol is available

Default: false

include_delisted

boolean

Include delisted identifiers

Default: false

data

array of object

List of stock instruments

Attributes

symbol

string

Instrument symbol (ticker)

name

string

Full name of instrument

currency

string

Currency of the instrument according to the ISO 4217 standard

exchange

string

Exchange where instrument is traded

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

country

string

Country where exchange is located

type

string

Common issue type

figi_code

string

Financial instrument global identifier (FIGI)

cfi_code

string

Classification of Financial Instruments (CFI)

isin

string

International securities identification number (ISIN), available by individual request to support

access

object

Info on which plan symbol is available (displayed then show_plan is true)

Attributes

global

string

Level of access to the symbol

plan

string

The plan name for the symbol

status

string

Response status

Request example

https://api.twelvedata.com/stocks?apikey=demo&source=docs

Response

{
    "data": [
        {
            "symbol": "AAPL",
            "name": "Apple Inc",
            "currency": "USD",
            "exchange": "NASDAQ",
            "mic_code": "XNGS",
            "country": "United States",
            "type": "Common Stock",
            "figi_code": "BBG000B9Y5X2",
            "cfi_code": "ESVUFR",
            "isin": "US0378331005",
            "access": {
                "global": "Level A",
                "plan": "Grow"
            }
        }
    ],
    "status": "ok"
}

Forex pairs list

/forex_pairs

This API call returns an array of forex pairs available at Twelve Data API. This list is updated daily.

API credits cost

1 per request

Parameters Response

symbol

string

The ticker symbol of an instrument for which data is requested

Example: EUR/USD

currency_base

string

Filter by currency base

Example: EUR

currency_quote

string

Filter by currency quote

Example: USD

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

Request example

https://api.twelvedata.com/forex_pairs?apikey=demo&source=docs

Response

{
    "data": [
        {
            "symbol": "EUR/USD",
            "currency_group": "Major",
            "currency_base": "EUR",
            "currency_quote": "USD"
        }
    ],
    "status": "ok"
}

Commodities list

/commodities

This API call returns an array of commodity pairs available at Twelve Data API. This list is updated daily.

API credits cost

1 per request

Parameters Response

symbol

string

The ticker symbol of an instrument for which data is requested

Example: XAU/USD

category

string

Filter by category of commodity

Example: Precious Metal

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

Request example

https://api.twelvedata.com/commodities?apikey=demo&source=docs

Response

{
    "data": [
        {
            "symbol": "XAU/USD",
            "name": "Gold Spot",
            "category": "Precious Metal",
            "description": ""
        }
    ],
    "status": "ok"
}

Cryptocurrencies list

/cryptocurrencies

This API call returns an array of cryptocurrencies available at Twelve Data API. This list is updated daily.

API credits cost

1 per request

Parameters Response

symbol

string

The ticker symbol of an instrument for which data is requested

Example: BTC/USD

exchange

string

Filter by exchange name. E.g. Binance, Coinbase, etc.

Example: Binance

currency_base

string

Filter by currency base

Example: BTC

currency_quote

string

Filter by currency quote

Example: USD

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

Request example

https://api.twelvedata.com/cryptocurrencies?apikey=demo&source=docs

Response

{
    "data": [
        {
            "symbol": "BTC/USD",
            "available_exchanges": [
                "ABCC",
                "Allcoin",
                "BTC-Alpha",
                "BTCTurk",
                "Bibox",
                "n.exchange",
                "p2pb2b",
                "xBTCe"
            ],
            "currency_base": "Bitcoin",
            "currency_quote": "US Dollar"
        }
    ],
    "status": "ok"
}

Funds list

/funds

This API call returns an array of funds available at Twelve Data API. This list is updated daily.

API credits cost

1 per request

Parameters Response

symbol

string

The ticker symbol of an instrument for which data is requested

Example: FXAIX

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG000BHTMY7

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Filter by exchange name

Example: Nasdaq

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

show_plan

boolean

Adds info on which plan symbol is available

Default: false

page

integer

Page number of the results to fetch

Default: 1

outputsize

integer

Determines the number of data points returned in the output

Default: 5000

result

object

Attributes

count

integer

Total number of matching instruments

list

array of object

Attributes

symbol

string

Instrument symbol (ticker)

name

string

Full name of the fund

country

string

Country where the fund is located

currency

string

Currency of the fund according to the ISO 4217 standard

exchange

string

Exchange where the fund is traded

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

type

string

Type of the fund

figi_code

string

Financial instrument global identifier (FIGI)

cfi_code

string

Classification of Financial Instruments (CFI)

isin

string

International securities identification number (ISIN)

access

object

Info on which plan symbol is available (displayed then show_plan is true)

Attributes

global

string

Level of access to the symbol

plan

string

The plan name for the symbol

status

string

Status of the response

Request example

https://api.twelvedata.com/funds?apikey=demo&source=docs

Response

{
    "result": {
        "count": 84799,
        "list": [
            {
                "symbol": "DIVI",
                "name": "AdvisorShares Athena High Dividend ETF",
                "country": "United States",
                "currency": "USD",
                "exchange": "NYSE",
                "mic_code": "ARCX",
                "type": "ETF",
                "figi_code": "BBG00161BCW4",
                "cfi_code": "CECILU",
                "isin": "GB00B65TLW28",
                "access": {
                    "global": "Level A",
                    "plan": "Grow"
                }
            }
        ]
    },
    "status": "ok"
}

Bonds list

/bonds

This API call returns an array of bonds available at Twelve Data API. This list is updated daily.

API credits cost

1 per request

Parameters Response

symbol

string

The ticker symbol of an instrument for which data is requested

Example: US2Y

exchange

string

Filter by exchange name

Example: NYSE

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

show_plan

boolean

Adds info on which plan symbol is available

Default: false

page

integer

Page number of the results to fetch

Default: 1

outputsize

integer

Determines the number of data points returned in the output

Default: 5000

result

object

Attributes

count

integer

Total number of matching instruments

list

array of object

Attributes

symbol

string

Bond symbol

name

string

Full name of the bond

country

string

Country where the bond is located

currency

string

Currency of the bond according to the ISO 4217 standard

exchange

string

Exchange where the bond is traded

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

type

string

Type of the bond

access

object

Info on which plan symbol is available (displayed then show_plan is true)

Attributes

global

string

Level of access to the symbol

plan

string

The plan name for the symbol

status

string

Response status

Request example

https://api.twelvedata.com/bonds?apikey=demo&source=docs

Response

{
    "result": {
        "count": 6,
        "list": [
            {
                "symbol": "US2Y",
                "name": "US Treasury Yield 2 Years",
                "country": "United States",
                "currency": "USD",
                "exchange": "NYSE",
                "mic_code": "XNYS",
                "type": "Bond",
                "access": {
                    "global": "Level A",
                    "plan": "Grow"
                }
            }
        ]
    },
    "status": "ok"
}

ETFs list

/etfs

This API call returns an array of ETFs available at Twelve Data API. This list is updated daily.

API credits cost

1 per request

Parameters Response

symbol

string

The ticker symbol of an instrument for which data is requested

Example: SPY

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG000BDTF76

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Filter by exchange name

Example: NYSE

mic_code

string

Filter by market identifier code (MIC) under ISO 10383 standard

Example: XNYS

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

show_plan

boolean

Adds info on which plan symbol is available

Default: false

include_delisted

boolean

Include delisted identifiers

Default: false

data

array of object

List of ETFs

Attributes

symbol

string

Instrument symbol (ticker)

name

string

Full name of the ETF

currency

string

Currency of the ETF according to the ISO 4217 standard

exchange

string

Exchange where the ETF is traded

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

country

string

Country where the ETF is located

figi_code

string

Financial instrument global identifier (FIGI)

cfi_code

string

Classification of Financial Instruments (CFI)

isin

string

International securities identification number (ISIN)

access

object

Info on which plan symbol is available (displayed then show_plan is true)

Attributes

global

string

Level of access to the symbol

plan

string

The plan name for the symbol

status

string

Response status

Request example

https://api.twelvedata.com/etfs?apikey=demo&source=docs

Response

{
    "data": [
        {
            "symbol": "SPY",
            "name": "SPDR S&P 500 ETF Trust",
            "currency": "USD",
            "exchange": "NYSE",
            "mic_code": "XNYS",
            "country": "United States",
            "figi_code": "BBG000BDTF76",
            "cfi_code": "CEOJLU",
            "isin": "US78462F1030",
            "access": {
                "global": "Level B",
                "plan": "Pro"
            }
        }
    ],
    "status": "ok"
}

Cross listings

/cross_listings

This API call returns an array of cross listed symbols for a specified instrument. Cross listings are the same securities listed on different exchanges. This list is updated daily.

API credits cost

40 per request

Parameters Response

✱ symbol

string

The ticker symbol of an instrument for which data is requested

Example: NVDA

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

Example: XNGS

country

string

Country to which stock exchange belongs to

Example: United States

Request example

https://api.twelvedata.com/cross_listings?symbol=NVDA&apikey=demo&source=docs

Response

{
    "result": {
        "count": 7,
        "list": [
            {
                "symbol": "NVDA",
                "name": "NVIDIA Corp",
                "exchange": "NASDAQ",
                "mic_code": "XNGS"
            }
        ]
    }
}

Exchanges High demand

/exchanges

This API call returns an array of stock or ETF exchanges available at Twelve Data API. This list is updated daily.

API credits cost

1 per request

Parameters Response

type

string

The asset class to which the instrument belongs

Supports: 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: ETF

name

string

Filter by exchange name

Example: NASDAQ

code

string

Filter by market identifier code (MIC) under ISO 10383 standard

Example: XNGS

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

show_plan

boolean

Adds info on which plan symbol is available

Default: false

Request example

https://api.twelvedata.com/exchanges?apikey=demo&source=docs

Response

{
    "data": [
        {
            "title": "NASDAQ",
            "name": "NASDAQ",
            "code": "XNGS",
            "country": "United States",
            "timezone": "America/New_York",
            "access": {
                "global": "Level A",
                "plan": "Grow"
            }
        }
    ],
    "status": "ok"
}

Exchange schedule

/exchange_schedule

This API call return exchanges details and trading hours.

API credits cost

100 per request

This API endpoint is available starting with the Ultra plan.

Parameters Response

date

string

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
A full datetime string in UTC (e.g., 2025-04-11 20:00:00) to retrieve the schedule corresponding to the day in the specified time.

When using a datetime value, the resulting schedule will correspond to the local calendar day at the specified time. For example, 2025-04-11 20:00:00 UTC corresponds to:

2025-04-11 in the America/New_York timezone
2025-04-12 in the Australia/Sydney timezone

Example: 2021-10-27

mic_name

string

Filter by exchange name

Example: NASDAQ

mic_code

string

Filter by market identifier code (MIC) under ISO 10383 standard

Example: XNGS

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

Request example

https://api.twelvedata.com/exchange_schedule?apikey=demo&source=docs

Response

{
    "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"
                }
            ]
        }
    ]
}

Cryptocurrency exchanges

/cryptocurrency_exchanges

This API call returns an array of cryptocurrency exchanges available at Twelve Data API. This list is updated daily.

API credits cost

1 per request

Parameters Response

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

Specify the delimiter used when downloading the CSV file

Default: ;

Request example

https://api.twelvedata.com/cryptocurrency_exchanges?apikey=demo&source=docs

Response

{
    "data": [
        {
            "name": "Binance"
        }
    ],
    "status": "ok"
}

Market state

/market_state

Check the state of all available exchanges, time to open, and time to close. Returns all available stock exchanges by default.

API credits cost

1 per request

Parameters Response

exchange

string

The exchange name where the instrument is traded.

Example: NYSE

code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

Example: XNYS

country

string

The country where the exchange is located. Takes country name or alpha code.

Example: United States

Request example

https://api.twelvedata.com/market_state?apikey=demo&source=docs

Response

[
    {
        "name": "NYSE",
        "code": "XNYS",
        "country": "United States",
        "is_market_open": true,
        "time_after_open": "02:39:03",
        "time_to_open": "00:00:00",
        "time_to_close": "05:20:57"
    }
]

Instrument type

/instrument_type

This API call returns a list of instrument types available at Twelve Data API.

API credits cost

1 per request

Parameters Response

No parameters are required

Request example

https://api.twelvedata.com/instrument_type?apikey=demo&source=docs

Response

{
    "result": [
        "Agricultural Product",
        "American Depositary Receipt",
        "Bond",
        "Bond Fund",
        "Closed-end Fund",
        "Common Stock",
        "Depositary Receipt",
        "Digital Currency",
        "Energy Resource",
        "ETF",
        "Exchange-Traded Note",
        "Global Depositary Receipt",
        "Index",
        "Industrial Metal",
        "Limited Partnership",
        "Livestock",
        "Mutual Fund",
        "Physical Currency",
        "Precious Metal",
        "Preferred Stock",
        "REIT",
        "Right",
        "Structured Product",
        "Trust",
        "Unit",
        "Warrant"
    ],
    "status": "ok"
}

Countries list

/countries

This API call returns an array of countries available at Twelve Data API with their ISO codes, names, capital, and currency.

API credits cost

1 per request

Parameters Response

No parameters are required

Request example

https://api.twelvedata.com/countries?apikey=demo&source=docs

Response

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

Technical indicators interface

/technical_indicators

This API call returns an array of objects with available technical indicators. This endpoint might be used to build an abstract interface to make more convenient API calls from the application.

API credits cost

1 per request

Parameters Response

No parameters are required

data

object

Map of technical indicators available at Twelve Data API

Attributes

parameter_name

object

Technical indicator name

Attributes

enable

boolean

If the indicator is tested, approved and is recommended for use returns true, otherwise returns false

full_name

string

Full indicator name

description

string

Brief description of the indicator

type

string

Group to which indicator belongs to

overlay

boolean

If indicator should be plotted over price bars returns true, otherwise returns false

output_values

object

An array of output values

Attributes

parameter_name

object

Output parameter name. Example values: ad, add, adxr, aroonosc, macd, macd_signal, macd_hist, etc

Attributes

default_color

string

Suggested color for displaying returns hex color code

display

string

How output value should be rendered

min_range

integer

If output value has minimum bound

max_range

integer

If output value has maximum bound

parameters

object

An array of input parameters for the indicator

Attributes

parameter_name

object

Input parameter name. Example values: series_type, fast_period, slow_period, time_period, signal_period

Attributes

default

integer

Specifies parameter value set by default

max_range

integer

If the parameter has upper bound in order to ensure correct calculation

min_range

integer

If the parameter has lower bound in order to ensure correct calculation

range

array of string

An array of available parameter values

type

string

Type of parameter might be string, int, float or array

tinting

object

An array of tinting values used for proper indicator coloring

Attributes

display

string

How the tinting should be rendered

color

string

Hex color code for the tinting

transparency

double

Transparency level, float value from 0 to 1

lower_bound

string

Lower bound of tinting, can be a number or a return parameter name

upper_bound

string

Upper bound of tinting, can be a number or a return parameter name

status

string

Response status

Request example

https://api.twelvedata.com/technical_indicators?apikey=demo&source=docs

Response

{
    "data": {
        "parameter_name": {
            "enable": true,
            "full_name": "Moving Average Convergence Divergence",
            "description": "Moving Average Convergence Divergence(MACD) is ...",
            "type": "Momentum Indicators",
            "overlay": false,
            "output_values": {
                "parameter_name": {
                    "default_color": "#FF0000",
                    "display": "line",
                    "min_range": 0,
                    "max_range": 5
                }
            },
            "parameters": {
                "parameter_name": {
                    "default": 12,
                    "max_range": 1,
                    "min_range": 1,
                    "range": [
                        "open",
                        "high",
                        "low",
                        "close"
                    ],
                    "type": "int"
                }
            },
            "tinting": {
                "display": "fill",
                "color": "#FF0000",
                "transparency": 0.5,
                "lower_bound": "0",
                "upper_bound": "macd"
            }
        }
    },
    "status": "ok"
}

Earliest timestamp

/earliest_timestamp

This method returns the first available DateTime for a given instrument at the specific interval.

API credits cost

1 per request

Parameters Response

✱ symbol

string

Symbol ticker of the instrument.

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI).

Example: BBG000B9XRY4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series.

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 1day, 1week, 1month

Example: 1day

exchange

string

Exchange where instrument is traded.

Example: Nasdaq

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard.

Example: XNAS

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

Request example

https://api.twelvedata.com/earliest_timestamp?symbol=AAPL&interval=1day&apikey=demo&source=docs

Response

{
    "datetime": "1980-12-12",
    "unix_time": 345479400
}

Symbol search High demand

/symbol_search

This method helps to find the best matching symbol. It can be used as the base for custom lookups. The response is returned in descending order, with the most relevant instrument at the beginning.

API credits cost

1 per request

Parameters Response

✱ symbol

string

Symbol to search

Example: AAPL

outputsize

integer

Number of matches in response. Max 120

Default: 30

show_plan

boolean

Adds info on which plan symbol is available.

Default: false

data

array of object

List of symbols matching the search criteria

Attributes

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 then show_plan is true)

Attributes

global

string

Level of access to the symbol

plan

string

The plan name for the symbol

status

string

Status of the response

Request example

https://api.twelvedata.com/symbol_search?symbol=AAPL&apikey=demo&source=docs

Response

{
    "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"
            }
        }
    ],
    "status": "ok"
}

Core data

Core data return time series, quotes, rates, and other prices across equities, forex, cryptocurrencies, and ETFs along with other data types.

Time series High demand

/time_series

This API call returns meta and time series for the requested instrument. Metaobject consists of general information about the requested symbol. Time series is the array of objects ordered by time descending with Open, High, Low, Close prices. Non-currency instruments also include volume information.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Returns quotes that include pre-market and post-market data. Only for Pro and above plans. Available at the 1min, 5min, 15min, and 30min intervals for all US equities. Open, high, low, close values are supplied without volume.

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

values

array of object

List of time series data points

Attributes

datetime

string

Datetime at local exchange time referring to when the bar with specified interval was opened.

open

string

Price at the opening of current bar

high

string

Highest price which occurred during the current bar.

low

string

Lowest price which occurred during the current bar.

string

Close price at the end of the bar.

volume

string

Trading volume which occurred during the current bar

status

string

Response status

Request example

https://api.twelvedata.com/time_series?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock"
    },
    "values": [
        {
            "datetime": "2021-09-16 15:59:00",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Time series cross

/time_series/cross

This API call returns meta and cross rate time series for the requested instruments. Metaobject consists of general information about the requested symbol. Time series is the array of objects ordered by time descending with Open, High, Low, Close prices. Works with stocks, forex and cryptocurrency.

API credits cost

5 per symbol

Parameters Response

✱ base

string

Base currency symbol

Example: JPY

base_type

string

Base instrument type according to the /instrument_type endpoint

Example: Physical Currency

base_exchange

string

Base exchange

Example: Binance

base_mic_code

string

Base MIC code

Example: XNGS

✱ quote

string

Quote currency symbol

Example: BTC

quote_type

string

Quote instrument type according to the /instrument_type endpoint

Example: Digital Currency

quote_exchange

string

Quote exchange

Example: Coinbase

quote_mic_code

string

Quote MIC code

Example: XNYS

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 1day, 1week, 1month

Example: 1min

outputsize

integer

Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set, otherwise set to maximum

Example: 30

format

string

Format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

Delimiter used in CSV file

Default: ;

prepost

boolean

Only for Pro and above plans. Available at the 1min, 5min, 15min, and 30min intervals for all US equities. Open, high, low, close values are supplied without volume.

Default: false

start_date

string

Start date for the time series data

Example: 2025-01-01

end_date

string

End date for the time series data

Example: 2025-01-31

adjust

boolean

Specifies if there should be an adjustment

Default: true

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive.

Default: 5

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Example: UTC

Request example

https://api.twelvedata.com/time_series/cross?base=JPY&quote=BTC&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "interval": "1min",
        "base_exchange": "PHYSICAL CURRENCY",
        "quote_exchange": "Binance"
    },
    "values": [
        {
            "datetime": "2025-02-28 14:30:00",
            "open": "0.0000081115665",
            "high": "0.0000081273069",
            "low": "0.0000081088287",
            "close": "0.0000081268066"
        }
    ]
}

Exchange rate

/exchange_rate

This API call returns real-time exchange rate for currency pair. Works with forex and cryptocurrency.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

The currency pair you want to request can be either forex or cryptocurrency. Slash(/) delimiter is used. E.g. EUR/USD or BTC/ETH will be correct

Example: EUR/USD

date

string

If not null, will use exchange rate from a specific date or time. Format 2006-01-02 or 2006-01-02 15:04:05. Is set in the local exchange time zone, use timezone parameter to specify a specific time zone

Example: 2006-01-02 15:04:05

format

string

Value can be JSON or CSV. Default JSON

Supports: JSON, CSV

Default: JSON

delimiter

string

Specify the delimiter used when downloading the CSV file. Default semicolon ;

Default: ;

integer

The number of decimal places for the data

Default: 5

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Example: UTC

Request example

https://api.twelvedata.com/exchange_rate?symbol=EUR/USD&apikey=demo&source=docs

Response

{
    "symbol": "USD/JPY",
    "rate": 105.12,
    "timestamp": 1602714051
}

Currency conversion Useful

/currency_conversion

This API call returns real-time exchange rate and converted amount for currency pair. Works with forex and cryptocurrency.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

The currency pair you want to request can be either forex or cryptocurrency. Slash(/) delimiter is used. E.g. EUR/USD or BTC/ETH will be correct

Example: EUR/USD

✱ amount

number

Amount of base currency to be converted into quote currency. Supports values in the range from 0 and above

Example: 100

date

string

Example: 2006-01-02 15:04:05

format

string

Value can be JSON or CSV. Default JSON

Supports: JSON, CSV

Default: JSON

delimiter

string

Specify the delimiter used when downloading the CSV file. Default semicolon ;

Default: ;

integer

The number of decimal places for the data

Default: 5

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Example: UTC

Request example

https://api.twelvedata.com/currency_conversion?symbol=EUR/USD&amount=100&apikey=demo&source=docs

Response

{
    "symbol": "USD/JPY",
    "rate": 105.12,
    "amount": 12824.64,
    "timestamp": 1602714051
}

Quote High demand

/quote

Quote endpoint is an efficient method to retrieve the latest quote of the selected instrument.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG000BHTMY7

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

interval

string

Interval of the quote

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 1day, 1week, 1month

Default: 1day

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: United States

volume_time_period

integer

Number of periods for Average Volume

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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: ETF

format

string

Value can be JSON or CSV Default JSON

Supports: JSON, CSV

Default: JSON

delimiter

string

Specify the delimiter used when downloading the CSV file

Default: ;

prepost

boolean

Parameter is optional. Only for Pro and above plans. Available at the 1min, 5min, 15min, and 30min intervals for all US equities. Open, high, low, close values are supplied without volume.

Default: false

eod

boolean

If true, then return data for closed day

Supports: true, false

Default: false

rolling_period

integer

Number of hours for calculate rolling change at period. By default set to 24, it can be in range [1, 168].

Default: 24

integer

Specifies the number of decimal places for floating values Should be in range [0,11] inclusive

Default: 5

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

symbol

string

Symbol passed

name

string

Name of the instrument

exchange

string

Exchange where instrument is traded

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

currency

string

Currency in which the equity is denominated

datetime

string

Datetime in defined timezone referring to when the bar with specified interval was opened

timestamp

integer

Unix timestamp representing the opening candle of the specified interval

last_quote_at

integer

Unix timestamp of last minute candle

open

string

Price at the opening of current bar

high

string

Highest price which occurred during the current bar

low

string

Lowest price which occurred during the current bar

string

Close price at the end of the bar

volume

string

Trading volume during the bar

previous_close

string

Close price at the end of the previous bar

change

string

Close - previous_close

percent_change

string

(Close - previous_close) / previous_close * 100

average_volume

string

Average volume of the specified period

rolling_1day_change

string

Percent change in price between the current and the backward one, where period is 1 day, available for crypto

rolling_7day_change

string

Percent change in price between the current and the backward one, where period is 7 days, available for crypto

rolling_period_change

string

Percent change in price between the current and the backward one, where period specified in request param rolling_period, available for crypto

is_market_open

boolean

True if market is open; false if closed

fifty_two_week

object

Collection of 52-week metrics

Attributes

low

string

52-week low price

high

string

52-week high price

low_change

string

Current price - 52-week low

high_change

string

Current price - 52-week high

low_change_percent

string

Percentage change from 52-week low

high_change_percent

string

Percentage change from 52-week high

range

string

Range between 52-week low and high

extended_change

string

Diff between the regular close price and the latest extended price

extended_percent_change

string

Percent change in price between the regular close price and the latest extended price

extended_price

string

Latest extended price

extended_timestamp

string

Unix timestamp of the last extended price

Request example

https://api.twelvedata.com/quote?symbol=AAPL&apikey=demo&source=docs

Response

{
    "symbol": "AAPL",
    "name": "Apple Inc",
    "exchange": "NASDAQ",
    "mic_code": "XNAS",
    "currency": "USD",
    "datetime": "2021-09-16",
    "timestamp": 1631772000,
    "last_quote_at": 1631772000,
    "open": "148.44000",
    "high": "148.96840",
    "low": "147.22099",
    "close": "148.85001",
    "volume": "67903927",
    "previous_close": "149.09000",
    "change": "-0.23999",
    "percent_change": "-0.16097",
    "average_volume": "83571571",
    "rolling_1day_change": "123.123",
    "rolling_7day_change": "123.123",
    "rolling_period_change": "123.123",
    "is_market_open": false,
    "fifty_two_week": {
        "low": "103.10000",
        "high": "157.25999",
        "low_change": "45.75001",
        "high_change": "-8.40999",
        "low_change_percent": "44.37440",
        "high_change_percent": "-5.34782",
        "range": "103.099998 - 157.259995"
    },
    "extended_change": "0.09",
    "extended_percent_change": "0.05",
    "extended_price": "125.22",
    "extended_timestamp": "1649845281"
}

Real-time price High demand

/price

This endpoint is a lightweight method that allows retrieving only the real-time price of the selected instrument.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG000BHTMY7

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: United States

type

string

The asset class to which the instrument belongs

Supports: 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: ETF

format

string

Value can be JSON or CSV

Supports: JSON, CSV

Default: JSON

delimiter

string

Specify the delimiter used when downloading the CSV file

Default: ;

prepost

boolean

Parameter is optional. Only for Pro and above plans. Available at the 1min, 5min, 15min, and 30min intervals for all US equities. Open, high, low, close values are supplied without volume.

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0,11] inclusive

Default: 5

Request example

https://api.twelvedata.com/price?symbol=AAPL&apikey=demo&source=docs

Response

{
    "price": "200.99001"
}

End of day price

/eod

This endpoint returns the latest End of Day (EOD) price of an instrument.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG000BHTMY7

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: United States

type

string

The asset class to which the instrument belongs

Supports: 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: ETF

date

string

If not null, then return data from a specific date

Example: 2006-01-02

prepost

boolean

Parameter is optional. Only for Pro and above plans. Available at the 1min, 5min, 15min, and 30min intervals for all US equities. Open, high, low, close values are supplied without volume.

Default: false

integer

Specifies the number of decimal places for floating values Should be in range [0,11] inclusive

Default: 5

Request example

https://api.twelvedata.com/eod?symbol=AAPL&apikey=demo&source=docs

Response

{
    "symbol": "AAPL",
    "exchange": "NASDAQ",
    "mic_code": "XNAS",
    "currency": "USD",
    "datetime": "2021-09-16",
    "close": "148.79"
}

Market movers

/market_movers/{market}

Get the list of the top gaining or losing stocks today.

Top gainers are ordered by the highest rate of price increase since the previous day''s close. Top losers are ordered by the highest percentage of price decrease since the last day.

Data is available for all international equities, forex, crypto.

API credits cost

100 per request

This API endpoint is available starting with the Pro plan.

Parameters Response

✱ market

string

Maket type

Supports: stocks, etf, mutual_funds, forex, crypto

Example: stocks

direction

string

Specifies direction of the snapshot gainers or losers

Supports: gainers, losers

Default: gainers

outputsize

integer

Specifies the size of the snapshot. Can be in a range from 1 to 50

Default: 30

country

string

Country of the snapshot, applicable to non-currencies only. Takes country name or alpha code

Default: USA

price_greater_than

string

Takes values with price grater than specified value

Example: 175.5

string

Specifies the number of decimal places for floating values. Should be in range [0,11] inclusive

Default: 5

values

array of object

Market movers list

Attributes

symbol

string

The exchange symbol ticker

name

string

The official name of the instrument

exchange

string

Exchange where instrument is traded

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

datetime

string

The last updated datetime timestamp

last

double

The latest available price for the symbol today

high

double

The highest price for the symbol today

low

double

The lowest price for the symbol today

volume

integer

The trading volume of the symbol today

change

double

The value of the change since the previous day

percent_change

double

The percentage change since the previous day

status

string

Response status

Request example

https://api.twelvedata.com/market_movers/stocks?apikey=demo&source=docs

Response

{
    "values": [
        {
            "symbol": "BSET",
            "name": "Bassett Furniture Industries Inc",
            "exchange": "NASDAQ",
            "mic_code": "XNAS",
            "datetime": "2023-10-01T12:00:00Z",
            "last": 17.25,
            "high": 18,
            "low": 16.5,
            "volume": 108297,
            "change": 3.31,
            "percent_change": 23.74462
        }
    ],
    "status": "ok"
}

Mutual funds

MFs list Useful

/mutual_funds/list

This API request returns a list of mutual funds available at Twelve Data. Sorting is in descending order by total assets value. The list is updated daily.

API credits cost

1 per request

With Basic, Grow, and Pro plans, only 50 records will be in response. Ultra, Enterprise and Custom plans can access complete data on over 140,000 Mutual Funds.

Parameters Response

symbol

string

Filter by symbol

Example: 1535462D

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG00HMMLCH1

isin

string

Filter by international securities identification number (ISIN)

Example: LU1206782309

cusip

string

The CUSIP of an instrument for which data is requested

Example: 120678230

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

fund_family

string

Filter by investment company that manages the fund

Example: Jackson National

fund_type

string

Filter by the type of fund

Example: Small Blend

performance_rating

integer

Filter by performance rating from 0 to 5

Example: 4

risk_rating

integer

Filter by risk rating from 0 to 5

Example: 4

page

integer

Page number

Default: 1

outputsize

integer

Number of records in response

Default: 100

result

object

Response result

Attributes

count

integer

Total number of matching funds

list

array of object

List of mutual funds

Attributes

symbol

string

Fund symbol ticker

name

string

Fund name

country

string

Country of fund incorporation

fund_family

string

Investment company that manages the fund

fund_type

string

Type of fund

performance_rating

integer

Performance rating from 0 to 5

risk_rating

integer

Risk rating from 0 to 5

currency

string

Currency code in which the fund is denominated

exchange

string

Exchange name where the fund is listed

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

status

string

Response status

Request example

https://api.twelvedata.com/mutual_funds/list?apikey=demo&source=docs

Response

{
    "result": {
        "count": 1000,
        "list": [
            {
                "symbol": "0P0001LCQ3",
                "name": "JNL Small Cap Index Fund (I)",
                "country": "United States",
                "fund_family": "Jackson National",
                "fund_type": "Small Blend",
                "performance_rating": 2,
                "risk_rating": 4,
                "currency": "USD",
                "exchange": "OTC",
                "mic_code": "OTCM"
            }
        ]
    },
    "status": "ok"
}

MFs family list

/mutual_funds/family

This API request returns a list of mutual funds families.

API credits cost

1 per request

Parameters Response

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

fund_family

string

Filter by investment company that manages the fund

Example: Jackson National

Request example

https://api.twelvedata.com/mutual_funds/family?apikey=demo&source=docs

Response

{
    "result": {
        "India": [
            "Aberdeen Standard Fund Managers Limited",
            "Aditya Birla Sun Life AMC Ltd"
        ],
        "United States": [
            "Aegon Asset Management UK PLC",
            "Ampega Investment GmbH",
            "Aviva SpA"
        ]
    },
    "status": "ok"
}

MFs type list

/mutual_funds/type

This API request returns a list of mutual funds types.

API credits cost

1 per request

Parameters Response

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

fund_type

string

Filter by the type of fund

Example: Jackson National

Request example

https://api.twelvedata.com/mutual_funds/type?apikey=demo&source=docs

Response

{
    "result": {
        "Singapore": [
            "Property - Indirect Asia",
            "Sector Equity Water",
            "SGD Bond",
            "Singapore Equity",
            "Taiwan Large-Cap Equity"
        ],
        "United States": [
            "Asia-Pacific ex-Japan Equity",
            "EUR Flexible Allocation - Global",
            "Euro Short Bond PP",
            "Large Blend",
            "Other Allocation"
        ]
    },
    "status": "ok"
}

All data High demand

/mutual_funds/world

This API request returns a complete breakdown of a mutual fund, including summary, performance, risk, ratings, composition, purchase_info, and sustainability.

API credits cost

1000 per request

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Symbol ticker of mutual fund

Example: 1535462D

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG00HMMLCH1

isin

string

Filter by international securities identification number (ISIN)

Example: LU1206782309

cusip

string

The CUSIP of an instrument for which data is requested

Example: 120678230

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

integer

Number of decimal places for floating values. Accepts value in range [0,11]

Default: 5

mutual_fund

object

Mutual fund information

Attributes

summary

object

A brief summary of a mutual fund

Attributes

symbol

string

All available fund types segmented by country

name

string

Fund name

fund_family

string

Investment company that manages the fund

fund_type

string

Type of the fund

currency

string

Currency of fund price

share_class_inception_date

string

The date from which the fund started operations and the returns are calculated

ytd_return

double

Percentage of profit of the fund since the first trading day of the current calendar year

expense_ratio_net

double

Percentage of mutual fund assets steered toward a fund's operating expenses and fund management fees

yield

double

Income returned to its investors through interest and dividends generated by the fund's investments

nav

double

Net Asset Value: fund value minus liabilities

min_investment

integer

Investment minimum

turnover_rate

double

Percentage rate at which mutual fund replaces its holdings on investment every year

net_assets

integer

Total assets of a fund minus its total liabilities

overview

string

Description of the fund

people

array of object

Information about the fund’s managers

Attributes

name

string

Manager name

tenure_since

string

Manager tenuring date

performance

object

Detailed performance of a mutual fund

Attributes

trailing_returns

array of object

Trailing returns of the fund

Attributes

period

string

Period of trailing returns

share_class_return

double

Fund returns (%) generated over a given period

category_return

double

Same category average returns (%) generated over a given period

rank_in_category

integer

Rank of a fund in category by total returns

annual_total_returns

array of object

Annual total returns of the fund

Attributes

year

integer

Year of total returns

share_class_return

double

Fund total returns (%) generated over a given year

category_return

double

Same category average total returns (%) generated over a given year

quarterly_total_returns

array of object

Quarterly total returns of the fund

Attributes

year

integer

Year of a fund quarter return

double

Total return (%) of a fund in the first quarter

double

Total return (%) of a fund in the second quarter

double

Total return (%) of a fund in the third quarter

double

Total return (%) of a fund in the fourth quarter

load_adjusted_return

array of object

Load adjusted return of the fund

Attributes

period

string

Period of a load adjusted return

return

double

Actual return (%) an investor sees after accounting for fees and sales charges are deducted from a mutual fund's performance

risk

object

Risk metrics of a mutual fund

Attributes

volatility_measures

array of object

Volatility statistics of the fund

Attributes

period

string

Period of a measure

alpha

double

Alpha score of a fund

alpha_category

double

Average alpha score of a fund's category

beta

double

Beta score of a fund

beta_category

double

Average beta score of a fund's category

mean_annual_return

double

Mean annual return of a fund

mean_annual_return_category

double

Average mean annual return of a fund's category

r_squared

double

R-squared metric of a fund

r_squared_category

double

Average r-squared metric of a fund's category

std

double

Standard deviation of a fund

std_category

double

Average standard deviation of a fund's category

sharpe_ratio

double

Sharpe ratio of a fund

sharpe_ratio_category

double

Average sharpe ratio of a fund's category

treynor_ratio

double

Treynor ratio of a fund

treynor_ratio_category

double

Average treynor ratio of a fund's category

valuation_metrics

object

Valuation ratios and metrics of the fund and its category

Attributes

price_to_earnings

double

Fund price to earnings metric

price_to_earnings_category

double

Average price to earnings metric of funds in the same category

price_to_book

double

Fund price to book metric

price_to_book_category

double

Average price to book metric of funds in the same category

price_to_sales

double

Fund price to sales metric

price_to_sales_category

double

Average price to sales metric of funds in the same category

price_to_cashflow

double

Fund price to cashflow metric

price_to_cashflow_category

double

Average price to cashflow metric of funds in the same category

median_market_capitalization

integer

Median market capitalization of a fund

median_market_capitalization_category

integer

Median market capitalization of funds in the same category

3_year_earnings_growth

double

Earnings growth over the last three years

3_year_earnings_growths_category

double

Earnings growth over the last three years of funds in the same category

ratings

object

Ratings of a mutual fund

Attributes

performance_rating

integer

Performance rating from 0 to 5

risk_rating

integer

Risk rating from 0 to 5

return_rating

integer

Return rating from 0 to 5

composition

object

Composition of a mutual fund

Attributes

major_market_sectors

array of object

Breakdown of the fund’s portfolio by major industry sectors and their respective weights

Attributes

sector

string

Sector category of a fund exposure

weight

double

Weight (%) of a fund exposure in a sector

asset_allocation

object

Asset allocation of the fund by different asset classes and their respective weights

Attributes

cash

double

Percentage of overall portfolio composition in cash

stocks

double

Percentage of overall portfolio composition in stocks

preferred_stocks

double

Percentage of overall portfolio composition in preferred stocks

convertables

double

Percentage of overall portfolio composition in convertable securities

bonds

double

Percentage of overall portfolio composition in bond

others

double

Percentage of overall portfolio composition in other forms of holding

top_holdings

array of object

Top holdings of the fund with their respective weights in the overall portfolio composition

Attributes

symbol

string

Symbol ticker of a holding instrument

name

string

Name of a holding instrument

weight

double

Weight (%) of a holding instrument in overall portfolio composition

bond_breakdown

object

Breakdown of the fund’s bond holdings by maturity, duration, and credit quality

Attributes

average_maturity

object

Average maturity of bond holdings for the fund and its category

Attributes

fund

string

Average maturity of bond holding of a fund

category

double

Average maturity of bond holding of funds in the same category

average_duration

object

Average duration of bond holdings for the fund and its category

Attributes

fund

string

Average duration of bond holding of a fund

category

double

Average duration of bond holding of funds in the same category

credit_quality

array of object

Breakdown of the fund’s bond holdings by credit rating and their respective portfolio weights

Attributes

grade

string

Rating of bond holding of a fund from AAA to below B

weight

double

Weight of bond holding in fund portfolio

purchase_info

object

Purchase information of a mutual fund

Attributes

expenses

object

Costs associated with investing in the mutual fund, including gross and net expense ratios

Attributes

expense_ratio_gross

double

Cost of investing in a mutual fund

expense_ratio_net

double

Percentage of mutual fund assets steered toward a fund's operating expenses and fund management fees

minimums

object

Minimum investment amounts required to purchase or add to the mutual fund, including IRA minimums

Attributes

initial_investment

integer

Investment minimum

additional_investment

integer

Minimum amount of additional investment

initial_ira_investment

string

Investment minimum for IRA

additional_ira_investment

string

Minimum amount of additional investment for IRA

pricing

object

Pricing information for the mutual fund

Attributes

nav

double

Net Asset Value: fund value minus liabilities

12_month_low

double

Lowest price of the fund over the last year

12_month_high

double

Highest price of the fund over the last year

last_month

double

Fund price at the end of the last month

brokerages

array of string

List of brokerages where mutual fund can be purchased

sustainability

object

Sustainability information of a mutual fund

Attributes

score

integer

Sustainability score: asset-weighted average of normalized company-level ESG Scores for the covered holdings in the portfolio from 0 to 100

corporate_esg_pillars

object

Corporate ESG pillars

Attributes

environmental

double

ESG environmental score

social

double

ESG social score

governance

double

ESG governance score

sustainable_investment

boolean

Indication that the fund discloses in their prospectus that they employ socially responsible or ESG principles in their investment selection processes

corporate_aum

double

Percentage of AUM used to calculate sustainability score

status

string

Status of the response

Request example

https://api.twelvedata.com/mutual_funds/world?symbol=1535462D&apikey=demo&source=docs

Response

{
    "mutual_fund": {
        "summary": {
            "symbol": "0P0001LCQ3",
            "name": "JNL Small Cap Index Fund (I)",
            "fund_family": "Jackson National",
            "fund_type": "Small Blend",
            "currency": "USD",
            "share_class_inception_date": "2021-04-26",
            "ytd_return": -0.02986,
            "expense_ratio_net": 0.001,
            "yield": 0,
            "nav": 10.09,
            "min_investment": 0,
            "turnover_rate": 0.32,
            "net_assets": 2400762112,
            "overview": "The fund invests, normally, at least 80% of its assets in the stocks...",
            "people": [
                {
                    "name": "John Doe",
                    "tenure_since": "2018-01-01"
                }
            ]
        },
        "performance": {
            "trailing_returns": [
                {
                    "period": "ytd",
                    "share_class_return": -0.02986,
                    "category_return": 0.2019,
                    "rank_in_category": 76
                }
            ],
            "annual_total_returns": [
                {
                    "year": 2024,
                    "share_class_return": 0.08546,
                    "category_return": 0.1119
                }
            ],
            "quarterly_total_returns": [
                {
                    "year": 2024,
                    "q1": 0.02358,
                    "q2": -0.03071,
                    "q3": 0.10099,
                    "q4": -0.00629
                }
            ],
            "load_adjusted_return": [
                {
                    "period": "1_year",
                    "return": 0.06139
                }
            ]
        },
        "risk": {
            "volatility_measures": [
                {
                    "period": "3_year",
                    "alpha": -9.12,
                    "alpha_category": -0.0939,
                    "beta": 1,
                    "beta_category": 0.0126,
                    "mean_annual_return": 0.45,
                    "mean_annual_return_category": 0.0117,
                    "r_squared": 69,
                    "r_squared_category": 0.8309,
                    "std": 23.15,
                    "std_category": 0.2554,
                    "sharpe_ratio": 0.04,
                    "sharpe_ratio_category": 0.005,
                    "treynor_ratio": -1.41,
                    "treynor_ratio_category": 0.0806
                }
            ],
            "valuation_metrics": {
                "price_to_earnings": 0.05695,
                "price_to_earnings_category": 20.63,
                "price_to_book": 0.55626,
                "price_to_book_category": 2.87,
                "price_to_sales": 0.97803,
                "price_to_sales_category": 1.34,
                "price_to_cashflow": 0.10564,
                "price_to_cashflow_category": 11.81,
                "median_market_capitalization": 2965,
                "median_market_capitalization_category": 4925,
                "3_year_earnings_growth": 16.32,
                "3_year_earnings_growths_category": 10.55
            }
        },
        "ratings": {
            "performance_rating": 2,
            "risk_rating": 4,
            "return_rating": 0
        },
        "composition": {
            "major_market_sectors": [
                {
                    "sector": "Industrials",
                    "weight": 0.1742
                }
            ],
            "asset_allocation": {
                "cash": 0.0043,
                "stocks": 0.9956,
                "preferred_stocks": 0,
                "convertables": 0,
                "bonds": 0,
                "others": 0
            },
            "top_holdings": [
                {
                    "symbol": "BBWI",
                    "name": "Bath & Body Works Inc",
                    "weight": 0.00624
                }
            ],
            "bond_breakdown": {
                "average_maturity": {
                    "fund": null,
                    "category": 1.97
                },
                "average_duration": {
                    "fund": null,
                    "category": 1.64
                },
                "credit_quality": [
                    {
                        "grade": "U.S. Government",
                        "weight": 0
                    }
                ]
            }
        },
        "purchase_info": {
            "expenses": {
                "expense_ratio_gross": 0.0022,
                "expense_ratio_net": 0.001
            },
            "minimums": {
                "initial_investment": 0,
                "additional_investment": 0,
                "initial_ira_investment": null,
                "additional_ira_investment": null
            },
            "pricing": {
                "nav": 10.09,
                "12_month_low": 9.630000114441,
                "12_month_high": 12.10000038147,
                "last_month": 11.050000190735
            },
            "brokerages": []
        },
        "sustainability": {
            "score": 22,
            "corporate_esg_pillars": {
                "environmental": 3.73,
                "social": 10.44,
                "governance": 7.86
            },
            "sustainable_investment": false,
            "corporate_aum": 0.99486
        }
    },
    "status": "ok"
}

Summary

/mutual_funds/world/summary

This API request returns a brief summary of a mutual fund.

API credits cost

200 per request

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Symbol ticker of mutual fund

Example: 1535462D

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG00HMMLCH1

isin

string

Filter by international securities identification number (ISIN)

Example: LU1206782309

cusip

string

The CUSIP of an instrument for which data is requested

Example: 120678230

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

integer

Number of decimal places for floating values. Accepts value in range [0,11]

Default: 5

mutual_fund

object

Mutual fund information

Attributes

summary

object

A brief summary of a mutual fund

Attributes

symbol

string

All available fund types segmented by country

name

string

Fund name

fund_family

string

Investment company that manages the fund

fund_type

string

Type of the fund

currency

string

Currency of fund price

share_class_inception_date

string

The date from which the fund started operations and the returns are calculated

ytd_return

double

Percentage of profit of the fund since the first trading day of the current calendar year

expense_ratio_net

double

Percentage of mutual fund assets steered toward a fund's operating expenses and fund management fees

yield

double

Income returned to its investors through interest and dividends generated by the fund's investments

nav

double

Net Asset Value: fund value minus liabilities

min_investment

integer

Investment minimum

turnover_rate

double

Percentage rate at which mutual fund replaces its holdings on investment every year

net_assets

integer

Total assets of a fund minus its total liabilities

overview

string

Description of the fund

people

array of object

Information about the fund’s managers

Attributes

name

string

Manager name

tenure_since

string

Manager tenuring date

status

string

Status of the response

Request example

https://api.twelvedata.com/mutual_funds/world/summary?symbol=1535462D&apikey=demo&source=docs

Response

{
    "mutual_fund": {
        "summary": {
            "symbol": "0P0001LCQ3",
            "name": "JNL Small Cap Index Fund (I)",
            "fund_family": "Jackson National",
            "fund_type": "Small Blend",
            "currency": "USD",
            "share_class_inception_date": "2021-04-26",
            "ytd_return": -0.02986,
            "expense_ratio_net": 0.001,
            "yield": 0,
            "nav": 10.09,
            "min_investment": 0,
            "turnover_rate": 0.32,
            "net_assets": 2400762112,
            "overview": "The fund invests, normally, at least 80% of its assets in the stocks...",
            "people": [
                {
                    "name": "John Doe",
                    "tenure_since": "2018-01-01"
                }
            ]
        }
    },
    "status": "ok"
}

Performance High demand

/mutual_funds/world/performance

This API request returns detailed performance of a mutual fund, including trailing, annual, quarterly, and load-adjusted returns.

API credits cost

200 per request

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Symbol ticker of mutual fund

Example: 1535462D

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG00HMMLCH1

isin

string

Filter by international securities identification number (ISIN)

Example: LU1206782309

cusip

string

The CUSIP of an instrument for which data is requested

Example: 120678230

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

integer

Number of decimal places for floating values. Accepts value in range [0,11]

Default: 5

mutual_fund

object

Mutual fund information

Attributes

performance

object

Detailed performance of a mutual fund

Attributes

trailing_returns

array of object

Trailing returns of the fund

Attributes

period

string

Period of trailing returns

share_class_return

double

Fund returns (%) generated over a given period

category_return

double

Same category average returns (%) generated over a given period

rank_in_category

integer

Rank of a fund in category by total returns

annual_total_returns

array of object

Annual total returns of the fund

Attributes

year

integer

Year of total returns

share_class_return

double

Fund total returns (%) generated over a given year

category_return

double

Same category average total returns (%) generated over a given year

quarterly_total_returns

array of object

Quarterly total returns of the fund

Attributes

year

integer

Year of a fund quarter return

double

Total return (%) of a fund in the first quarter

double

Total return (%) of a fund in the second quarter

double

Total return (%) of a fund in the third quarter

double

Total return (%) of a fund in the fourth quarter

load_adjusted_return

array of object

Load adjusted return of the fund

Attributes

period

string

Period of a load adjusted return

return

double

Actual return (%) an investor sees after accounting for fees and sales charges are deducted from a mutual fund's performance

status

string

Status of the response

Request example

https://api.twelvedata.com/mutual_funds/world/performance?symbol=1535462D&apikey=demo&source=docs

Response

{
    "mutual_fund": {
        "performance": {
            "trailing_returns": [
                {
                    "period": "ytd",
                    "share_class_return": -0.02986,
                    "category_return": 0.2019,
                    "rank_in_category": 76
                }
            ],
            "annual_total_returns": [
                {
                    "year": 2024,
                    "share_class_return": 0.08546,
                    "category_return": 0.1119
                }
            ],
            "quarterly_total_returns": [
                {
                    "year": 2024,
                    "q1": 0.02358,
                    "q2": -0.03071,
                    "q3": 0.10099,
                    "q4": -0.00629
                }
            ],
            "load_adjusted_return": [
                {
                    "period": "1_year",
                    "return": 0.06139
                }
            ]
        }
    },
    "status": "ok"
}

Risk

/mutual_funds/world/risk

This API request returns core metrics to measure the risk of investing in a mutual fund.

API credits cost

200 per request

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Symbol ticker of mutual fund

Example: 1535462D

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG00HMMLCH1

isin

string

Filter by international securities identification number (ISIN)

Example: LU1206782309

cusip

string

The CUSIP of an instrument for which data is requested

Example: 120678230

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

integer

Number of decimal places for floating values. Accepts value in range [0,11]

Default: 5

mutual_fund

object

Mutual fund information

Attributes

risk

object

Risk and volatility statistics of the fund and its category over different periods

Attributes

volatility_measures

array of object

Volatility statistics of the fund

Attributes

period

string

Period of a measure

alpha

double

Alpha score of a fund

alpha_category

double

Average alpha score of a fund's category

beta

double

Beta score of a fund

beta_category

double

Average beta score of a fund's category

mean_annual_return

double

Mean annual return of a fund

mean_annual_return_category

double

Average mean annual return of a fund's category

r_squared

double

R-squared metric of a fund

r_squared_category

double

Average r-squared metric of a fund's category

std

double

Standard deviation of a fund

std_category

double

Average standard deviation of a fund's category

sharpe_ratio

double

Sharpe ratio of a fund

sharpe_ratio_category

double

Average sharpe ratio of a fund's category

treynor_ratio

double

Treynor ratio of a fund

treynor_ratio_category

double

Average treynor ratio of a fund's category

valuation_metrics

object

Valuation ratios and metrics of the fund and its category

Attributes

price_to_earnings

double

Fund price to earnings metric

price_to_earnings_category

double

Average price to earnings metric of funds in the same category

price_to_book

double

Fund price to book metric

price_to_book_category

double

Average price to book metric of funds in the same category

price_to_sales

double

Fund price to sales metric

price_to_sales_category

double

Average price to sales metric of funds in the same category

price_to_cashflow

double

Fund price to cashflow metric

price_to_cashflow_category

double

Average price to cashflow metric of funds in the same category

median_market_capitalization

integer

Median market capitalization of a fund

median_market_capitalization_category

integer

Median market capitalization of funds in the same category

3_year_earnings_growth

double

Earnings growth over the last three years

3_year_earnings_growths_category

double

Earnings growth over the last three years of funds in the same category

status

string

Status of the response

Request example

https://api.twelvedata.com/mutual_funds/world/risk?symbol=1535462D&apikey=demo&source=docs

Response

{
    "mutual_fund": {
        "risk": {
            "volatility_measures": [
                {
                    "period": "3_year",
                    "alpha": -9.12,
                    "alpha_category": -0.0939,
                    "beta": 1,
                    "beta_category": 0.0126,
                    "mean_annual_return": 0.45,
                    "mean_annual_return_category": 0.0117,
                    "r_squared": 69,
                    "r_squared_category": 0.8309,
                    "std": 23.15,
                    "std_category": 0.2554,
                    "sharpe_ratio": 0.04,
                    "sharpe_ratio_category": 0.005,
                    "treynor_ratio": -1.41,
                    "treynor_ratio_category": 0.0806
                }
            ],
            "valuation_metrics": {
                "price_to_earnings": 0.05695,
                "price_to_earnings_category": 20.63,
                "price_to_book": 0.55626,
                "price_to_book_category": 2.87,
                "price_to_sales": 0.97803,
                "price_to_sales_category": 1.34,
                "price_to_cashflow": 0.10564,
                "price_to_cashflow_category": 11.81,
                "median_market_capitalization": 2965,
                "median_market_capitalization_category": 4925,
                "3_year_earnings_growth": 16.32,
                "3_year_earnings_growths_category": 10.55
            }
        }
    },
    "status": "ok"
}

Ratings

/mutual_funds/world/ratings

This API request returns ratings of a mutual fund.

API credits cost

200 per request

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Symbol ticker of mutual fund

Example: 1535462D

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG00HMMLCH1

isin

string

Filter by international securities identification number (ISIN)

Example: LU1206782309

cusip

string

The CUSIP of an instrument for which data is requested

Example: 120678230

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

integer

Number of decimal places for floating values. Accepts value in range [0,11]

Default: 5

Request example

https://api.twelvedata.com/mutual_funds/world/ratings?symbol=1535462D&apikey=demo&source=docs

Response

{
    "mutual_fund": {
        "ratings": {
            "performance_rating": 2,
            "risk_rating": 4,
            "return_rating": 0
        }
    },
    "status": "ok"
}

Composition High demand

/mutual_funds/world/composition

This API request returns portfolio composition of a mutual fund, including sectors, holding details, weighted exposure, and others.

API credits cost

200 per request

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Symbol ticker of mutual fund

Example: 1535462D

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG00HMMLCH1

isin

string

Filter by international securities identification number (ISIN)

Example: LU1206782309

cusip

string

The CUSIP of an instrument for which data is requested

Example: 120678230

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

integer

Number of decimal places for floating values. Accepts value in range [0,11]

Default: 5

mutual_fund

object

Mutual fund information

Attributes

composition

object

Mutual fund composition

Attributes

major_market_sectors

array of object

Breakdown of the fund’s portfolio by major industry sectors and their respective weights

Attributes

sector

string

Sector category of a fund exposure

weight

double

Weight (%) of a fund exposure in a sector

asset_allocation

object

Asset allocation of the fund by different asset classes and their respective weights

Attributes

cash

double

Percentage of overall portfolio composition in cash

stocks

double

Percentage of overall portfolio composition in stocks

preferred_stocks

double

Percentage of overall portfolio composition in preferred stocks

convertables

double

Percentage of overall portfolio composition in convertable securities

bonds

double

Percentage of overall portfolio composition in bond

others

double

Percentage of overall portfolio composition in other forms of holding

top_holdings

array of object

Top holdings of the fund with their respective weights in the overall portfolio composition

Attributes

symbol

string

Symbol ticker of a holding instrument

name

string

Name of a holding instrument

weight

double

Weight (%) of a holding instrument in overall portfolio composition

bond_breakdown

object

Breakdown of the fund’s bond holdings by maturity, duration, and credit quality

Attributes

average_maturity

object

Average maturity of bond holdings for the fund and its category

Attributes

fund

string

Average maturity of bond holding of a fund

category

double

Average maturity of bond holding of funds in the same category

average_duration

object

Average duration of bond holdings for the fund and its category

Attributes

fund

string

Average duration of bond holding of a fund

category

double

Average duration of bond holding of funds in the same category

credit_quality

array of object

Breakdown of the fund’s bond holdings by credit rating and their respective portfolio weights

Attributes

grade

string

Rating of bond holding of a fund from AAA to below B

weight

double

Weight of bond holding in fund portfolio

status

string

Status of the response

Request example

https://api.twelvedata.com/mutual_funds/world/composition?symbol=1535462D&apikey=demo&source=docs

Response

{
    "mutual_fund": {
        "composition": {
            "major_market_sectors": [
                {
                    "sector": "Industrials",
                    "weight": 0.1742
                }
            ],
            "asset_allocation": {
                "cash": 0.0043,
                "stocks": 0.9956,
                "preferred_stocks": 0,
                "convertables": 0,
                "bonds": 0,
                "others": 0
            },
            "top_holdings": [
                {
                    "symbol": "BBWI",
                    "name": "Bath & Body Works Inc",
                    "weight": 0.00624
                }
            ],
            "bond_breakdown": {
                "average_maturity": {
                    "fund": null,
                    "category": 1.97
                },
                "average_duration": {
                    "fund": null,
                    "category": 1.64
                },
                "credit_quality": [
                    {
                        "grade": "U.S. Government",
                        "weight": 0
                    }
                ]
            }
        }
    },
    "status": "ok"
}

Purchase info

/mutual_funds/world/purchase_info

This API request returns essential information on purchasing a mutual fund, including minimums, pricing, and available brokerages.

API credits cost

200 per request

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Symbol ticker of mutual fund

Example: 1535462D

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG00HMMLCH1

isin

string

Filter by international securities identification number (ISIN)

Example: LU1206782309

cusip

string

The CUSIP of an instrument for which data is requested

Example: 120678230

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

integer

Number of decimal places for floating values. Accepts value in range [0,11]

Default: 5

mutual_fund

object

Mutual fund information

Attributes

purchase_info

object

Purchase information for the mutual fund

Attributes

expenses

object

Costs associated with investing in the mutual fund, including gross and net expense ratios

Attributes

expense_ratio_gross

double

Cost of investing in a mutual fund

expense_ratio_net

double

Percentage of mutual fund assets steered toward a fund's operating expenses and fund management fees

minimums

object

Minimum investment amounts required to purchase or add to the mutual fund, including IRA minimums

Attributes

initial_investment

integer

Investment minimum

additional_investment

integer

Minimum amount of additional investment

initial_ira_investment

string

Investment minimum for IRA

additional_ira_investment

string

Minimum amount of additional investment for IRA

pricing

object

Pricing information for the mutual fund

Attributes

nav

double

Net Asset Value: fund value minus liabilities

12_month_low

double

Lowest price of the fund over the last year

12_month_high

double

Highest price of the fund over the last year

last_month

double

Fund price at the end of the last month

brokerages

array of string

List of brokerages where mutual fund can be purchased

status

string

Status of the response

Request example

https://api.twelvedata.com/mutual_funds/world/purchase_info?symbol=1535462D&apikey=demo&source=docs

Response

{
    "mutual_fund": {
        "purchase_info": {
            "expenses": {
                "expense_ratio_gross": 0.0022,
                "expense_ratio_net": 0.001
            },
            "minimums": {
                "initial_investment": 0,
                "additional_investment": 0,
                "initial_ira_investment": null,
                "additional_ira_investment": null
            },
            "pricing": {
                "nav": 10.09,
                "12_month_low": 9.630000114441,
                "12_month_high": 12.10000038147,
                "last_month": 11.050000190735
            },
            "brokerages": []
        }
    },
    "status": "ok"
}

Sustainability

/mutual_funds/world/sustainability

This API request returns brief information on mutual fund sustainability and ESG.

API credits cost

200 per request

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Symbol ticker of mutual fund

Example: 1535462D

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG00HMMLCH1

isin

string

Filter by international securities identification number (ISIN)

Example: LU1206782309

cusip

string

The CUSIP of an instrument for which data is requested

Example: 120678230

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

integer

Number of decimal places for floating values. Accepts value in range [0,11]

Default: 5

mutual_fund

object

Mutual fund information

Attributes

sustainability

object

Sustainability score and ESG (Environmental, Social, Governance) metrics for the fund

Attributes

score

integer

Sustainability score: asset-weighted average of normalized company-level ESG Scores for the covered holdings in the portfolio from 0 to 100

corporate_esg_pillars

object

Corporate ESG pillars

Attributes

environmental

double

ESG environmental score

social

double

ESG social score

governance

double

ESG governance score

sustainable_investment

boolean

Indication that the fund discloses in their prospectus that they employ socially responsible or ESG principles in their investment selection processes

corporate_aum

double

Percentage of AUM used to calculate sustainability score

status

string

Status of the response

Request example

https://api.twelvedata.com/mutual_funds/world/sustainability?symbol=1535462D&apikey=demo&source=docs

Response

{
    "mutual_fund": {
        "sustainability": {
            "score": 22,
            "corporate_esg_pillars": {
                "environmental": 3.73,
                "social": 10.44,
                "governance": 7.86
            },
            "sustainable_investment": false,
            "corporate_aum": 0.99486
        }
    },
    "status": "ok"
}

ETFs

ETFs list Useful

/etfs/list

This API request returns a list of exchange traded funds available at Twelve Data. Sorting is in descending order by total assets value. The list is updated daily.

API credits cost

1 per request

With Basic, Grow, and Pro plans, only 50 records will be in response. Ultra, Enterprise and Custom plans can access complete data on over 46,000 ETFs.

Parameters Response

symbol

string

Filter by symbol

Example: IVV

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG000BVZ697

isin

string

Filter by international securities identification number (ISIN)

Example: US4642872000

cusip

string

The CUSIP of an instrument for which data is requested

Example: 464287200

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

fund_family

string

Filter by investment company that manages the fund

Example: iShares

fund_type

string

Filter by the type of fund

Example: Large Blend

page

integer

Page number

Default: 1

outputsize

integer

Number of records in response

Default: 50

Request example

https://api.twelvedata.com/etfs/list?apikey=demo&source=docs

Response

{
    "result": {
        "count": 1000,
        "list": [
            {
                "symbol": "IVV",
                "name": "iShares Core S&P 500 ETF",
                "country": "United States",
                "mic_code": "XNAS",
                "fund_family": "iShares",
                "fund_type": "Large Blend"
            }
        ]
    },
    "status": "ok"
}

ETFs family list

/etfs/family

This API request returns a list of exchange traded funds families.

API credits cost

1 per request

Parameters Response

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

fund_family

string

Filter by investment company that manages the fund

Example: iShares

Request example

https://api.twelvedata.com/etfs/family?apikey=demo&source=docs

Response

{
    "result": {
        "India": [
            "Aberdeen Standard Fund Managers Limited",
            "Aditya Birla Sun Life AMC Ltd"
        ],
        "United States": [
            "Aegon Asset Management UK PLC",
            "Ampega Investment GmbH",
            "Aviva SpA"
        ]
    },
    "status": "ok"
}

ETFs type list

/etfs/type

This API request returns a list of exchange traded funds types.

API credits cost

1 per request

Parameters Response

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

fund_type

string

Filter by the type of fund

Example: Large Blend

Request example

https://api.twelvedata.com/etfs/type?apikey=demo&source=docs

Response

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

All data High demand

/etfs/world

This API request returns a complete breakdown of a etf, including summary, performance, risk and composition.

API credits cost

800 per request

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Symbol ticker of etf

Example: IVV

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG000BVZ697

isin

string

Filter by international securities identification number (ISIN)

Example: US4642872000

cusip

string

The CUSIP of an instrument for which data is requested

Example: 464287200

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

integer

Number of decimal places for floating values. Accepts value in range [0,11]

Default: 5

etf

object

Etf information

Attributes

summary

object

A brief summary of a etf

Attributes

symbol

string

All available fund types segmented by country

name

string

Fund name

fund_family

string

Investment company that manages the fund

fund_type

string

Type of the fund

currency

string

Currency of fund price

share_class_inception_date

string

The date from which the fund started operations and the returns are calculated

ytd_return

double

Percentage of profit of the fund since the first trading day of the current calendar year

expense_ratio_net

double

Percentage of ETF assets steered toward a fund's operating expenses and fund management fees

yield

double

Income returned to its investors through interest and dividends generated by the fund's investments

nav

double

Net Asset Value: fund value minus liabilities

last_price

double

Last price of the fund

turnover_rate

double

Percentage rate at which ETF replaces its holdings on investment every year

net_assets

integer

Total assets of a fund minus its total liabilities

overview

string

Description of the fund

performance

object

Detailed performance of a etf

Attributes

trailing_returns

array of object

Performance returns of the fund and its category over various trailing time periods

Attributes

period

string

Period of trailing returns

share_class_return

double

Fund returns (%) generated over a given period

category_return

double

Same category average returns (%) generated over a given period

annual_total_returns

array of object

Fund and category total returns (%) for each calendar year

Attributes

year

integer

Year of total returns

share_class_return

double

Fund total returns (%) generated over a given year

category_return

double

Same category average total returns (%) generated over a given year

risk

object

Risk metrics of a etf

Attributes

volatility_measures

array of object

Risk and volatility statistics of the fund and its category over different periods

Attributes

period

string

Period of a measure

alpha

double

Alpha score of a fund

alpha_category

double

Average alpha score of a fund's category

beta

double

Beta score of a fund

beta_category

double

Average beta score of a fund's category

mean_annual_return

double

Mean annual return of a fund

mean_annual_return_category

double

Average mean annual return of a fund's category

r_squared

double

R-squared metric of a fund

r_squared_category

double

Average r-squared metric of a fund's category

std

double

Standard deviation of a fund

std_category

double

Average standard deviation of a fund's category

sharpe_ratio

double

Sharpe ratio of a fund

sharpe_ratio_category

double

Average sharpe ratio of a fund's category

treynor_ratio

double

Treynor ratio of a fund

treynor_ratio_category

double

Average treynor ratio of a fund's category

valuation_metrics

object

Valuation ratios and metrics of the fund and its category

Attributes

price_to_earnings

double

Fund price to earnings metric

price_to_book

double

Fund price to book metric

price_to_sales

double

Fund price to sales metric

price_to_cashflow

double

Fund price to cashflow metric

composition

object

Composition of a etf

Attributes

major_market_sectors

array of object

Breakdown of the fund’s portfolio by major industry sectors and their respective weights

Attributes

sector

string

Sector category of a fund exposure

weight

double

Weight (%) of a fund exposure in a sector

country_allocation

array of object

Breakdown of the fund’s portfolio by country and their respective weights

Attributes

country

string

Country name

allocation

double

Percentages of a fund's net assets distributed to securities of the country

asset_allocation

object

Asset allocation of a fund by different asset classes and their respective weights

Attributes

cash

double

Percentage of overall portfolio composition in cash

stocks

double

Percentage of overall portfolio composition in stocks

preferred_stocks

double

Percentage of overall portfolio composition in preferred stocks

convertables

double

Percentage of overall portfolio composition in convertable securities

bonds

double

Percentage of overall portfolio composition in bond

others

double

Percentage of overall portfolio composition in other forms of holding

top_holdings

array of object

Top holdings of a fund with their respective weights in the overall portfolio composition

Attributes

symbol

string

Symbol ticker of a holding instrument

name

string

Name of a holding instrument

weight

double

Weight (%) of a holding instrument in overall portfolio composition

bond_breakdown

object

Breakdown of the fund’s portfolio by bond holding characteristics

Attributes

average_maturity

object

Average credit rating of bond holding of a fund

Attributes

fund

double

Average maturity of bond holding of a fund

category

double

Average maturity of bond holding of funds in the same category

average_duration

object

Average duration of bond holding of a fund

Attributes

fund

double

Average duration of bond holding of a fund

category

double

Average duration of bond holding of funds in the same category

credit_quality

array of object

Breakdown of the fund’s bond holdings by credit rating and their respective portfolio weights

Attributes

grade

string

Rating of bond holding of a fund from AAA to below B

weight

double

Weight of bond holding in fund portfolio

status

string

Status of the response

Request example

https://api.twelvedata.com/etfs/world?symbol=IVV&apikey=demo&source=docs

Response

{
    "etf": {
        "summary": {
            "symbol": "IVV",
            "name": "iShares Core S&P 500 ETF",
            "fund_family": "iShares",
            "fund_type": "Large Blend",
            "currency": "USD",
            "share_class_inception_date": "2000-11-13",
            "ytd_return": -0.0537,
            "expense_ratio_net": -0.004,
            "yield": 0.0133,
            "nav": 413.24,
            "last_price": 413.24,
            "turnover_rate": 0.04,
            "net_assets": 753409982464,
            "overview": "The investment seeks to track the performance of the Standard & Poor's 500..."
        },
        "performance": {
            "trailing_returns": [
                {
                    "period": "ytd",
                    "share_class_return": -0.0751,
                    "category_return": 0.1484
                }
            ],
            "annual_total_returns": [
                {
                    "year": 2021,
                    "share_class_return": 0.2866,
                    "category_return": 0
                }
            ]
        },
        "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
            }
        },
        "composition": {
            "major_market_sectors": [
                {
                    "sector": "Technology",
                    "weight": 0.2424
                }
            ],
            "country_allocation": [
                {
                    "country": "United Kingdom",
                    "allocation": 0.9855
                }
            ],
            "asset_allocation": {
                "cash": 0.0004,
                "stocks": 0.9996,
                "preferred_stocks": 0,
                "convertables": 0,
                "bonds": 0,
                "others": 0
            },
            "top_holdings": [
                {
                    "symbol": "AAPL",
                    "name": "Apple Inc",
                    "weight": 0.0592
                }
            ],
            "bond_breakdown": {
                "average_maturity": {
                    "fund": 6.65,
                    "category": 7.81
                },
                "average_duration": {
                    "fund": 5.72,
                    "category": 5.64
                },
                "credit_quality": [
                    {
                        "grade": "AAA",
                        "weight": 0
                    }
                ]
            }
        }
    },
    "status": "ok"
}

Summary

/etfs/world/summary

This API request returns a brief summary of a etf.

API credits cost

200 per request

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Symbol ticker of etf

Example: IVV

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG000BVZ697

isin

string

Filter by international securities identification number (ISIN)

Example: US4642872000

cusip

string

The CUSIP of an instrument for which data is requested

Example: 464287200

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

integer

Number of decimal places for floating values. Accepts value in range [0,11]

Default: 5

etf

object

Etf information

Attributes

summary

object

A brief summary of a ETF

Attributes

symbol

string

All available fund types segmented by country

name

string

Fund name

fund_family

string

Investment company that manages the fund

fund_type

string

Type of the fund

currency

string

Currency of fund price

share_class_inception_date

string

The date from which the fund started operations and the returns are calculated

ytd_return

double

Percentage of profit of the fund since the first trading day of the current calendar year

expense_ratio_net

double

Percentage of ETF assets steered toward a fund's operating expenses and fund management fees

yield

double

Income returned to its investors through interest and dividends generated by the fund's investments

nav

double

Net Asset Value: fund value minus liabilities

last_price

double

Last price of the fund

turnover_rate

double

Percentage rate at which ETF replaces its holdings on investment every year

net_assets

integer

Total assets of a fund minus its total liabilities

overview

string

Description of the fund

status

string

Status of the response

Request example

https://api.twelvedata.com/etfs/world/summary?symbol=IVV&apikey=demo&source=docs

Response

{
    "etf": {
        "summary": {
            "symbol": "IVV",
            "name": "iShares Core S&P 500 ETF",
            "fund_family": "iShares",
            "fund_type": "Large Blend",
            "currency": "USD",
            "share_class_inception_date": "2000-11-13",
            "ytd_return": -0.0537,
            "expense_ratio_net": -0.004,
            "yield": 0.0133,
            "nav": 413.24,
            "last_price": 413.24,
            "turnover_rate": 0.04,
            "net_assets": 753409982464,
            "overview": "The investment seeks to track the performance of the Standard & Poor's 500..."
        }
    },
    "status": "ok"
}

Performance High demand

/etfs/world/performance

This API request returns detailed performance of a etf, including trailing and annual returns.

API credits cost

200 per request

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Symbol ticker of etf

Example: IVV

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG000BVZ697

isin

string

Filter by international securities identification number (ISIN)

Example: US4642872000

cusip

string

The CUSIP of an instrument for which data is requested

Example: 464287200

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

integer

Number of decimal places for floating values. Accepts value in range [0,11]

Default: 5

etf

object

Etf information

Attributes

performance

object

Detailed performance of a etf

Attributes

trailing_returns

array of object

Performance returns of the fund and its category over various trailing time periods

Attributes

period

string

Period of trailing returns

share_class_return

double

Fund returns (%) generated over a given period

category_return

double

Same category average returns (%) generated over a given period

annual_total_returns

array of object

Fund and category total returns (%) for each calendar year

Attributes

year

integer

Year of total returns

share_class_return

double

Fund total returns (%) generated over a given year

category_return

double

Same category average total returns (%) generated over a given year

status

string

Status of the response

Request example

https://api.twelvedata.com/etfs/world/performance?symbol=IVV&apikey=demo&source=docs

Response

{
    "etf": {
        "performance": {
            "trailing_returns": [
                {
                    "period": "ytd",
                    "share_class_return": -0.0751,
                    "category_return": 0.1484
                }
            ],
            "annual_total_returns": [
                {
                    "year": 2021,
                    "share_class_return": 0.2866,
                    "category_return": 0
                }
            ]
        }
    },
    "status": "ok"
}

Risk

/etfs/world/risk

This API request returns core metrics to measure the risk of investing in a etf.

API credits cost

200 per request

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Symbol ticker of etf

Example: IVV

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG000BVZ697

isin

string

Filter by international securities identification number (ISIN)

Example: US4642872000

cusip

string

The CUSIP of an instrument for which data is requested

Example: 464287200

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

integer

Number of decimal places for floating values. Accepts value in range [0,11]

Default: 5

etf

object

Etf information

Attributes

risk

object

Risk metrics of a etf

Attributes

volatility_measures

array of object

Risk and volatility statistics of the fund and its category over different periods

Attributes

period

string

Period of a measure

alpha

double

Alpha score of a fund

alpha_category

double

Average alpha score of a fund's category

beta

double

Beta score of a fund

beta_category

double

Average beta score of a fund's category

mean_annual_return

double

Mean annual return of a fund

mean_annual_return_category

double

Average mean annual return of a fund's category

r_squared

double

R-squared metric of a fund

r_squared_category

double

Average r-squared metric of a fund's category

std

double

Standard deviation of a fund

std_category

double

Average standard deviation of a fund's category

sharpe_ratio

double

Sharpe ratio of a fund

sharpe_ratio_category

double

Average sharpe ratio of a fund's category

treynor_ratio

double

Treynor ratio of a fund

treynor_ratio_category

double

Average treynor ratio of a fund's category

valuation_metrics

object

Valuation ratios and metrics of the fund and its category

Attributes

price_to_earnings

double

Fund price to earnings metric

price_to_book

double

Fund price to book metric

price_to_sales

double

Fund price to sales metric

price_to_cashflow

double

Fund price to cashflow metric

status

string

Status of the response

Request example

https://api.twelvedata.com/etfs/world/risk?symbol=IVV&apikey=demo&source=docs

Response

{
    "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"
}

Composition High demand

/etfs/world/composition

This API request returns portfolio composition of a etf, including sectors, holding details, weighted exposure, and others.

API credits cost

200 per request

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Symbol ticker of etf

Example: IVV

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG000BVZ697

isin

string

Filter by international securities identification number (ISIN)

Example: US4642872000

cusip

string

The CUSIP of an instrument for which data is requested

Example: 464287200

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

integer

Number of decimal places for floating values. Accepts value in range [0,11]

Default: 5

etf

object

Etf information

Attributes

composition

object

Composition of a etf

Attributes

major_market_sectors

array of object

Breakdown of the fund’s portfolio by major industry sectors and their respective weights

Attributes

sector

string

Sector category of a fund exposure

weight

double

Weight (%) of a fund exposure in a sector

country_allocation

array of object

Breakdown of the fund’s portfolio by country and their respective weights

Attributes

country

string

Country name

allocation

double

Percentages of a fund's net assets distributed to securities of the country

asset_allocation

object

Asset allocation of a fund by different asset classes and their respective weights

Attributes

cash

double

Percentage of overall portfolio composition in cash

stocks

double

Percentage of overall portfolio composition in stocks

preferred_stocks

double

Percentage of overall portfolio composition in preferred stocks

convertables

double

Percentage of overall portfolio composition in convertable securities

bonds

double

Percentage of overall portfolio composition in bond

others

double

Percentage of overall portfolio composition in other forms of holding

top_holdings

array of object

Top holdings of a fund with their respective weights in the overall portfolio composition

Attributes

symbol

string

Symbol ticker of a holding instrument

name

string

Name of a holding instrument

weight

double

Weight (%) of a holding instrument in overall portfolio composition

bond_breakdown

object

Breakdown of the fund’s portfolio by bond holding characteristics

Attributes

average_maturity

object

Average credit rating of bond holding of a fund

Attributes

fund

double

Average maturity of bond holding of a fund

category

double

Average maturity of bond holding of funds in the same category

average_duration

object

Average duration of bond holding of a fund

Attributes

fund

double

Average duration of bond holding of a fund

category

double

Average duration of bond holding of funds in the same category

credit_quality

array of object

Breakdown of the fund’s bond holdings by credit rating and their respective portfolio weights

Attributes

grade

string

Rating of bond holding of a fund from AAA to below B

weight

double

Weight of bond holding in fund portfolio

status

string

Status of the response

Request example

https://api.twelvedata.com/etfs/world/composition?symbol=IVV&apikey=demo&source=docs

Response

{
    "etf": {
        "composition": {
            "major_market_sectors": [
                {
                    "sector": "Technology",
                    "weight": 0.2424
                }
            ],
            "country_allocation": [
                {
                    "country": "United Kingdom",
                    "allocation": 0.9855
                }
            ],
            "asset_allocation": {
                "cash": 0.0004,
                "stocks": 0.9996,
                "preferred_stocks": 0,
                "convertables": 0,
                "bonds": 0,
                "others": 0
            },
            "top_holdings": [
                {
                    "symbol": "AAPL",
                    "name": "Apple Inc",
                    "weight": 0.0592
                }
            ],
            "bond_breakdown": {
                "average_maturity": {
                    "fund": 6.65,
                    "category": 7.81
                },
                "average_duration": {
                    "fund": 5.72,
                    "category": 5.64
                },
                "credit_quality": [
                    {
                        "grade": "AAA",
                        "weight": 0
                    }
                ]
            }
        }
    },
    "status": "ok"
}

Fundamentals

Fundamental data covers a broad range of datasets for US-based and international stock, ETFs, and mutual funds. Including, but not limited to financials, profiles, transactions, and more.

Logo

/logo

Returns a logo of company, cryptocurrency, or forex pair.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

The ticker symbol of an instrument for which data is requested, e.g., AAPL, TSLA.

Example: AAPL

exchange

string

The exchange name where the instrument is traded, e.g., NASDAQ, NSE

Example: NASDAQ

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded, e.g., XNAS, XLON

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

Request example

https://api.twelvedata.com/logo?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "exchange": "NASDAQ"
    },
    "url": "https://api.twelvedata.com/logo/apple.com",
    "logo_base": "https://logo.twelvedata.com/forex/eur.png",
    "logo_quote": "https://logo.twelvedata.com/forex/usd.png"
}

Profile Useful

/profile

Returns general information about the company.

API credits cost

10 per symbol

This API endpoint is available starting with the Grow plan.

Parameters Response

✱ symbol

string

Symbol ticker of instrument. For preffered stocks use dot(.) delimiter E.g. BRK.A or BRK.B will be correct

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: United States

symbol

string

Ticker of the company

name

string

Name of the company

exchange

string

Exchange name where the company is listed

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

sector

string

Sector at which the company operates

industry

string

Industry at which company operates

employees

integer

Number of employees in the company

website

string

Website of the company

description

string

Description of the company activities

type

string

Issue type of the stock

CEO

string

Name of the CEO of the company

address

string

Street address of the company if presented

address2

string

Secondary address of the company if presented

city

string

City of the company if presented

zip

string

ZIP code of the company if presented

state

string

State of the company if presented

country

string

Country of the company if presented

phone

string

Phone number of the company if presented

Request example

https://api.twelvedata.com/profile?symbol=AAPL&apikey=demo&source=docs

Response

{
    "symbol": "AAPL",
    "name": "Apple Inc",
    "exchange": "NASDAQ",
    "mic_code": "XNAS",
    "sector": "Technology",
    "industry": "Consumer Electronics",
    "employees": 147000,
    "website": "http://www.apple.com",
    "description": "Apple Inc. designs, manufactures, and markets smartphones, personal computers, tablets, wearables, and...",
    "type": "Common Stock",
    "CEO": "Mr. Timothy D. Cook",
    "address": "One Apple Park Way",
    "address2": "Cupertino, CA 95014",
    "city": "Cupertino",
    "zip": "95014",
    "state": "CA",
    "country": "US",
    "phone": "408-996-1010"
}

Dividends

/dividends

Returns the amount of dividends paid out for the last 10+ years.

API credits cost

20 per symbol

This API endpoint is available starting with the Grow plan.

Parameters Response

✱ symbol

string

Symbol ticker of instrument. For preffered stocks use dot(.) delimiter E.g. BRK.A or BRK.B will be correct

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: US

range

string

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.

Supports: last, next, 1m, 3m, 6m, ytd, 1y, 2y, 5y, full

Default: last

start_date

string

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

End 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-12-31

adjust

boolean

Specifies if there should be an adjustment

Default: true

Request example

https://api.twelvedata.com/dividends?symbol=AAPL&apikey=demo&source=docs

Response

{
    "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
        }
    ]
}

Dividends calendar

/dividends_calendar

This API method returns dividend data as a calendar for a given date range. To call custom period, use start_date and end_date parameters.

API credits cost

40 per symbol

This API endpoint is available starting with the Grow plan.

Parameters Response

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: US

start_date

string

Start date for the dividends calendar query. Only dividends with ex-dates on or after this date will be returned. Format 2006-01-02

Example: 2024-01-01

end_date

string

End date for the dividends calendar query. Only dividends with ex-dates on or before this date will be returned. Format 2006-01-02

Example: 2024-12-31

outputsize

integer

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

integer

Page number

Default: 1

Request example

https://api.twelvedata.com/dividends_calendar?apikey=demo&source=docs

Response

[
    {
        "symbol": "MSFT",
        "mic_code": "XNGS",
        "exchange": "NASDAQ",
        "ex_date": "2024-02-14",
        "amount": 0.75
    }
]

Splits

/splits

Returns the date and the split factor of shares of the company for the last 10+ years.

API credits cost

20 per symbol

This API endpoint is available starting with the Grow plan.

Parameters Response

✱ symbol

string

Symbol ticker of instrument. For preffered stocks use dot(.) delimiter E.g. BRK.A or BRK.B will be correct

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: United States

range

string

Range of data to be returned

Supports: last, 1m, 3m, 6m, ytd, 1y, 2y, 5y, full

Default: last

start_date

string

The starting date for data selection. Format 2006-01-02

Example: 2020-01-01

end_date

string

The ending date for data selection. Format 2006-01-02

Example: 2020-12-31

meta

object

Metadata about the instrument

Attributes

symbol

string

Ticker symbol of instrument

name

string

Name of the instrument

currency

string

Currency in which the instrument is denominated

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

splits

array of object

List of stock splits

Attributes

date

string

Stands for the split date

description

string

Specification of the split event

ratio

double

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

double

From factor of the split

to_factor

double

To factor of the split

Request example

https://api.twelvedata.com/splits?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "exchange_timezone": "America/New_York"
    },
    "splits": [
        {
            "date": "2020-08-31",
            "description": "4-for-1 split",
            "ratio": 0.25,
            "from_factor": 4,
            "to_factor": 1
        }
    ]
}

Splits calendar

/splits_calendar

This API method returns split data as a calendar for a given date range. To call custom period, use start_date and end_date parameters.

API credits cost

40 per symbol

This API endpoint is available starting with the Grow plan.

Parameters Response

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: United States

start_date

string

The starting date (inclusive) for filtering split events in the calendar. Format 2006-01-02

Example: 2024-01-01

end_date

string

The ending date (inclusive) for filtering split events in the calendar. Format 2006-01-02

Example: 2024-12-31

outputsize

integer

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

Page number

Default: 1

Request example

https://api.twelvedata.com/splits_calendar?apikey=demo&source=docs

Response

[
    {
        "date": "2024-04-23",
        "symbol": "AAPL",
        "mic_code": "XNGS",
        "exchange": "NASDAQ",
        "description": "1-for-1 split",
        "ratio": 1,
        "from_factor": 1,
        "to_factor": 1
    }
]

Earnings

/earnings

This API call returns earnings data for a given company, including EPS estimate and EPS actual. Earnings are available for complete company history.

API credits cost

20 per symbol

This API endpoint is available starting with the Grow plan.

Parameters Response

✱ symbol

string

Symbol ticker of instrument. For preffered stocks use dot(.) delimiter. E.g. BRK.A or BRK.B will be correct

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: United States

type

string

The asset class to which the instrument belongs

Supports: 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

period

string

Type of earning, returns only 1 record. When is not empty, dates and outputsize parameters are ignored

Supports: latest, next

outputsize

integer

Number of data points to retrieve. Supports values in the range from 1 to 1000. Default 10 when no date parameters are set, otherwise set to maximum

Default: 10

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

integer

The number of decimal places in the response data. Should be in range [0,11] inclusive

Default: 2

start_date

string

The date from which the data is requested. The date format is YYYY-MM-DD.

Example: 2024-04-01

end_date

string

The date to which the data is requested. The date format is YYYY-MM-DD.

Example: 2024-04-30

meta

object

Metadata about the instrument

Attributes

symbol

string

Symbol of the instrument

name

string

Name of the company

currency

string

Currency in which the instrument is traded

exchange

string

Exchange where the instrument is traded

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

exchange_timezone

string

Timezone of the exchange

earnings

array of object

List of earnings data

Attributes

date

string

Date of earning release

time

string

Time of earning release, can be either of the following values: Pre Market, After Hours, Time Not Supplied

eps_estimate

double

Analyst estimate of the future company earning

eps_actual

double

Actual value of reported earning

difference

double

Delta between eps_actual and eps_estimate

surprise_prc

double

Surprise in the percentage of the eps_actual related to eps_estimate

status

string

Response status

Request example

https://api.twelvedata.com/earnings?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "exchange_timezone": "America/New_York"
    },
    "earnings": [
        {
            "date": "2020-04-30",
            "time": "After Hours",
            "eps_estimate": 2.09,
            "eps_actual": 2.55,
            "difference": 0.46,
            "surprise_prc": 22.01
        }
    ],
    "status": "ok"
}

Earnings calendar

/earnings_calendar

This API method returns earning data as a calendar for a given date range. By default today’s earning is returned. To call custom period, use start_date and end_date parameters.

API credits cost

40 per request

This API endpoint is available starting with the Grow plan.

Parameters Response

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: United States

format

string

Value can be JSON or CSV

Supports: JSON, CSV

Default: JSON

delimiter

string

Specify the delimiter used when downloading the CSV file

Default: ;

integer

Specifies the number of decimal places for floating values. Should be in range [0,11] inclusive

Default: 2

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15:04:05

Example: 2024-04-01

end_date

string

Can be used separately and together with start_date. Format 2006-01-02 or 2006-01-02 15:04:05

Example: 2024-04-30

earnings

map (key: string, value: array of object)

Map of dates to earnings data

Attributes

symbol

string

Instrument symbol (ticker)

name

string

Full name of instrument

currency

string

Currency in which instrument is traded by ISO 4217 standard

exchange

string

Exchange where instrument is traded

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

country

string

Country where exchange is located

time

string

Can be either of the following values: Pre Market, After Hours, Time Not Supplied

eps_estimate

double

Analyst estimate of the future company earning

eps_actual

double

Actual value of reported earning

difference

double

Delta between eps_actual and eps_estimate

surprise_prc

double

Surprise in percentage of the eps_actual related to eps_estimate

status

string

Response status

Request example

https://api.twelvedata.com/earnings_calendar?apikey=demo&source=docs

Response

{
    "earnings": {
        "2020-04-30": {
            "symbol": "BR",
            "name": "Broadridge Financial Solutions Inc",
            "currency": "USD",
            "exchange": "NYSE",
            "mic_code": "XNYS",
            "country": "United States",
            "time": "Time Not Supplied",
            "eps_estimate": 1.72,
            "eps_actual": 1.67,
            "difference": -0.05,
            "surprise_prc": -2.9
        }
    },
    "status": "ok"
}

IPO calendar

/ipo_calendar

This endpoint returns past, today, or upcoming IPOs.

API credits cost

40 per request

This API endpoint is available starting with the Grow plan.

Parameters Response

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: United States

start_date

string

The earliest IPO date to include in the results. Format: 2006-01-02

Example: 2021-01-01

end_date

string

The latest IPO date to include in the results. Format: 2006-01-02

Example: 2021-12-31

Request example

https://api.twelvedata.com/ipo_calendar?apikey=demo&source=docs

Response

{
    "key": {
        "symbol": "DWACU",
        "name": "Digital World Acquisition Corp.",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "price_range_low": 10,
        "price_range_high": 10,
        "offer_price": 0,
        "currency": "USD",
        "shares": 0
    }
}

Statistics High demand

/statistics

Returns current overview of company’s main statistics including valuation metrics and financials.

API credits cost

50 per symbol

This API endpoint is available starting with the Pro plan.

Parameters Response

✱ symbol

string

Symbol ticker of instrument. For preffered stocks use dot(.) delimiter. E.g. BRK.A or BRK.B will be correct

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG000B9Y5X2

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: United States

meta

object

Json object with request general information

Attributes

symbol

string

Symbol ticker of instrument

name

string

Name of the company

currency

string

Currency of the instrument

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

statistics

object

Statistics of the company

Attributes

valuations_metrics

object

Valuation metrics of the company

Attributes

market_capitalization

double

Refers to the market value of the company's outstanding shares

enterprise_value

double

Refers to enterprise value (EV) of the company, often used as a more comprehensive alternative to market capitalization

trailing_pe

double

Refers to the trailing price-to-earnings (P/E). It is calculated by taking the current stock price and dividing it by the trailing earnings per share (EPS) for the past 12 months

forward_pe

double

Refers to the forward price-to-earnings ratio. It is calculated by dividing the current share price by the estimated future earnings per share

peg_ratio

double

The price/earnings to growth (PEG) ratio is a price-to-earnings ratio divided by the growth rate of the earnings

price_to_sales_ttm

double

The price-to-sales (P/S) ratio is a valuation ratio that compares the market capitalization to its revenues over the last 12 months

price_to_book_mrq

double

The price-to-book (P/B) ratio is equal to the current share price divided by the book value of all shares (BVPS) over the last quarter

enterprise_to_revenue

double

The enterprise value-to-revenue multiple (EV/R) is a measure that compares enterprise value to revenue

enterprise_to_ebitda

double

The enterprise value-to-ebitda multiple (EV/EBITDA) is a measure that compares enterprise value to EBITDA

financials

object

Financial information of the company

Attributes

fiscal_year_ends

string

Refers to the completion of the last 12-month accounting period

most_recent_quarter

string

The most recent quarter (MRQ) refers to the fiscal quarter that most recently ended

gross_margin

double

The portion of a company's revenue left over after direct costs are subtracted

profit_margin

double

Refers to gross profit margin. Calculated by dividing net income by sales revenue

operating_margin

double

Operating margin is calculated by dividing operating income by net sales

return_on_assets_ttm

double

Return on assets (ROA) is calculated by dividing net income by total assets

return_on_equity_ttm

double

Return on equity (ROE) is calculated by dividing net income by average shareholders' equity

income_statement

object

Income statement information

Attributes

revenue_ttm

double

Refers to total revenue over the last 12 months

revenue_per_share_ttm

double

Refers to revenue per share over the last 12 months

quarterly_revenue_growth

double

Refers to quarterly revenue growth year over year

gross_profit_ttm

double

Refers to gross profit over the last 12 months

ebitda

double

Refers to EBITDA (earnings before interest, taxes, depreciation, and amortization) measure; EBITDA is not calculated for banks

net_income_to_common_ttm

double

Refers to net income applicable to common shares over the last 12 months

diluted_eps_ttm

double

Refers to diluted EPS measure over the last 12 months

quarterly_earnings_growth_yoy

double

Refers to quarterly earnings growth year over year

balance_sheet

object

Balance sheet information

Attributes

revenue_ttm

double

Refers to total revenue over the last 12 months

total_cash_mrq

double

Refers to total cash measure for the most recent quarter

total_cash_per_share_mrq

double

Refers to total cash per share measure for the most recent quarter

total_debt_mrq

double

Refers to total debt measure for the most recent quarter

total_debt_to_equity_mrq

double

Refers to total debt to equity measure for the most recent quarter

current_ratio_mrq

double

Refers to current ratio (total assets / total liabilities) ratio for the most recent quarter

book_value_per_share_mrq

double

Refers to book value per share (BVPS) ratio for the most recent quarter

cash_flow

object

Cash flow information

Attributes

operating_cash_flow_ttm

double

Refers to operating cash flow measure over the last 12 months

levered_free_cash_flow_ttm

double

Refers to levered free cash flow measure over the last 12 months

stock_statistics

object

Stock statistics of the company

Attributes

shares_outstanding

double

Refers for the shares outstanding currently held by all its shareholders

float_shares

double

Refers to floating stock is the number of public shares a company has available for trading on the open market

avg_10_volume

integer

Refers to the average 10 days volume

avg_90_volume

integer

Refers to the average 90 days volume

shares_short

integer

Refers to the number of shares that have been shorted

short_ratio

double

Refers to short ratio measure

short_percent_of_shares_outstanding

double

Refers to the number of shorted shares divided by the number of shares outstanding

percent_held_by_insiders

double

Refers to the percentage of shares held by the company insiders

percent_held_by_institutions

double

Refers to the percentage of shares held by the institutions

stock_price_summary

object

Stock price summary of the company

Attributes

fifty_two_week_low

double

Refers to the lowest price at which stock traded during a year

fifty_two_week_high

double

Refers to the highest price at which stock traded during a year

fifty_two_week_change

double

Refers to the change between lowest and highest prices during a year

beta

double

Refers to beta measure relative to the primary benchmark (index) of the country

day_50_ma

double

Refers to the 50-day simple moving average

day_200_ma

double

Refers to the 200-day simple moving average

dividends_and_splits

object

Dividends and splits information of the company

Attributes

forward_annual_dividend_rate

double

Refers to the forward dividend yield estimation in the currency of instrument

forward_annual_dividend_yield

double

Refers to the forward dividend yield percentage relative to stock price

trailing_annual_dividend_rate

double

Refers to the trailing dividend yield rate in the currency of instrument over the last 12 months

trailing_annual_dividend_yield

double

Refers to the trailing dividend yield percentage relative to stock price

5_year_average_dividend_yield

double

Refers to the average 5 years dividend yield

payout_ratio

double

Refers to payout ratio, showing the proportion of earnings a company pays its shareholders in the form of dividends

dividend_frequency

string

Refers to how often a stock or fund pays dividends

dividend_date

string

Refers to the last dividend payout date

ex_dividend_date

string

Refers to the last ex-dividend payout date

last_split_factor

string

Specification of the last split event

last_split_date

string

Refers for the last split date

Request example

https://api.twelvedata.com/statistics?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "exchange_timezone": "America/New_York"
    },
    "statistics": {
        "valuations_metrics": {
            "market_capitalization": 2546807865344,
            "enterprise_value": 2620597731328,
            "trailing_pe": 30.162493,
            "forward_pe": 26.982489,
            "peg_ratio": 1.4,
            "price_to_sales_ttm": 7.336227,
            "price_to_book_mrq": 39.68831,
            "enterprise_to_revenue": 7.549,
            "enterprise_to_ebitda": 23.623
        },
        "financials": {
            "fiscal_year_ends": "2020-09-26",
            "most_recent_quarter": "2021-06-26",
            "gross_margin": 46.57807,
            "profit_margin": 0.25004,
            "operating_margin": 0.28788,
            "return_on_assets_ttm": 0.19302,
            "return_on_equity_ttm": 1.27125,
            "income_statement": {
                "revenue_ttm": 347155005440,
                "revenue_per_share_ttm": 20.61,
                "quarterly_revenue_growth": 0.364,
                "gross_profit_ttm": 104956000000,
                "ebitda": 110934999040,
                "net_income_to_common_ttm": 86801997824,
                "diluted_eps_ttm": 5.108,
                "quarterly_earnings_growth_yoy": 0.932
            },
            "balance_sheet": {
                "revenue_ttm": 347155005440,
                "total_cash_mrq": 61696000000,
                "total_cash_per_share_mrq": 3.732,
                "total_debt_mrq": 135491002368,
                "total_debt_to_equity_mrq": 210.782,
                "current_ratio_mrq": 1.062,
                "book_value_per_share_mrq": 3.882
            },
            "cash_flow": {
                "operating_cash_flow_ttm": 104414003200,
                "levered_free_cash_flow_ttm": 80625876992
            }
        },
        "stock_statistics": {
            "shares_outstanding": 16530199552,
            "float_shares": 16513305231,
            "avg_10_volume": 72804757,
            "avg_90_volume": 77013078,
            "shares_short": 93105968,
            "short_ratio": 1.19,
            "short_percent_of_shares_outstanding": 0.0056,
            "percent_held_by_insiders": 0.00071000005,
            "percent_held_by_institutions": 0.58474
        },
        "stock_price_summary": {
            "fifty_two_week_low": 103.1,
            "fifty_two_week_high": 157.26,
            "fifty_two_week_change": 0.375625,
            "beta": 1.201965,
            "day_50_ma": 148.96686,
            "day_200_ma": 134.42506
        },
        "dividends_and_splits": {
            "forward_annual_dividend_rate": 0.88,
            "forward_annual_dividend_yield": 0.0057,
            "trailing_annual_dividend_rate": 0.835,
            "trailing_annual_dividend_yield": 0.0053832764,
            "5_year_average_dividend_yield": 1.27,
            "payout_ratio": 0.16309999,
            "dividend_frequency": "Quarterly",
            "dividend_date": "2021-08-12",
            "ex_dividend_date": "2021-08-06",
            "last_split_factor": "4-for-1 split",
            "last_split_date": "2020-08-31"
        }
    }
}

Income statement High demand

/income_statement

Returns complete income statement of a company and shows the company’s revenues and expenses during a period (annual or quarter).

API credits cost

100 per symbol

This API endpoint is available starting with the Pro plan. Full access to historical data is available only in the Enterprise plan.

Parameters Response

✱ symbol

string

Symbol ticker of instrument. For preffered stocks use dot(.) delimiter. E.g. BRK.A or BRK.B will be correct

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: United States

period

string

The reporting period for the income statement data

Supports: annual, quarterly

Example: annual

start_date

string

Begin date for filtering income statements by fiscal date. Returns income statements with fiscal dates on or after this date. Format 2006-01-02

Example: 2024-01-01

end_date

string

End date for filtering income statements by fiscal date. Returns income statements with fiscal dates on or before this date. Format 2006-01-02

Example: 2024-12-31

outputsize

integer

Number of records in response

Default: 6

meta

object

Meta information about the instrument

Attributes

symbol

string

Symbol ticker of the instrument

name

string

Name of the company

currency

string

Currency of the instrument according to the ISO 4217 standard

exchange

string

Exchange where the instrument is traded

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

exchange_timezone

string

Exchange timezone

period

string

Period of the income statement (Annual or Quarterly)

income_statement

array of object

Income statement data

Attributes

fiscal_date

string

Date of the income statement release

quarter

integer

Fiscal quarter. Visible when &period=quarterly

year

integer

Fiscal year

sales

integer

Refers to total reported revenue

cost_of_goods

integer

Refers to cost of revenue

gross_profit

integer

Refers to net gross profit: sales - cost_of_goods

operating_expense

object

Operating expense details

Attributes

research_and_development

integer

Refers to research & development (R&D) expenses

selling_general_and_administrative

integer

Refers to selling, general and administrative (SG&A) expenses

other_operating_expenses

integer

Refers to other operating expenses

operating_income

integer

Refers to net operating income: gross_profit - research_and_development - selling_general_and_administrative

non_operating_interest

object

Non-operating interest details

Attributes

income

integer

Refers to non-operating interest income

expense

integer

Refers to non-operating interest expense

other_income_expense

integer

Refers to other incomes or expenses

pretax_income

integer

Refers to earnings before tax: operating_income + net_non_operating_interest - other_income_expense

income_tax

integer

Refers to a tax provision

net_income

integer

Refers to net income: pretax_income - income_tax

eps_basic

double

Refers to earnings per share (EPS)

eps_diluted

double

Refers to diluted earnings per share (EPS)

basic_shares_outstanding

integer

Refers for the shares outstanding held by all its shareholders

diluted_shares_outstanding

integer

Refers to the total number of shares a company would have if all dilutive securities were exercised and converted into shares

ebit

integer

Refers to earnings before interest and taxes (EBIT) measure

ebitda

integer

Refers to EBITDA (earnings before interest, taxes, depreciation, and amortization) measure

net_income_continuous_operations

integer

Refers to the after-tax earnings that a business has generated from its operational activities

minority_interests

integer

Refers to amount of minority interests paid out

preferred_stock_dividends

integer

Refers to dividend that is allocated to and paid on a company's preferred shares

Request example

https://api.twelvedata.com/income_statement?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "exchange_timezone": "America/New_York",
        "period": "Quarterly"
    },
    "income_statement": [
        {
            "fiscal_date": "2021-12-31",
            "quarter": 1,
            "year": 2022,
            "sales": 123945000000,
            "cost_of_goods": 69702000000,
            "gross_profit": 54243000000,
            "operating_expense": {
                "research_and_development": 6306000000,
                "selling_general_and_administrative": 6449000000,
                "other_operating_expenses": 0
            },
            "operating_income": 41488000000,
            "non_operating_interest": {
                "income": 650000000,
                "expense": 694000000
            },
            "other_income_expense": -203000000,
            "pretax_income": 41241000000,
            "income_tax": 6611000000,
            "net_income": 34630000000,
            "eps_basic": 2.11,
            "eps_diluted": 2.1,
            "basic_shares_outstanding": 16391724000,
            "diluted_shares_outstanding": 16391724000,
            "ebit": 41488000000,
            "ebitda": 44632000000,
            "net_income_continuous_operations": 0,
            "minority_interests": 0,
            "preferred_stock_dividends": 0
        }
    ]
}

Income statement consolidated

/income_statement/consolidated

Returns consolidated income statement of a company and expenses during a period (annual or quarter).

API credits cost

100 per symbol

This API endpoint is available starting with the Ultra plan. Full access to historical data is available only in the Enterprise plan.

Parameters Response

✱ symbol

string

Symbol ticker of instrument. For preffered stocks use dot(.) delimiter E.g. BRK.A or BRK.B will be correct

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: United States

period

string

The reporting period for the income statement data

Supports: annual, quarterly

start_date

string

Begin date for filtering income statements by fiscal date. Returns income statements with fiscal dates on or after this date. Format 2006-01-02

Example: 2024-01-01

end_date

string

End date for filtering income statements by fiscal date. Returns income statements with fiscal dates on or before this date. Format 2006-01-02

Example: 2024-12-31

outputsize

integer

Number of records in response

Default: 6

income_statement

array of object

Income statement data

Attributes

fiscal_date

string

Date of the income statement release

year

integer

Fiscal year

revenue

object

Revenue information

Attributes

total_revenue

double

Total revenue

operating_revenue

double

Operating revenue

gross_profit

object

Gross profit information

Attributes

gross_profit_value

double

Gross profit value

cost_of_revenue

object

Cost of revenue information

Attributes

cost_of_revenue_value

double

Cost of revenue value

excise_taxes

double

Excise taxes

reconciled_cost_of_revenue

double

Reconciled cost of revenue

operating_income

object

Operating income information

Attributes

operating_income_value

double

Operating income value

total_operating_income_as_reported

double

Total operating income as reported

operating_expense

double

Operating expense

other_operating_expenses

double

Other operating expenses

total_expenses

double

Total expenses

net_income

object

Net income information

Attributes

net_income_value

double

Net income value

net_income_common_stockholders

double

Net income common stockholders

net_income_including_noncontrolling_interests

double

Net income including noncontrolling interests

net_income_from_tax_loss_carryforward

double

Net income from tax loss carryforward

net_income_extraordinary

double

Net income extraordinary

net_income_discontinuous_operations

double

Net income discontinuous operations

net_income_continuous_operations

double

Net income continuous operations

net_income_from_continuing_operation_net_minority_interest

double

Net income from continuing operation net minority interest

net_income_from_continuing_and_discontinued_operation

double

Net income from continuing and discontinued operation

normalized_income

double

Normalized income

minority_interests

double

Minority interests

earnings_per_share

object

Earnings per share information

Attributes

diluted_eps

double

Diluted EPS

basic_eps

double

Basic EPS

continuing_and_discontinued_diluted_eps

double

Continuing and discontinued diluted EPS

continuing_and_discontinued_basic_eps

double

Continuing and discontinued basic EPS

normalized_diluted_eps

double

Normalized diluted EPS

normalized_basic_eps

double

Normalized basic EPS

reported_normalized_diluted_eps

double

Reported normalized diluted EPS

reported_normalized_basic_eps

double

Reported normalized basic EPS

diluted_eps_other_gains_losses

double

Diluted EPS other gains losses

tax_loss_carryforward_diluted_eps

double

Tax loss carryforward diluted EPS

diluted_accounting_change

double

Diluted accounting change

diluted_extraordinary

double

Diluted extraordinary

diluted_discontinuous_operations

double

Diluted discontinuous operations

diluted_continuous_operations

double

Diluted continuous operations

basic_eps_other_gains_losses

double

Basic EPS other gains losses

tax_loss_carryforward_basic_eps

double

Tax loss carryforward basic EPS

basic_accounting_change

double

Basic accounting change

basic_extraordinary

double

Basic extraordinary

basic_discontinuous_operations

double

Basic discontinuous operations

basic_continuous_operations

double

Basic continuous operations

diluted_ni_avail_to_common_stockholders

double

Diluted NI available to common stockholders

average_dilution_earnings

double

Average dilution earnings

expenses

object

Expenses information

Attributes

total_expenses

double

Total expenses

selling_general_and_administration_expense

double

Selling general and administration expense

selling_and_marketing_expense

double

Selling and marketing expense

general_and_administrative_expense

double

General and administrative expense

other_general_and_administrative_expense

double

Other general and administrative expense

depreciation_amortization_depletion_income_statement

double

Depreciation amortization depletion income statement

research_and_development_expense

double

Research and development expense

insurance_and_claims_expense

double

Insurance and claims expense

rent_and_landing_fees

double

Rent and landing fees

salaries_and_wages_expense

double

Salaries and wages expense

rent_expense_supplemental

double

Rent expense supplemental

provision_for_doubtful_accounts

double

Provision for doubtful accounts

interest_income_and_expense

object

Interest income and expense information

Attributes

interest_income

double

Interest income

interest_expense

double

Interest expense

net_interest_income

double

Net interest income

net_non_operating_interest_income_expense

double

Net non operating interest income expense

interest_expense_non_operating

double

Interest expense non operating

interest_income_non_operating

double

Interest income non operating

other_income_and_expenses

object

Other income and expenses information

Attributes

other_income_expense

double

Other income expense

other_non_operating_income_expenses

double

Other non operating income expenses

special_income_charges

double

Special income charges

gain_on_sale_of_ppe

double

Gain on sale of PPE

gain_on_sale_of_business

double

Gain on sale of business

gain_on_sale_of_security

double

Gain on sale of security

other_special_charges

double

Other special charges

write_off

double

Write off

impairment_of_capital_assets

double

Impairment of capital assets

restructuring_and_merger_acquisition

double

Restructuring and merger acquisition

securities_amortization

double

Securities amortization

earnings_from_equity_interest

double

Earnings from equity interest

earnings_from_equity_interest_net_of_tax

double

Earnings from equity interest net of tax

total_other_finance_cost

double

Total other finance cost

taxes

object

Taxes information

Attributes

tax_provision

double

Tax provision

tax_effect_of_unusual_items

double

Tax effect of unusual items

tax_rate_for_calculations

double

Tax rate for calculations

other_taxes

double

Other taxes

depreciation_and_amortization

object

Depreciation and amortization information

Attributes

depreciation_amortization_depletion

double

Depreciation amortization depletion

amortization_of_intangibles

double

Amortization of intangibles

depreciation

double

Depreciation

amortization

double

Amortization

depletion

double

Depletion

depreciation_and_amortization_in_income_statement

double

Depreciation and amortization in income statement

ebitda

object

EBITDA information

Attributes

ebitda_value

double

EBITDA value

normalized_ebitda_value

double

Normalized EBITDA value

ebit_value

double

EBIT value

dividends_and_shares

object

Dividends and shares information

Attributes

dividend_per_share

double

Dividend per share

diluted_average_shares

double

Diluted average shares

basic_average_shares

double

Basic average shares

preferred_stock_dividends

double

Preferred stock dividends

other_under_preferred_stock_dividend

double

Other under preferred stock dividend

unusual_items

object

Unusual items information

Attributes

total_unusual_items

double

Total unusual items

total_unusual_items_excluding_goodwill

double

Total unusual items excluding goodwill

depreciation

object

Depreciation information

Attributes

reconciled_depreciation

double

Reconciled depreciation

pretax_income

object

Pretax income information

Attributes

pretax_income_value

double

Pretax income value

special_income_charges

object

Special income charges information

Attributes

special_income_charges_value

double

Special income charges value

status

string

Response status

Request example

https://api.twelvedata.com/income_statement/consolidated?symbol=AAPL&apikey=demo&source=docs

Response

{
    "income_statement": [
        {
            "fiscal_date": "2023-09-30",
            "year": 2022,
            "revenue": {
                "total_revenue": 383285000000,
                "operating_revenue": 383285000000
            },
            "gross_profit": {
                "gross_profit_value": 169148000000,
                "cost_of_revenue": {
                    "cost_of_revenue_value": 214137000000,
                    "excise_taxes": 214137000000,
                    "reconciled_cost_of_revenue": 214137000000
                }
            },
            "operating_income": {
                "operating_income_value": 114301000000,
                "total_operating_income_as_reported": 114301000000,
                "operating_expense": 54847000000,
                "other_operating_expenses": 114301000000,
                "total_expenses": 268984000000
            },
            "net_income": {
                "net_income_value": 96995000000,
                "net_income_common_stockholders": 96995000000,
                "net_income_including_noncontrolling_interests": 96995000000,
                "net_income_from_tax_loss_carryforward": 96995000000,
                "net_income_extraordinary": 96995000000,
                "net_income_discontinuous_operations": 96995000000,
                "net_income_continuous_operations": 96995000000,
                "net_income_from_continuing_operation_net_minority_interest": 96995000000,
                "net_income_from_continuing_and_discontinued_operation": 96995000000,
                "normalized_income": 96995000000,
                "minority_interests": 96995000000
            },
            "earnings_per_share": {
                "diluted_eps": 6.13,
                "basic_eps": 6.16,
                "continuing_and_discontinued_diluted_eps": 6.16,
                "continuing_and_discontinued_basic_eps": 6.16,
                "normalized_diluted_eps": 6.16,
                "normalized_basic_eps": 6.16,
                "reported_normalized_diluted_eps": 6.16,
                "reported_normalized_basic_eps": 6.16,
                "diluted_eps_other_gains_losses": 6.16,
                "tax_loss_carryforward_diluted_eps": 6.16,
                "diluted_accounting_change": 6.16,
                "diluted_extraordinary": 6.16,
                "diluted_discontinuous_operations": 6.16,
                "diluted_continuous_operations": 6.16,
                "basic_eps_other_gains_losses": 6.16,
                "tax_loss_carryforward_basic_eps": 6.16,
                "basic_accounting_change": 6.16,
                "basic_extraordinary": 6.16,
                "basic_discontinuous_operations": 6.16,
                "basic_continuous_operations": 6.16,
                "diluted_ni_avail_to_common_stockholders": 96995000000,
                "average_dilution_earnings": 96995000000
            },
            "expenses": {
                "total_expenses": 268984000000,
                "selling_general_and_administration_expense": 24932000000,
                "selling_and_marketing_expense": 24932000000,
                "general_and_administrative_expense": 24932000000,
                "other_general_and_administrative_expense": 24932000000,
                "depreciation_amortization_depletion_income_statement": 29915000000,
                "research_and_development_expense": 29915000000,
                "insurance_and_claims_expense": 29915000000,
                "rent_and_landing_fees": 29915000000,
                "salaries_and_wages_expense": 29915000000,
                "rent_expense_supplemental": 29915000000,
                "provision_for_doubtful_accounts": 29915000000
            },
            "interest_income_and_expense": {
                "interest_income": 3750000000,
                "interest_expense": 3933000000,
                "net_interest_income": -183000000,
                "net_non_operating_interest_income_expense": -183000000,
                "interest_expense_non_operating": 3933000000,
                "interest_income_non_operating": 3750000000
            },
            "other_income_and_expenses": {
                "other_income_expense": -382000000,
                "other_non_operating_income_expenses": -382000000,
                "special_income_charges": 382000000,
                "gain_on_sale_of_ppe": 382000000,
                "gain_on_sale_of_business": 382000000,
                "gain_on_sale_of_security": 382000000,
                "other_special_charges": 382000000,
                "write_off": 382000000,
                "impairment_of_capital_assets": 382000000,
                "restructuring_and_merger_acquisition": 382000000,
                "securities_amortization": 382000000,
                "earnings_from_equity_interest": 382000000,
                "earnings_from_equity_interest_net_of_tax": 382000000,
                "total_other_finance_cost": 382000000
            },
            "taxes": {
                "tax_provision": 16741000000,
                "tax_effect_of_unusual_items": 0,
                "tax_rate_for_calculations": 0.147,
                "other_taxes": 0
            },
            "depreciation_and_amortization": {
                "depreciation_amortization_depletion": 129188000000,
                "amortization_of_intangibles": 129188000000,
                "depreciation": 129188000000,
                "amortization": 129188000000,
                "depletion": 129188000000,
                "depreciation_and_amortization_in_income_statement": 129188000000
            },
            "ebitda": {
                "ebitda_value": 129188000000,
                "normalized_ebitda_value": 129188000000,
                "ebit_value": 117669000000
            },
            "dividends_and_shares": {
                "dividend_per_share": 15812547000,
                "diluted_average_shares": 15812547000,
                "basic_average_shares": 15744231000,
                "preferred_stock_dividends": 15744231000,
                "other_under_preferred_stock_dividend": 15744231000
            },
            "unusual_items": {
                "total_unusual_items": 11519000000,
                "total_unusual_items_excluding_goodwill": 11519000000
            },
            "depreciation": {
                "reconciled_depreciation": 11519000000
            },
            "pretax_income": {
                "pretax_income_value": 113736000000
            },
            "special_income_charges": {
                "special_income_charges_value": 113736000000
            }
        }
    ],
    "status": "ok"
}

Balance sheet High demand

/balance_sheet

Returns complete balance sheet of a company showing the summary of assets, liabilities, and shareholders’ equity.

API credits cost

100 per symbol

This API endpoint is available starting with the Pro plan. Full access to historical data is available only in the Enterprise plan.

Parameters Response

✱ symbol

string

Symbol ticker of instrument. For preffered stocks use dot(.) delimiter E.g. BRK.A or BRK.B will be correct

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: United States

period

string

The reporting period for the balane sheet data

Supports: annual, quarterly

Default: annual

start_date

string

Begin date for filtering items by fiscal date. Returns income statements with fiscal dates on or after this date. Format 2006-01-02

Example: 2024-01-01

end_date

string

End date for filtering items by fiscal date. Returns income statements with fiscal dates on or before this date. Format 2006-01-02

Example: 2024-05-01

outputsize

integer

Number of records in response

Default: 6

meta

object

Metadata about the balance sheet

Attributes

symbol

string

Ticker symbol of instrument

name

string

Name of the company

currency

string

Currency of the balance sheet according to the ISO 4217 standard

exchange

string

Exchange where instrument is traded

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

exchange_timezone

string

Exchange timezone

period

string

Values can be annual or quarterly

balance_sheet

array of object

Array of balance sheet records

Attributes

fiscal_date

string

Date of the balance sheet release

year

integer

Fiscal year

assets

object

Assets section of the balance sheet

Attributes

current_assets

object

Current assets section

Attributes

cash

double

Cash includes currency, bank accounts, and undeposited checks

cash_equivalents

double

Represents cash equivalents that have high credit quality and are highly liquid

cash_and_cash_equivalents

double

Combined value of cash and cash equivalents when company doesn't report a breakdown

other_short_term_investments

double

Represents other short term investments

accounts_receivable

double

Represents the balance of money due to a firm for goods or services delivered or used but not yet paid for by customers

other_receivables

double

Represents other receivables

inventory

double

Represents the goods available for sale and raw materials used to produce goods available for sale

prepaid_assets

double

Represents expense that has already been paid for, but which has not yet been consumed

restricted_cash

double

Represents money that is held for a specific purpose and thus not available to the company for immediate or general business use

assets_held_for_sale

double

Represents assets which company plans to sell

hedging_assets

double

Represents money that is spent on hedging assets

other_current_assets

double

Represents other current assets

total_current_assets

double

All current assets values in a total

non_current_assets

object

Non-current assets section

Attributes

properties

double

Represents property owned

land_and_improvements

double

Represents land and improvements owned

machinery_furniture_equipment

double

Represents office equipment, furniture, and vehicles owned

construction_in_progress

double

Represents the cost of construction work, which is not yet completed

leases

double

Represents operating and financial leases

accumulated_depreciation

double

Represents the cumulative depreciation of an asset that has been recorded

goodwill

double

Represents the value of a brand name, solid customer base, good customer relations, good employee relations, and proprietary technology

investment_properties

double

Represents real estate property purchased with the intention of earning a return on the investment

financial_assets

double

Represents liquid asset that gets its value from a contractual right or ownership claim

intangible_assets

double

Represents the patents, trademarks, and other intellectual properties

investments_and_advances

double

Represents available for sale financial securities

other_non_current_assets

double

Represents other long-term assets

total_non_current_assets

double

All long-term assets values in total

total_assets

double

The sum of total_current_assets + total_non_current_assets

liabilities

object

Liabilities section of the balance sheet

Attributes

current_liabilities

object

Current liabilities section

Attributes

accounts_payable

double

Refers to an account within the general ledger that represents an obligation to pay off a short-term debt to creditors or suppliers

accrued_expenses

double

Represents payments that a company is obligated to pay in the future for which goods and services have already been delivered

short_term_debt

double

Represents current debt and capital lease obligations

deferred_revenue

double

Represents advance payments a company receives for products or services that are to be delivered or performed in the future

tax_payable

double

Represents taxes due to the government within one year

pensions

double

Represents to pensions to be paid out

other_current_liabilities

double

Represents other current liabilities

total_current_liabilities

double

Represents total current liabilities

non_current_liabilities

object

Non-current liabilities section

Attributes

long_term_provisions

double

Represents money set aside for employee benefits such as gratuity

long_term_debt

double

Represents amount of outstanding debt that has a maturity of 12 months or longer

provision_for_risks_and_charges

double

Represents funds set aside as assets to pay for anticipated future losses

deferred_liabilities

double

Represents revenue producing activity for which revenue has not yet been recognized, and is not expected to be recognized in the next 12 months

derivative_product_liabilities

double

Represents the value of derivative financial instruments that a company has issued

other_non_current_liabilities

double

Represents other non-current liabilities

total_non_current_liabilities

double

Represents total non-current liabilities

total_liabilities

double

The sum of total_current_liabilities + total_non_current_liabilities

shareholders_equity

object

Shareholders' equity section of the balance sheet

Attributes

common_stock

double

Represents net worth of investors shares, which is equal to the total_assets - total_liabilities

retained_earnings

double

Refers to the profits earned minus dividends paid

other_shareholders_equity

double

Represents other not affecting retained earnings gains and looses

total_shareholders_equity

double

Represents the net worth of a company, which is the amount that would be returned to shareholders if a company's total assets were liquidated, and all of its debts were repaid

additional_paid_in_capital

double

Represents the additional paid-in capital, which is the amount shareholders have invested in a company above the par value of its stock

treasury_stock

double

Represents the value of shares that have been repurchased by the company and are held in its treasury

minority_interest

double

Represents the portion of shareholders' equity that is attributable to minority shareholders in a subsidiary company

Request example

https://api.twelvedata.com/balance_sheet?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "exchange_timezone": "America/New_York",
        "period": "Quarterly"
    },
    "balance_sheet": [
        {
            "fiscal_date": "2021-09-30",
            "year": 2022,
            "assets": {
                "current_assets": {
                    "cash": 17305000000,
                    "cash_equivalents": 17635000000,
                    "cash_and_cash_equivalents": 34940000000,
                    "other_short_term_investments": 27699000000,
                    "accounts_receivable": 26278000000,
                    "other_receivables": 25228000000,
                    "inventory": 6580000000,
                    "prepaid_assets": 0,
                    "restricted_cash": 0,
                    "assets_held_for_sale": 0,
                    "hedging_assets": 0,
                    "other_current_assets": 14111000000,
                    "total_current_assets": 134836000000
                },
                "non_current_assets": {
                    "properties": 0,
                    "land_and_improvements": 20041000000,
                    "machinery_furniture_equipment": 78659000000,
                    "construction_in_progress": 0,
                    "leases": 11023000000,
                    "accumulated_depreciation": -70283000000,
                    "goodwill": 0,
                    "investment_properties": 0,
                    "financial_assets": 0,
                    "intangible_assets": 0,
                    "investments_and_advances": 127877000000,
                    "other_non_current_assets": 48849000000,
                    "total_non_current_assets": 216166000000
                },
                "total_assets": 351002000000
            },
            "liabilities": {
                "current_liabilities": {
                    "accounts_payable": 54763000000,
                    "accrued_expenses": 0,
                    "short_term_debt": 15613000000,
                    "deferred_revenue": 7612000000,
                    "tax_payable": 0,
                    "pensions": 0,
                    "other_current_liabilities": 47493000000,
                    "total_current_liabilities": 125481000000
                },
                "non_current_liabilities": {
                    "long_term_provisions": 0,
                    "long_term_debt": 109106000000,
                    "provision_for_risks_and_charges": 24689000000,
                    "deferred_liabilities": 0,
                    "derivative_product_liabilities": 0,
                    "other_non_current_liabilities": 28636000000,
                    "total_non_current_liabilities": 162431000000
                },
                "total_liabilities": 287912000000
            },
            "shareholders_equity": {
                "common_stock": 57365000000,
                "retained_earnings": 5562000000,
                "other_shareholders_equity": 163000000,
                "total_shareholders_equity": 63090000000,
                "additional_paid_in_capital": 0,
                "treasury_stock": 0,
                "minority_interest": 0
            }
        }
    ]
}

Balance sheet consolidated

/balance_sheet/consolidated

Returns consolidated balance sheet of a company showing the summary of assets, liabilities, and shareholders.

API credits cost

100 per symbol

This API endpoint is available starting with the Ultra plan. Full access to historical data is available only in the Enterprise plan.

Parameters Response

✱ symbol

string

Symbol ticker of instrument. For preffered stocks use dot(.) delimiter E.g. BRK.A or BRK.B will be correct

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: United States

period

string

The reporting period for the balance sheet data.

Supports: annual, quarterly

Default: annual

start_date

string

Begin date for filtering items by fiscal date. Returns income statements with fiscal dates on or after this date. Format 2006-01-02

end_date

string

End date for filtering items by fiscal date. Returns income statements with fiscal dates on or before this date. Format 2006-01-02

outputsize

integer

Number of records in response

Default: 6

balance_sheet

array of object

Balance sheet data

Attributes

fiscal_date

string

Date of the balance sheet release

assets

object

AssetsInfo represents assets information in the balance sheet

Attributes

total_assets

double

Total assets

current_assets

object

Current assets information

Attributes

total_current_assets

double

Total current assets

cash_cash_equivalents_and_short_term_investments

double

Cash cash equivalents and short term investments

cash_and_cash_equivalents

double

Cash and cash equivalents

cash_equivalents

double

Cash equivalents

cash_financial

double

Cash financial

other_short_term_investments

double

Other short term investments

restricted_cash

double

Restricted cash

receivables

object

Receivables information

Attributes

total_receivables

double

Total receivables

accounts_receivable

double

Accounts receivable

gross_accounts_receivable

double

Gross accounts receivable

allowance_for_doubtful_accounts_receivable

double

Allowance for doubtful accounts receivable

receivables_adjustments_allowances

double

Receivables adjustments allowances

other_receivables

double

Other receivables

due_from_related_parties_current

double

Due from related parties current

taxes_receivable

double

Taxes receivable

accrued_interest_receivable

double

Accrued interest receivable

notes_receivable

double

Notes receivable

loans_receivable

double

Loans receivable

inventory

object

Inventory information

Attributes

total_inventory

double

Total inventory

inventories_adjustments_allowances

double

Inventories adjustments allowances

other_inventories

double

Other inventories

finished_goods

double

Finished goods

work_in_process

double

Work in process

raw_materials

double

Raw materials

prepaid_assets

double

Prepaid assets

current_deferred_assets

double

Current deferred assets

current_deferred_taxes_assets

double

Current deferred taxes assets

assets_held_for_sale_current

double

Assets held for sale current

hedging_assets_current

double

Hedging assets current

other_current_assets

double

Other current assets

non_current_assets

object

Non-current assets information

Attributes

total_non_current_assets

double

Total non current assets

financial_assets

double

Financial assets

investments_and_advances

double

Investments and advances

other_investments

double

Other investments

investment_in_financial_assets

double

Investment in financial assets

held_to_maturity_securities

double

Held to maturity securities

available_for_sale_securities

double

Available for sale securities

financial_assets_designated_as_fair_value_through_profit_or_loss_total

double

Financial assets designated as fair value through profit or loss total

trading_securities

double

Trading securities

long_term_equity_investment

double

Long term equity investment

investments_in_joint_ventures_at_cost

double

Investments in joint ventures at cost

investments_in_other_ventures_under_equity_method

double

Investments in other ventures under equity method

investments_in_associates_at_cost

double

Investments in associates at cost

investments_in_subsidiaries_at_cost

double

Investments in subsidiaries at cost

investment_properties

double

Investment properties

goodwill_and_other_intangible_assets

object

Goodwill and other intangible assets information

Attributes

goodwill

double

Goodwill

other_intangible_assets

double

Other intangible assets

total_goodwill_and_intangible_assets

double

Total goodwill and intangible assets

net_ppe

double

Net ppe

gross_ppe

double

Gross ppe

accumulated_depreciation

double

Accumulated depreciation

leases

double

Leases

construction_in_progress

double

Construction in progress

other_properties

double

Other properties

machinery_furniture_equipment

double

Machinery furniture equipment

buildings_and_improvements

double

Buildings and improvements

land_and_improvements

double

Land and improvements

properties

double

Properties

non_current_accounts_receivable

double

Non current accounts receivable

non_current_note_receivables

double

Non current note receivables

due_from_related_parties_non_current

double

Due from related parties non current

non_current_prepaid_assets

double

Non current prepaid assets

non_current_deferred_assets

double

Non current deferred assets

non_current_deferred_taxes_assets

double

Non current deferred taxes assets

defined_pension_benefit

double

Defined pension benefit

other_non_current_assets

double

Other non current assets

liabilities

object

Liabilities information

Attributes

total_liabilities_net_minority_interest

double

Total liabilities net minority interest

current_liabilities

object

Current liabilities information

Attributes

total_current_liabilities

double

Total current liabilities

current_debt_and_capital_lease_obligation

double

Current debt and capital lease obligation

current_debt

double

Current debt

current_capital_lease_obligation

double

Current capital lease obligation

other_current_borrowings

double

Other current borrowings

line_of_credit

double

Line of credit

commercial_paper

double

Commercial paper

current_notes_payable

double

Current notes payable

current_provisions

double

Current provisions

payables_and_accrued_expenses

object

Payables and accrued expenses information

Attributes

total_payables_and_accrued_expenses

double

Total payables and accrued expenses

accounts_payable

double

Accounts payable

current_accrued_expenses

double

Current accrued expenses

interest_payable

double

Interest payable

payables

double

Payables

other_payable

double

Other payable

due_to_related_parties_current

double

Due to related parties current

dividends_payable

double

Dividends payable

total_tax_payable

double

Total tax payable

income_tax_payable

double

Income tax payable

pension_and_other_post_retirement_benefit_plans_current

double

Pension and other post retirement benefit plans current

employee_benefits

double

Employee benefits

current_deferred_liabilities

double

Current deferred liabilities

current_deferred_revenue

double

Current deferred revenue

current_deferred_taxes_liabilities

double

Current deferred taxes liabilities

other_current_liabilities

double

Other current liabilities

liabilities_held_for_sale_non_current

double

Liabilities held for sale non current

non_current_liabilities

object

Non-current liabilities information

Attributes

total_non_current_liabilities_net_minority_interest

double

Total non current liabilities net minority interest

long_term_debt_and_capital_lease_obligation

object

Long term debt and capital lease obligation information

Attributes

total_long_term_debt_and_capital_lease_obligation

double

Total long term debt and capital lease obligation

long_term_debt

double

Long term debt

long_term_capital_lease_obligation

double

Long term capital lease obligation

long_term_provisions

double

Long term provisions

non_current_pension_and_other_postretirement_benefit_plans

double

Non current pension and other postretirement benefit plans

non_current_accrued_expenses

double

Non current accrued expenses

due_to_related_parties_non_current

double

Due to related parties non current

trade_and_other_payables_non_current

double

Trade and other payables non current

non_current_deferred_liabilities

double

Non current deferred liabilities

non_current_deferred_revenue

double

Non current deferred revenue

non_current_deferred_taxes_liabilities

double

Non current deferred taxes liabilities

other_non_current_liabilities

double

Other non current liabilities

preferred_securities_outside_stock_equity

double

Preferred securities outside stock equity

derivative_product_liabilities

double

Derivative product liabilities

capital_lease_obligations

double

Capital lease obligations

restricted_common_stock

double

Restricted common stock

equity

object

EquityInfo represents equity information

Attributes

total_equity_gross_minority_interest

double

Total equity gross minority interest

stockholders_equity

double

Stockholders equity

common_stock_equity

double

Common stock equity

preferred_stock_equity

double

Preferred stock equity

other_equity_interest

double

Other equity interest

minority_interest

double

Minority interest

total_capitalization

double

Total capitalization

net_tangible_assets

double

Net tangible assets

tangible_book_value

double

Tangible book value

invested_capital

double

Invested capital

working_capital

double

Working capital

capital_stock

object

Capital stock information

Attributes

common_stock

double

Common stock

preferred_stock

double

Preferred stock

total_partnership_capital

double

Total partnership capital

general_partnership_capital

double

General partnership capital

limited_partnership_capital

double

Limited partnership capital

capital_stock

double

Capital stock

other_capital_stock

double

Other capital stock

additional_paid_in_capital

double

Additional paid in capital

retained_earnings

double

Retained earnings

treasury_stock

double

Treasury stock

treasury_shares_number

double

Treasury shares number

ordinary_shares_number

double

Ordinary shares number

preferred_shares_number

double

Preferred shares number

share_issued

double

Share issued

equity_adjustments

object

Equity adjustments information

Attributes

gains_losses_not_affecting_retained_earnings

double

Gains losses not affecting retained earnings

other_equity_adjustments

double

Other equity adjustments

fixed_assets_revaluation_reserve

double

Fixed assets revaluation reserve

foreign_currency_translation_adjustments

double

Foreign currency translation adjustments

minimum_pension_liabilities

double

Minimum pension liabilities

unrealized_gain_loss

double

Unrealized gain loss

net_debt

double

Net debt

total_debt

double

Total debt

status

string

Response status

Request example

https://api.twelvedata.com/balance_sheet/consolidated?symbol=AAPL&apikey=demo&source=docs

Response

{
    "balance_sheet": [
        {
            "fiscal_date": "2023-09-30",
            "assets": {
                "total_assets": 352583000000,
                "current_assets": {
                    "total_current_assets": 143566000000,
                    "cash_cash_equivalents_and_short_term_investments": 61555000000,
                    "cash_and_cash_equivalents": 29965000000,
                    "cash_equivalents": 1606000000,
                    "cash_financial": 28359000000,
                    "other_short_term_investments": 31590000000,
                    "restricted_cash": 31590000000,
                    "receivables": {
                        "total_receivables": 60985000000,
                        "accounts_receivable": 29508000000,
                        "gross_accounts_receivable": 29508000000,
                        "allowance_for_doubtful_accounts_receivable": 29508000000,
                        "receivables_adjustments_allowances": 29508000000,
                        "other_receivables": 31477000000,
                        "due_from_related_parties_current": 31477000000,
                        "taxes_receivable": 31477000000,
                        "accrued_interest_receivable": 31477000000,
                        "notes_receivable": 31477000000,
                        "loans_receivable": 31477000000
                    },
                    "inventory": {
                        "total_inventory": 6331000000,
                        "inventories_adjustments_allowances": 6331000000,
                        "other_inventories": 6331000000,
                        "finished_goods": 6331000000,
                        "work_in_process": 6331000000,
                        "raw_materials": 6331000000
                    },
                    "prepaid_assets": 14695000000,
                    "current_deferred_assets": 14695000000,
                    "current_deferred_taxes_assets": 14695000000,
                    "assets_held_for_sale_current": 14695000000,
                    "hedging_assets_current": 14695000000,
                    "other_current_assets": 14695000000
                },
                "non_current_assets": {
                    "total_non_current_assets": 209017000000,
                    "financial_assets": 209017000000,
                    "investments_and_advances": 100544000000,
                    "other_investments": 100544000000,
                    "investment_in_financial_assets": 100544000000,
                    "held_to_maturity_securities": 100544000000,
                    "available_for_sale_securities": 100544000000,
                    "financial_assets_designated_as_fair_value_through_profit_or_loss_total": 100544000000,
                    "trading_securities": 100544000000,
                    "long_term_equity_investment": 100544000000,
                    "investments_in_joint_ventures_at_cost": 100544000000,
                    "investments_in_other_ventures_under_equity_method": 100544000000,
                    "investments_in_associates_at_cost": 100544000000,
                    "investments_in_subsidiaries_at_cost": 100544000000,
                    "investment_properties": 100544000000,
                    "goodwill_and_other_intangible_assets": {
                        "goodwill": 100544000000,
                        "other_intangible_assets": 100544000000,
                        "total_goodwill_and_intangible_assets": 100544000000
                    },
                    "net_ppe": 54376000000,
                    "gross_ppe": 125260000000,
                    "accumulated_depreciation": -70884000000,
                    "leases": 12839000000,
                    "construction_in_progress": 12839000000,
                    "other_properties": 10661000000,
                    "machinery_furniture_equipment": 78314000000,
                    "buildings_and_improvements": 12839000000,
                    "land_and_improvements": 23446000000,
                    "properties": 0,
                    "non_current_accounts_receivable": 12839000000,
                    "non_current_note_receivables": 12839000000,
                    "due_from_related_parties_non_current": 12839000000,
                    "non_current_prepaid_assets": 12839000000,
                    "non_current_deferred_assets": 17852000000,
                    "non_current_deferred_taxes_assets": 17852000000,
                    "defined_pension_benefit": 12839000000,
                    "other_non_current_assets": 36245000000
                },
                "liabilities": {
                    "total_liabilities_net_minority_interest": 290437000000,
                    "current_liabilities": {
                        "total_current_liabilities": 145308000000,
                        "current_debt_and_capital_lease_obligation": 17382000000,
                        "current_debt": 15807000000,
                        "current_capital_lease_obligation": 1575000000,
                        "other_current_borrowings": 9822000000,
                        "line_of_credit": 9822000000,
                        "commercial_paper": 5985000000,
                        "current_notes_payable": 9822000000,
                        "current_provisions": 9822000000,
                        "payables_and_accrued_expenses": {
                            "total_payables_and_accrued_expenses": 71430000000,
                            "accounts_payable": 62611000000,
                            "current_accrued_expenses": 9822000000,
                            "interest_payable": 9822000000,
                            "payables": 71430000000,
                            "other_payable": 9822000000,
                            "due_to_related_parties_current": 9822000000,
                            "dividends_payable": 9822000000,
                            "total_tax_payable": 8819000000,
                            "income_tax_payable": 8819000000
                        },
                        "pension_and_other_post_retirement_benefit_plans_current": 8061000000,
                        "employee_benefits": 8061000000,
                        "current_deferred_liabilities": 8061000000,
                        "current_deferred_revenue": 8061000000,
                        "current_deferred_taxes_liabilities": 8061000000,
                        "other_current_liabilities": 48435000000,
                        "liabilities_held_for_sale_non_current": 48435000000
                    },
                    "non_current_liabilities": {
                        "total_non_current_liabilities_net_minority_interest": 145129000000,
                        "long_term_debt_and_capital_lease_obligation": {
                            "total_long_term_debt_and_capital_lease_obligation": 106548000000,
                            "long_term_debt": 95281000000,
                            "long_term_capital_lease_obligation": 11267000000
                        },
                        "long_term_provisions": 15457000000,
                        "non_current_pension_and_other_postretirement_benefit_plans": 15457000000,
                        "non_current_accrued_expenses": 15457000000,
                        "due_to_related_parties_non_current": 15457000000,
                        "trade_and_other_payables_non_current": 15457000000,
                        "non_current_deferred_liabilities": 15457000000,
                        "non_current_deferred_revenue": 15457000000,
                        "non_current_deferred_taxes_liabilities": 15457000000,
                        "other_non_current_liabilities": 23124000000,
                        "preferred_securities_outside_stock_equity": 15457000000,
                        "derivative_product_liabilities": 15457000000,
                        "capital_lease_obligations": 12842000000,
                        "restricted_common_stock": 12842000000
                    },
                    "equity": {
                        "total_equity_gross_minority_interest": 62146000000,
                        "stockholders_equity": 62146000000,
                        "common_stock_equity": 62146000000,
                        "preferred_stock_equity": 62146000000,
                        "other_equity_interest": 62146000000,
                        "minority_interest": 62146000000,
                        "total_capitalization": 157427000000,
                        "net_tangible_assets": 62146000000,
                        "tangible_book_value": 62146000000,
                        "invested_capital": 173234000000,
                        "working_capital": -1742000000,
                        "capital_stock": {
                            "common_stock": 73812000000,
                            "preferred_stock": 73812000000,
                            "total_partnership_capital": 73812000000,
                            "general_partnership_capital": 73812000000,
                            "limited_partnership_capital": 73812000000,
                            "capital_stock": 73812000000,
                            "other_capital_stock": 73812000000,
                            "additional_paid_in_capital": 73812000000,
                            "retained_earnings": -214000000,
                            "treasury_stock": 73812000000,
                            "treasury_shares_number": 0,
                            "ordinary_shares_number": 15550061000,
                            "preferred_shares_number": 73812000000,
                            "share_issued": 15550061000
                        },
                        "equity_adjustments": {
                            "gains_losses_not_affecting_retained_earnings": -11452000000,
                            "other_equity_adjustments": -11452000000,
                            "fixed_assets_revaluation_reserve": 11452000000,
                            "foreign_currency_translation_adjustments": 11452000000,
                            "minimum_pension_liabilities": 11452000000,
                            "unrealized_gain_loss": 11452000000
                        },
                        "net_debt": 81123000000,
                        "total_debt": 123930000000
                    }
                }
            }
        }
    ],
    "status": "ok"
}

Cash flow High demand

/cash_flow

Returns complete cash flow of a company showing the net amount of cash and cash equivalents being transferred into and out of business.

API credits cost

100 per symbol

This API endpoint is available starting with the Pro plan. Full access to historical data is available only in the Enterprise plan.

Parameters Response

✱ symbol

string

Symbol ticker of instrument. For preffered stocks use dot(.) delimiter E.g. BRK.A or BRK.B will be correct

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: United States

period

string

The reporting period for the cash flow statements

Supports: annual, quarterly

Default: annual

start_date

string

Start date for filtering cash flow statements. Only cash flow statements with fiscal dates on or after this date will be included. Format 2006-01-02

Example: 2024-01-01

end_date

string

End date for filtering cash flow statements. Only cash flow statements with fiscal dates on or before this date will be included. Format 2006-01-02

Example: 2024-12-31

outputsize

integer

Number of records in response

Default: 6

meta

object

Meta information about the response

Attributes

symbol

string

Symbol ticker of instrument

name

string

Name of the company

currency

string

Currency of the cash flow data according to the ISO 4217 standard

exchange

string

Exchange where instrument is traded

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

exchange_timezone

string

Exchange timezone

period

string

Period of the cash flow data (Annual or Quarterly)

cash_flow

array of object

Cash flow data

Attributes

fiscal_date

string

Date of the cash flow release

quarter

string

Fiscal quarter. Visible when &period=quarterly

year

integer

Fiscal year

operating_activities

object

Operating activities section

Attributes

net_income

double

Returns net income (NI). Calculated as sales minus cost of goods sold

depreciation

double

Represents depreciation and amortization measure

deferred_taxes

double

Stands for taxes that are owed but are not due to be paid until a future date

stock_based_compensation

double

Refers to share-based compensation as the way of paying employees, executives, and directors of a company with equity in the business

other_non_cash_items

double

Represents other non-cash items

accounts_receivable

double

Represents the balance of money due to a firm for goods or services delivered or used but not yet paid for by customers

accounts_payable

double

Refers to an account within the general ledger that represents an obligation to pay off a short-term debt to creditors or suppliers

other_assets_liabilities

double

Represents cumulative changes in inventory, other current assets, other current liabilities, and other working capital

operating_cash_flow

double

Returns operating cash flow (OCF) measure representing a total amount of cash generated by company's normal business operations

investing_activities

object

Investing activities section

Attributes

capital_expenditures

double

Capital expenditures (CapEx) are funds used by a company to acquire, upgrade, and maintain physical assets (PPE)

net_intangibles

double

Represents purchase of a not physical asset

net_acquisitions

double

Refers to net amount of business purchase and sale

purchase_of_investments

double

Represents how much money has been used in making investments, including purchases of physical assets, investments in securities

sale_of_investments

double

Represents how much money has been generated from the sale of securities or assets

other_investing_activity

double

Represents other investing activity

investing_cash_flow

double

Returns total amount of cash flow used in investments

financing_activities

object

Financing activities section

Attributes

long_term_debt_issuance

double

Refers to the issuance of any financial obligations that extend beyond a 12 months period

long_term_debt_payments

double

Refers to the payments of any financial obligations that extend beyond a 12 months period

short_term_debt_issuance

double

Refers to the issuance of any financial obligations that are expected to be paid off within a year

common_stock_issuance

double

Represents a transaction whereby a company issues its own shares to the marketplace

common_stock_repurchase

double

Represents a transaction whereby a company buys back its own shares from the marketplace

common_dividends

double

Returns value of payment doled out by a company to its stockholders in the form of periodic distributions of cash

other_financing_charges

double

Represents other financing charges

financing_cash_flow

double

Returns cash flow from financing activities (CFF), which shows the net flows of cash that are used to fund the company

end_cash_position

double

Returns the amount of cash a company has when adding the change in cash and beginning cash balance for the current fiscal period

income_tax_paid

double

Refers to supplemental data about income tax paid

interest_paid

double

Refers to supplemental data about interest paid

free_cash_flow

double

Represents the cash a company generates after accounting for cash outflows to support operations and maintain its capital assets

Request example

https://api.twelvedata.com/cash_flow?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "exchange_timezone": "America/New_York",
        "period": "Quarterly"
    },
    "cash_flow": [
        {
            "fiscal_date": "2021-12-31",
            "quarter": "1",
            "year": 2022,
            "operating_activities": {
                "net_income": 34630000000,
                "depreciation": 2697000000,
                "deferred_taxes": 682000000,
                "stock_based_compensation": 2265000000,
                "other_non_cash_items": 167000000,
                "accounts_receivable": -13746000000,
                "accounts_payable": 19813000000,
                "other_assets_liabilities": 458000000,
                "operating_cash_flow": 46966000000
            },
            "investing_activities": {
                "capital_expenditures": -2803000000,
                "net_intangibles": 0,
                "net_acquisitions": 0,
                "purchase_of_investments": -34913000000,
                "sale_of_investments": 21984000000,
                "other_investing_activity": -374000000,
                "investing_cash_flow": -16106000000
            },
            "financing_activities": {
                "long_term_debt_issuance": 0,
                "long_term_debt_payments": 0,
                "short_term_debt_issuance": -1000000000,
                "common_stock_issuance": 0,
                "common_stock_repurchase": -20478000000,
                "common_dividends": -3732000000,
                "other_financing_charges": -2949000000,
                "financing_cash_flow": -28159000000
            },
            "end_cash_position": 38630000000,
            "income_tax_paid": 5235000000,
            "interest_paid": 531000000,
            "free_cash_flow": 49769000000
        }
    ]
}

Cash flow consolidated

/cash_flow/consolidated

Returns consolidated cash flow of a company showing the net amount of cash and cash equivalents being transferred into and out of business.

API credits cost

100 per symbol

This API endpoint is available starting with the Ultra plan. Full access to historical data is available only in the Enterprise plan.

Parameters Response

✱ symbol

string

Symbol ticker of instrument. For preffered stocks use dot(.) delimiter. E.g. BRK.A or BRK.B will be correct

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: United States

period

string

The reporting period for the cash flow statements

Supports: annual, quarterly

Default: annual

start_date

string

Start date for filtering cash flow statements. Only cash flow statements with fiscal dates on or after this date will be included. Format 2006-01-02

Example: 2024-01-01

end_date

string

End date for filtering cash flow statements. Only cash flow statements with fiscal dates on or before this date will be included. Format 2006-01-02

Example: 2024-12-31

outputsize

integer

Number of records in response

Default: 6

cash_flow

array of object

Cash flow data

Attributes

fiscal_date

string

Fiscal date

cash_flow_from_operating_activities

object

Cash flow from operating activities

Attributes

net_income_from_continuing_operations

double

Net income from continuing operations

operating_cash_flow

double

Operating cash flow

cash_flow_from_continuing_operating_activities

double

Cash flow from continuing operating activities

cash_from_discontinued_operating_activities

double

Cash from discontinued operating activities

cash_flow_from_discontinued_operation

double

Cash flow from discontinued operation

free_cash_flow

double

Free cash flow

cash_flows_from_used_in_operating_activities_direct

double

Cash flows from used in operating activities direct

taxes_refund_paid

double

Taxes refund paid

taxes_refund_paid_direct

double

Taxes refund paid direct

interest_received

double

Interest received

interest_received_direct

double

Interest received direct

interest_paid

double

Interest paid

interest_paid_direct

double

Interest paid direct

dividend_received

double

Dividend received

dividend_received_direct

double

Dividend received direct

dividend_paid

double

Dividend paid

dividend_paid_direct

double

Dividend paid direct

change_in_working_capital

double

Change in working capital

change_in_other_working_capital

double

Change in other working capital

change_in_receivables

double

Change in receivables

changes_in_account_receivables

double

Changes in account receivables

change_in_payables_and_accrued_expense

double

Change in payables and accrued expense

change_in_accrued_expense

double

Change in accrued expense

change_in_payable

double

Change in payable

change_in_dividend_payable

double

Change in dividend payable

change_in_account_payable

double

Change in account payable

change_in_tax_payable

double

Change in tax payable

change_in_income_tax_payable

double

Change in income tax payable

change_in_interest_payable

double

Change in interest payable

change_in_other_current_liabilities

double

Change in other current liabilities

change_in_other_current_assets

double

Change in other current assets

change_in_inventory

double

Change in inventory

change_in_prepaid_assets

double

Change in prepaid assets

other_non_cash_items

double

Other non cash items

excess_tax_benefit_from_stock_based_compensation

double

Excess tax benefit from stock based compensation

stock_based_compensation

double

Stock based compensation

unrealized_gain_loss_on_investment_securities

double

Unrealized gain loss on investment securities

provision_and_write_off_of_assets

double

Provision and write off of assets

asset_impairment_charge

double

Asset impairment charge

amortization_of_securities

double

Amortization of securities

deferred_tax

double

Deferred tax

deferred_income_tax

double

Deferred income tax

depreciation_amortization_depletion

double

Depreciation amortization depletion

depletion

double

Depletion

depreciation_and_amortization

double

Depreciation and amortization

amortization_cash_flow

double

Amortization cash flow

amortization_of_intangibles

double

Amortization of intangibles

depreciation

double

Depreciation

operating_gains_losses

double

Operating gains losses

pension_and_employee_benefit_expense

double

Pension and employee benefit expense

earnings_losses_from_equity_investments

double

Earnings losses from equity investments

gain_loss_on_investment_securities

double

Gain loss on investment securities

net_foreign_currency_exchange_gain_loss

double

Net foreign currency exchange gain loss

gain_loss_on_sale_of_ppe

double

Gain loss on sale of ppe

gain_loss_on_sale_of_business

double

Gain loss on sale of business

cash_flow_from_investing_activities

object

Cash flow from investing activities

Attributes

investing_cash_flow

double

Investing cash flow

cash_flow_from_continuing_investing_activities

double

Cash flow from continuing investing activities

cash_from_discontinued_investing_activities

double

Cash from discontinued investing activities

net_other_investing_changes

double

Net other investing changes

interest_received_cfi

double

Interest received cfi

dividends_received_cfi

double

Dividends received cfi

net_investment_purchase_and_sale

double

Net investment purchase and sale

sale_of_investment

double

Sale of investment

purchase_of_investment

double

Purchase of investment

net_investment_properties_purchase_and_sale

double

Net investment properties purchase and sale

sale_of_investment_properties

double

Sale of investment properties

purchase_of_investment_properties

double

Purchase of investment properties

net_business_purchase_and_sale

double

Net business purchase and sale

sale_of_business

double

Sale of business

purchase_of_business

double

Purchase of business

net_intangibles_purchase_and_sale

double

Net intangibles purchase and sale

sale_of_intangibles

double

Sale of intangibles

purchase_of_intangibles

double

Purchase of intangibles

net_ppe_purchase_and_sale

double

Net ppe purchase and sale

sale_of_ppe

double

Sale of ppe

purchase_of_ppe

double

Purchase of ppe

capital_expenditure_reported

double

Capital expenditure reported

capital_expenditure

double

Capital expenditure

cash_flow_from_financing_activities

object

Cash flow from financing activities

Attributes

financing_cash_flow

double

Financing cash flow

cash_flow_from_continuing_financing_activities

double

Cash flow from continuing financing activities

cash_from_discontinued_financing_activities

double

Cash from discontinued financing activities

net_other_financing_charges

double

Net other financing charges

interest_paid_cff

double

Interest paid cff

proceeds_from_stock_option_exercised

double

Proceeds from stock option exercised

cash_dividends_paid

double

Cash dividends paid

preferred_stock_dividend_paid

double

Preferred stock dividend paid

common_stock_dividend_paid

double

Common stock dividend paid

net_preferred_stock_issuance

double

Net preferred stock issuance

preferred_stock_payments

double

Preferred stock payments

preferred_stock_issuance

double

Preferred stock issuance

net_common_stock_issuance

double

Net common stock issuance

common_stock_payments

double

Common stock payments

common_stock_issuance

double

Common stock issuance

repurchase_of_capital_stock

double

Repurchase of capital stock

net_issuance_payments_of_debt

double

Net issuance payments of debt

net_short_term_debt_issuance

double

Net short term debt issuance

short_term_debt_payments

double

Short term debt payments

short_term_debt_issuance

double

Short term debt issuance

net_long_term_debt_issuance

double

Net long term debt issuance

long_term_debt_payments

double

Long term debt payments

long_term_debt_issuance

double

Long term debt issuance

issuance_of_debt

double

Issuance of debt

repayment_of_debt

double

Repayment of debt

issuance_of_capital_stock

double

Issuance of capital stock

supplemental_data

object

Supplemental data

Attributes

interest_paid_supplemental_data

double

Interest paid supplemental data

income_tax_paid_supplemental_data

double

Income tax paid supplemental data

foreign_and_domestic_sales

object

Foreign and domestic sales

Attributes

foreign_sales

double

Foreign sales

domestic_sales

double

Domestic sales

adjusted_geography_segment_data

double

Adjusted geography segment data

cash_position

object

Cash position

Attributes

beginning_cash_position

double

Beginning cash position

end_cash_position

double

End cash position

changes_in_cash

double

Changes in cash

other_cash_adjustment_outside_change_in_cash

double

Other cash adjustment outside change in cash

other_cash_adjustment_inside_change_in_cash

double

Other cash adjustment inside change in cash

effect_of_exchange_rate_changes

double

Effect of exchange rate changes

direct_method_cash_flow

object

Direct method cash flow

Attributes

classes_of_cash_receipts_from_operating_activities

double

Classes of cash receipts from operating activities

other_cash_receipts_from_operating_activities

double

Other cash receipts from operating activities

receipts_from_government_grants

double

Receipts from government grants

receipts_from_customers

double

Receipts from customers

classes_of_cash_payments

double

Classes of cash payments

other_cash_payments_from_operating_activities

double

Other cash payments from operating activities

payments_on_behalf_of_employees

double

Payments on behalf of employees

payments_to_suppliers_for_goods_and_services

double

Payments to suppliers for goods and services

status

string

Response status

Request example

https://api.twelvedata.com/cash_flow/consolidated?symbol=AAPL&apikey=demo&source=docs

Response

{
    "cash_flow": [
        {
            "fiscal_date": "2023-09-30",
            "cash_flow_from_operating_activities": {
                "net_income_from_continuing_operations": 96995000000,
                "operating_cash_flow": 110543000000,
                "cash_flow_from_continuing_operating_activities": 110543000000,
                "cash_from_discontinued_operating_activities": 108488000000,
                "cash_flow_from_discontinued_operation": 108488000000,
                "free_cash_flow": 99584000000,
                "cash_flows_from_used_in_operating_activities_direct": 108488000000,
                "taxes_refund_paid": 108488000000,
                "taxes_refund_paid_direct": 108488000000,
                "interest_received": 108488000000,
                "interest_received_direct": 108488000000,
                "interest_paid": 108488000000,
                "interest_paid_direct": 108488000000,
                "dividend_received": 108488000000,
                "dividend_received_direct": 108488000000,
                "dividend_paid": 108488000000,
                "dividend_paid_direct": 108488000000,
                "change_in_working_capital": -6577000000,
                "change_in_other_working_capital": 108488000000,
                "change_in_receivables": -417000000,
                "changes_in_account_receivables": -1688000000,
                "change_in_payables_and_accrued_expense": -1889000000,
                "change_in_accrued_expense": 108488000000,
                "change_in_payable": -1889000000,
                "change_in_dividend_payable": 108488000000,
                "change_in_account_payable": -1889000000,
                "change_in_tax_payable": 108488000000,
                "change_in_income_tax_payable": 108488000000,
                "change_in_interest_payable": 108488000000,
                "change_in_other_current_liabilities": 3031000000,
                "change_in_other_current_assets": -5684000000,
                "change_in_inventory": -1618000000,
                "change_in_prepaid_assets": 108488000000,
                "other_non_cash_items": -2227000000,
                "excess_tax_benefit_from_stock_based_compensation": 108488000000,
                "stock_based_compensation": 10833000000,
                "unrealized_gain_loss_on_investment_securities": 108488000000,
                "provision_and_write_off_of_assets": 108488000000,
                "asset_impairment_charge": 108488000000,
                "amortization_of_securities": 108488000000,
                "deferred_tax": 108488000000,
                "deferred_income_tax": 108488000000,
                "depreciation_amortization_depletion": 11519000000,
                "depletion": 108488000000,
                "depreciation_and_amortization": 11519000000,
                "amortization_cash_flow": 108488000000,
                "amortization_of_intangibles": 108488000000,
                "depreciation": 108488000000,
                "operating_gains_losses": 108488000000,
                "pension_and_employee_benefit_expense": 108488000000,
                "earnings_losses_from_equity_investments": 108488000000,
                "gain_loss_on_investment_securities": 108488000000,
                "net_foreign_currency_exchange_gain_loss": 108488000000,
                "gain_loss_on_sale_of_ppe": 108488000000,
                "gain_loss_on_sale_of_business": 108488000000
            },
            "cash_flow_from_investing_activities": {
                "investing_cash_flow": 3705000000,
                "cash_flow_from_continuing_investing_activities": 3705000000,
                "cash_from_discontinued_investing_activities": 108488000000,
                "net_other_investing_changes": -1337000000,
                "interest_received_cfi": 108488000000,
                "dividends_received_cfi": 108488000000,
                "net_investment_purchase_and_sale": 16001000000,
                "sale_of_investment": 45514000000,
                "purchase_of_investment": -29513000000,
                "net_investment_properties_purchase_and_sale": 108488000000,
                "sale_of_investment_properties": 108488000000,
                "purchase_of_investment_properties": 108488000000,
                "net_business_purchase_and_sale": 108488000000,
                "sale_of_business": 108488000000,
                "purchase_of_business": 108488000000,
                "net_intangibles_purchase_and_sale": 108488000000,
                "sale_of_intangibles": 108488000000,
                "purchase_of_intangibles": 108488000000,
                "net_ppe_purchase_and_sale": -10959000000,
                "sale_of_ppe": 108488000000,
                "purchase_of_ppe": -10959000000,
                "capital_expenditure_reported": 108488000000,
                "capital_expenditure": -10959000000
            },
            "cash_flow_from_financing_activities": {
                "financing_cash_flow": -108488000000,
                "cash_flow_from_continuing_financing_activities": -108488000000,
                "cash_from_discontinued_financing_activities": 108488000000,
                "net_other_financing_charges": -6012000000,
                "interest_paid_cff": 108488000000,
                "proceeds_from_stock_option_exercised": 108488000000,
                "cash_dividends_paid": -15025000000,
                "preferred_stock_dividend_paid": 108488000000,
                "common_stock_dividend_paid": -15025000000,
                "net_preferred_stock_issuance": 108488000000,
                "preferred_stock_payments": 108488000000,
                "preferred_stock_issuance": 108488000000,
                "net_common_stock_issuance": -77550000000,
                "common_stock_payments": -77550000000,
                "common_stock_issuance": 108488000000,
                "repurchase_of_capital_stock": -77550000000,
                "net_issuance_payments_of_debt": -9901000000,
                "net_short_term_debt_issuance": -3978000000,
                "short_term_debt_payments": 108488000000,
                "short_term_debt_issuance": 108488000000,
                "net_long_term_debt_issuance": -5923000000,
                "long_term_debt_payments": -11151000000,
                "long_term_debt_issuance": 5228000000,
                "issuance_of_debt": 5228000000,
                "repayment_of_debt": -11151000000,
                "issuance_of_capital_stock": 108488000000
            },
            "supplemental_data": {
                "interest_paid_supplemental_data": 3803000000,
                "income_tax_paid_supplemental_data": 18679000000
            },
            "foreign_and_domestic_sales": {
                "foreign_sales": 108488000000,
                "domestic_sales": 108488000000,
                "adjusted_geography_segment_data": 108488000000
            },
            "cash_position": {
                "beginning_cash_position": 24977000000,
                "end_cash_position": 30737000000,
                "changes_in_cash": 5760000000,
                "other_cash_adjustment_outside_change_in_cash": 108488000000,
                "other_cash_adjustment_inside_change_in_cash": 108488000000,
                "effect_of_exchange_rate_changes": 108488000000
            },
            "direct_method_cash_flow": {
                "classes_of_cash_receipts_from_operating_activities": 108488000000,
                "other_cash_receipts_from_operating_activities": 108488000000,
                "receipts_from_government_grants": 108488000000,
                "receipts_from_customers": 108488000000,
                "classes_of_cash_payments": 108488000000,
                "other_cash_payments_from_operating_activities": 108488000000,
                "payments_on_behalf_of_employees": 108488000000,
                "payments_to_suppliers_for_goods_and_services": 108488000000
            }
        }
    ],
    "status": "ok"
}

Key executives Useful

/key_executives

Returns key executive information for a specified symbol.

API credits cost

1000 per symbol

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Symbol ticker of instrument. For preffered stocks use dot(.) delimiter. E.g. BRK.A or BRK.B will be correct

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: United States

meta

object

Meta information about the instrument

Attributes

symbol

string

Ticker symbol of instrument

name

string

Name of the company

currency

string

Currency code in which the instrument is denominated

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

key_executives

array of object

List of key executives

Attributes

name

string

Full name of an executive, including first name, middle name, last name, and suffix

title

string

Refers to job title

age

integer

Current age of an executive if available

year_born

integer

Year of birth of an executive if available

pay

integer

Total salary of an executive if available

Request example

https://api.twelvedata.com/key_executives?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "exchange_timezone": "America/New_York"
    },
    "key_executives": [
        {
            "name": "Mr. Timothy D. Cook",
            "title": "CEO & Director",
            "age": 59,
            "year_born": 1961,
            "pay": 14769259
        }
    ]
}

Last changes New

/last_change/{endpoint}

Returns the latest changes of fundamental data. This endpoint helps consume API credits more efficiently and request new data once it is updated.

API credits cost

1 per request

Parameters Response

✱ endpoint

string

Endpoint name

Supports: price_target, recommendations, statistics, insider_transactions, profile, mutual_funds_world_summary, mutual_funds_world, institutional_holders, analyst_rating, income_statement, income_statement_quarterly, cash_flow, cash_flow_quarterly, balance_sheet, balance_sheet_quarterly, mutual_funds_list, mutual_funds_world_sustainability, mutual_funds_world_summary, mutual_funds_world_risk, mutual_funds_world_purchase_info, mutual_funds_world_composition, mutual_funds_world_performance, mutual_funds_world, etfs_list, etfs_world, etfs_world_summary, etfs_world_performance, etfs_world_risk, etfs_world_composition

Example: statistics

start_date

string

The starting date and time for data selection, in 2006-01-02 15:04:05 format

Example: 2023-10-14 00:00:00

symbol

string

Filter by symbol

Example: AAPL

exchange

string

Filter by exchange name

Example: NASDAQ

mic_code

string

Filter by market identifier code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

page

integer

Page number

Default: 1

outputsize

integer

Number of records in response

Default: 30

Request example

https://api.twelvedata.com/last_change/statistics?apikey=demo&source=docs

Response

{
    "pagination": {
        "current_page": 1,
        "per_page": 30
    },
    "data": [
        {
            "symbol": "AAPL",
            "mic_code": "XNAS",
            "last_change": "2023-10-14 12:22:48"
        }
    ]
}

Market capitalization New

/market_cap

Market capitalization history.

API credits cost

5 per request

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Filter by symbol

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Filter by exchange name

Example: NASDAQ

mic_code

string

Filter by market identifier code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

start_date

string

Start date for market capitalization data retrieval. Data will be returned from this date onwards. Format 2006-01-02

Example: 2023-01-01

end_date

string

End date for market capitalization data retrieval. Data will be returned up to and including this date. Format 2006-01-02

Example: 2023-12-31

page

integer

Page number

Default: 1

outputsize

integer

Number of records in response

Default: 10

Request example

https://api.twelvedata.com/market_cap?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "exchange_timezone": "America/New_York"
    },
    "market_cap": [
        {
            "date": "2021-08-06",
            "value": 10000000000
        }
    ]
}

Analysis

Earnings estimate Useful

/earnings_estimate

This API endpoint returns analysts' estimate for a company's future quarterly and annual earnings per share (EPS).

API credits cost

20 per symbol

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Filter by symbol

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Exchange where instrument is traded

Example: NASDAQ

country

string

The country where the instrument is traded, e.g.,United States or US

Example: United States

meta

object

Meta information about the symbol

Attributes

symbol

string

Symbol ticker of the instrument

name

string

Name of the instrument

currency

string

Currency in which the instrument is traded

exchange_timezone

string

Timezone of the exchange

exchange

string

Exchange where the instrument is traded

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

type

string

Type of the instrument

earnings_estimate

array of object

List of earnings estimates

Attributes

date

string

Date of the earnings estimate

period

string

Period of estimation, can be current_quarter, next_quarter, current_year, or next_year

number_of_analysts

integer

Number of analysts that made the estimation

avg_estimate

double

Average estimation across analysts

low_estimate

double

Lowest estimation given by an analyst

high_estimate

double

Highest estimation given by an analyst

year_ago_eps

double

Average estimation of this period's earnings given a year ago

status

string

Response status

Request example

https://api.twelvedata.com/earnings_estimate?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNGS",
        "type": "Common Stock"
    },
    "earnings_estimate": [
        {
            "date": "2022-09-30",
            "period": "current_quarter",
            "number_of_analysts": 27,
            "avg_estimate": 1.26,
            "low_estimate": 1.13,
            "high_estimate": 1.35,
            "year_ago_eps": 1.24
        }
    ],
    "status": "ok"
}

Revenue estimate

/revenue_estimate

This API endpoint returns analysts' estimate for a company's future quarterly and annual sales (total revenue).

API credits cost

20 per symbol

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Filter by symbol

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

exchange

string

Filter by exchange name

Example: NASDAQ

integer

Number of decimal places for floating values. Should be in range [0,11] inclusive

Default: 5

meta

object

Meta information about the symbol

Attributes

symbol

string

Symbol ticker of the instrument

name

string

Name of the instrument

currency

string

Currency in which the instrument is traded

exchange_timezone

string

Timezone of the exchange

exchange

string

Exchange where the instrument is traded

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

type

string

Type of the instrument

revenue_estimate

array of object

Revenue estimate data

Attributes

date

string

Date of the estimate

period

string

Period of estimation, can be current_quarter, next_quarter, current_year, or next_year

number_of_analysts

integer

Number of analysts that made the estimation

avg_estimate

double

Average estimation across analysts

low_estimate

double

Lowest estimation given by an analyst

high_estimate

double

Highest estimation given by an analyst

year_ago_sales

double

Total revenue received a year ago relative to period

sales_growth

double

Estimated sales growth of the period in relation to year-ago sales in prc (%)

status

string

Status of the response

Request example

https://api.twelvedata.com/revenue_estimate?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNGS",
        "type": "Common Stock"
    },
    "revenue_estimate": [
        {
            "date": "2022-09-30",
            "period": "current_quarter",
            "number_of_analysts": 24,
            "avg_estimate": 88631500000,
            "low_estimate": 85144300000,
            "high_estimate": 92794900000,
            "year_ago_sales": 83360000000,
            "sales_growth": 0.06
        }
    ],
    "status": "ok"
}

EPS trend

/eps_trend

This API endpoint returns a breakdown of the estimated historical EPS changes at a given period.

API credits cost

20 per symbol

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Filter by symbol

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

exchange

string

Filter by exchange name

Example: NASDAQ

meta

object

Meta information about the symbol

Attributes

symbol

string

Symbol ticker of the instrument

name

string

Name of the instrument

currency

string

Currency in which the instrument is traded

exchange_timezone

string

Timezone of the exchange

exchange

string

Exchange where the instrument is traded

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

type

string

Type of the instrument

eps_trend

array of object

EPS trend data

Attributes

date

string

Date of the estimation

period

string

Period of estimation, can be current_quarter, next_quarter, current_year, or next_year

current_estimate

double

Actual EPS estimation for the period

7_days_ago

double

EPS estimation value 7 days ago

30_days_ago

double

EPS estimation value 30 days ago

60_days_ago

double

EPS estimation value 60 days ago

90_days_ago

double

EPS estimation value 90 days ago

status

string

Status of the response

Request example

https://api.twelvedata.com/eps_trend?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNGS",
        "type": "Common Stock"
    },
    "eps_trend": [
        {
            "date": "2022-09-30",
            "period": "current_quarter",
            "current_estimate": 1.26,
            "7_days_ago": 1.26,
            "30_days_ago": 1.31,
            "60_days_ago": 1.32,
            "90_days_ago": 1.33
        }
    ],
    "status": "ok"
}

EPS revisions

/eps_revisions

This API endpoint returns analysts’ revisions of a company's future quarterly and annual earnings per share (EPS) over the last week and month.

API credits cost

20 per symbol

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Filter by symbol

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

exchange

string

Filter by exchange name

Example: NASDAQ

meta

object

Meta information about the symbol

Attributes

symbol

string

Symbol ticker of the instrument

name

string

Name of the instrument

currency

string

Currency in which the instrument is traded

exchange_timezone

string

Timezone of the exchange

exchange

string

Exchange where the instrument is traded

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

type

string

Type of the instrument

eps_revision

array of object

EPS revision data

Attributes

date

string

Date of the EPS estimate

period

string

Period of estimation, can be current_quarter, next_quarter, current_year, or next_year

up_last_week

integer

Number of up revisions over the last 7 days

up_last_month

integer

Number of up revisions over the last 30 days

down_last_week

integer

Number of down revisions over the last 7 days

down_last_month

integer

Number of down revisions over the last 30 days

status

string

Status of the response

Request example

https://api.twelvedata.com/eps_revisions?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNGS",
        "type": "Common Stock"
    },
    "eps_revision": [
        {
            "date": "2022-09-30",
            "period": "current_quarter",
            "up_last_week": 1,
            "up_last_month": 5,
            "down_last_week": 0,
            "down_last_month": 0
        }
    ],
    "status": "ok"
}

Growth estimates

/growth_estimates

This API endpoint returns consensus analyst estimates over the company's growth rates for various periods. Calculation averages projections of numerous analysts, taking arbitrary parameters, such as earnings per share, revenue, etc.

API credits cost

20 per symbol

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Filter by symbol

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

exchange

string

Exchange where instrument is traded

Example: NASDAQ

meta

object

Meta information about the symbol

Attributes

symbol

string

Symbol ticker of the instrument

name

string

Name of the instrument

currency

string

Currency in which the instrument is traded

exchange_timezone

string

Timezone of the exchange

exchange

string

Exchange where the instrument is traded

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

type

string

Type of the instrument

growth_estimates

object

Growth estimates data

Attributes

current_quarter

double

Projected growth of the current quarter in percentage (%)

next_quarter

double

Projected growth of the next quarter in percentage (%)

current_year

double

Projected growth of the current year in percentage (%)

next_year

double

Projected growth of the next year in percentage (%)

next_5_years_pa

double

Projected growth during the next 5 years in percentage (%) per annum

past_5_years_pa

double

Actual growth over the last 5 years in percentage (%) per annum

status

string

Status of the request

Request example

https://api.twelvedata.com/growth_estimates?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNGS",
        "type": "Common Stock"
    },
    "growth_estimates": {
        "current_quarter": 0.016,
        "next_quarter": 0.01,
        "current_year": 0.087,
        "next_year": 0.055999998,
        "next_5_years_pa": 0.094799995,
        "past_5_years_pa": 0.23867
    },
    "status": "ok"
}

Recommendations High demand

/recommendations

This API endpoint returns the average of all analyst recommendations and classifies them as Strong Buy, Buy, Hold, or Sell. Also, it returns a recommendation score.

API credits cost

100 per symbol

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Filter by symbol

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

exchange

string

The exchange name where the instrument is traded, e.g., Nasdaq, NSE.

Example: NASDAQ

meta

object

Metadata about the symbol

Attributes

symbol

string

Symbol ticker of the instrument

name

string

Name of the instrument

currency

string

Currency in which the instrument is traded

exchange_timezone

string

Timezone of the exchange

exchange

string

Exchange where the instrument is traded

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

type

string

Type of the instrument

trends

object

Analyst recommendations trends

Attributes

current_month

object

Current month recommendations

Attributes

strong_buy

integer

Number of analysts that give a strong buy recommendation

buy

integer

Number of analysts that give a buy recommendation

hold

integer

Number of analysts that give a hold recommendation

sell

integer

Number of analysts that give a sell recommendation

strong_sell

integer

Number of analysts that give a strong sell recommendation

previous_month

object

Previous month recommendations

Attributes

strong_buy

integer

Number of analysts that give a strong buy recommendation

buy

integer

Number of analysts that give a buy recommendation

hold

integer

Number of analysts that give a hold recommendation

sell

integer

Number of analysts that give a sell recommendation

strong_sell

integer

Number of analysts that give a strong sell recommendation

2_months_ago

object

Two months ago recommendations

Attributes

strong_buy

integer

Number of analysts that give a strong buy recommendation

buy

integer

Number of analysts that give a buy recommendation

hold

integer

Number of analysts that give a hold recommendation

sell

integer

Number of analysts that give a sell recommendation

strong_sell

integer

Number of analysts that give a strong sell recommendation

3_months_ago

object

Three months ago recommendations

Attributes

strong_buy

integer

Number of analysts that give a strong buy recommendation

buy

integer

Number of analysts that give a buy recommendation

hold

integer

Number of analysts that give a hold recommendation

sell

integer

Number of analysts that give a sell recommendation

strong_sell

integer

Number of analysts that give a strong sell recommendation

rating

double

Rating from 0 to 10 represents overall analysts' recommendation. 0 to 2 - strong sell, 2 to 4 - sell, 4 to 6 - hold, 6 to 8 - buy, 8 to 10 - strong buy.

status

string

Response status

Request example

https://api.twelvedata.com/recommendations?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNGS",
        "type": "Common Stock"
    },
    "trends": {
        "current_month": {
            "strong_buy": 13,
            "buy": 20,
            "hold": 8,
            "sell": 0,
            "strong_sell": 0
        },
        "previous_month": {
            "strong_buy": 13,
            "buy": 20,
            "hold": 8,
            "sell": 0,
            "strong_sell": 0
        },
        "2_months_ago": {
            "strong_buy": 13,
            "buy": 20,
            "hold": 8,
            "sell": 0,
            "strong_sell": 0
        },
        "3_months_ago": {
            "strong_buy": 13,
            "buy": 20,
            "hold": 8,
            "sell": 0,
            "strong_sell": 0
        }
    },
    "rating": 8.2,
    "status": "ok"
}

Price target High demand

/price_target

This API endpoint returns the analysts' projection of a security's future price.

API credits cost

75 per symbol

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Filter by symbol

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

exchange

string

Filter by exchange name

Example: NASDAQ

meta

object

Meta information about the security

Attributes

symbol

string

Symbol ticker of the instrument

name

string

Name of the instrument

currency

string

Currency in which the instrument is traded

exchange_timezone

string

Timezone of the exchange

exchange

string

Exchange where the instrument is traded

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

type

string

Type of the instrument

price_target

object

Price target information

Attributes

high

double

Highest price target given by an analyst

median

double

Median price target given across analysts

low

double

Lowest price target given by an analyst

average

double

Average price target given across analysts

current

double

Current price from of a security

currency

string

Currency in which the price targets values are quoted

status

string

Response status

Request example

https://api.twelvedata.com/price_target?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNGS",
        "type": "Common Stock"
    },
    "price_target": {
        "high": 220,
        "median": 185,
        "low": 136,
        "average": 184.01,
        "current": 169.5672,
        "currency": "USD"
    },
    "status": "ok"
}

Analyst ratings - light

/analyst_ratings/light

This API endpoint returns a lightweight version of ratings issued by analyst firms. Works for US and international markets.

API credits cost

75 per symbol

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Filter by symbol

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

country

string

Filter by country name or alpha code, e.g., United States or US

Example: United States

exchange

string

Filter by exchange name

Example: NASDAQ

rating_change

string

Filter by rating change action

Supports: Maintains, Upgrade, Downgrade, Initiates, Reiterates

outputsize

integer

Number of records in response

Default: 30

meta

object

Meta information about the instrument

Attributes

symbol

string

Symbol ticker of the instrument

name

string

Name of the instrument

currency

string

Currency in which the instrument is traded

exchange_timezone

string

Timezone of the exchange

exchange

string

Exchange where the instrument is traded

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

type

string

Type of the instrument

ratings

array of object

List of analyst ratings

Attributes

date

string

Date when the rating was released

firm

string

Firm that issued the ranking

rating_change

string

Defines the action of the firm to ranking, could be Maintains, Upgrade, Downgrade, Initiates or Reiterates

rating_current

string

Current firm's ranking of the instrument

rating_prior

string

Prior firm's ranking of the instrument

status

string

Response status

Request example

https://api.twelvedata.com/analyst_ratings/light?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNGS",
        "type": "Common Stock"
    },
    "ratings": [
        {
            "date": "2022-08-19",
            "firm": "Keybanc",
            "rating_change": "Maintains",
            "rating_current": "Overweight",
            "rating_prior": "Overweight"
        }
    ],
    "status": "ok"
}

Analyst ratings - US equities

/analyst_ratings/us_equities

This API endpoint returns complete information on ratings issued by analyst firms. Works only for US equities.

API credits cost

200 per symbol

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Filter by symbol

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Filter by exchange name

Example: NASDAQ

rating_change

string

Filter by rating change action

Supports: Maintains, Upgrade, Downgrade, Initiates, Reiterates

outputsize

integer

Number of records in response

Default: 30

meta

object

Meta information about the instrument

Attributes

symbol

string

Symbol ticker of the instrument

name

string

Name of the instrument

currency

string

Currency in which the instrument is traded

exchange_timezone

string

Timezone of the exchange

exchange

string

Exchange where the instrument is traded

mic_code

string

Market identifier code (MIC) under ISO 10383 standard

type

string

Type of the instrument

ratings

array of object

List of analyst ratings

Attributes

date

string

Date when the rating was released

firm

string

Firm that issued the ranking

analyst_name

string

Name of an analyst

rating_change

string

Defines the action of the firm to ranking, could be Maintains, Upgrade, Downgrade, Initiates, Reiterates, Assumes, or Reinstates

rating_current

string

Current firm's ranking of the instrument

rating_prior

string

Prior firm's ranking of the instrument

time

string

Time when the rating was released or updated

action_price_target

string

Action that firm took towards target price

price_target_current

integer

Current firm's price target for the instrument

price_target_prior

integer

Prior firm's price target for the instrument

status

string

Response status

Request example

https://api.twelvedata.com/analyst_ratings/us_equities?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNGS",
        "type": "Common Stock"
    },
    "ratings": [
        {
            "date": "2022-08-19",
            "firm": "Keybanc",
            "analyst_name": "Brandon Nispel",
            "rating_change": "Maintains",
            "rating_current": "Overweight",
            "rating_prior": "Overweight",
            "time": "08:29:48",
            "action_price_target": "Raises",
            "price_target_current": 185,
            "price_target_prior": 177
        }
    ],
    "status": "ok"
}

Regulatory

Tax information

/tax_info

This API endpoint returns tax information for the instrument.

API credits cost

50 per symbol

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

The ticker symbol of an instrument for which data is requested, e.g., SKYQ, AIRE, ALM:BME, HSI:HKEX.

Example: SKYQ

figi

string

The FIGI of an instrument for which data is requested

Example: BBG019XJT9D6

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

isin

string

The ISIN of an instrument for which data is requested

Example: US5949181045

exchange

string

The exchange name where the instrument is traded, e.g., Nasdaq, Euronext

Example: Nasdaq

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded, e.g., XNAS, XLON

Example: XNAS

Request example

https://api.twelvedata.com/tax_info?symbol=SKYQ&apikey=demo&source=docs

Response

{
    "data": {
        "tax_indicator": "spanish_ftt"
    },
    "meta": {
        "symbol": "ALM",
        "type": "Almirall SA",
        "exchange": "BME",
        "mic_code": "XMAD",
        "country": "Spain"
    },
    "status": "ok"
}

Edgar filings archive New

/edgar_filings/archive

Real-time and historical access to all forms, filings, and exhibits directly from the SEC's EDGAR system.

API credits cost

50 per request

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

The ticker symbol of an instrument for which data is requested

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Filter by exchange name

Example: NASDAQ

mic_code

string

Filter by market identifier code (MIC) under ISO 10383 standard

Example: XNGS

country

string

Filter by country name or alpha code, e.g., United States or US

form_type

string

Filter by form types, example 8-K, EX-1.1

Example: 8-K

filled_from

string

Filter by filled time from

Example: 2024-01-01

filled_to

string

Filter by filled time to

Example: 2024-01-01

page

integer

Page number

Default: 1

page_size

integer

Number of records in response

Default: 10

meta

object

Meta information about the company and listing

Attributes

symbol

string

Ticker of the company

exchange

string

Exchange name where the company is listed

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

type

string

Issue type of the stock

values

array of object

List of filings

Attributes

cik

integer

CIK code

filed_at

integer

Filing date in UNIX timestamp

form_type

string

Filing form type

files

array of object

Filing files

Attributes

name

string

File name

size

integer

File size

type

string

File type

url

string

File full url

filing_url

string

Full URL of the filing

Request example

https://api.twelvedata.com/edgar_filings/archive?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "exchange": "NASDAQ",
        "mic_code": "XNGS",
        "type": "Common Stock"
    },
    "values": [
        {
            "cik": 1711463,
            "filed_at": 1726617600,
            "form_type": "144",
            "files": [
                {
                    "name": "primary_doc.html",
                    "size": 2980,
                    "type": "144",
                    "url": "https://www.sec.gov/Archives/edgar/data/1711463/000197185724000581/primary_doc.xml"
                }
            ],
            "filing_url": "https://www.sec.gov/Archives/edgar/data/1711463/0001971857-24-000581-index.htm"
        }
    ]
}

Insider Transactions

/insider_transactions

Returns trading information performed by insiders.

API credits cost

200 per symbol

This API endpoint is available starting with the Pro plan.

Parameters Response

✱ symbol

string

The ticker symbol of an instrument for which data is requested, e.g., AAPL, TSLA. For preffered stocks use dot(.) delimiter. E.g. BRK.A or BRK.B will be correct

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Exchange where instrument is traded, e.g., Nasdaq, NSE.

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US.

Example: United States

meta

object

Metadata about the instrument

Attributes

symbol

string

Ticker symbol of instrument

name

string

Name of the company

currency

string

Currency of the instrument according to the ISO 4217 standard

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

insider_transactions

array of object

List of insider transactions

Attributes

full_name

string

Full name of an individual, including first name, middle name, last name, and suffix

position

string

Job position of insider

date_reported

string

Date the transaction was reported

is_direct

boolean

true if direct, false if indirect

integer

As per report the number of shares acquired or disposed of the transaction

value

integer

Represents the value of transaction, calculated as price multiplied by the volume

description

string

Exact price or price range of the transaction if available

Request example

https://api.twelvedata.com/insider_transactions?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "exchange_timezone": "America/New_York"
    },
    "insider_transactions": [
        {
            "full_name": "ADAMS KATHERINE L",
            "position": "General Counsel",
            "date_reported": "2021-05-03",
            "is_direct": true,
            "shares": 17000,
            "value": 2257631,
            "description": "Sale at price 132.57 - 133.93 per share."
        }
    ]
}

Institutional Holders

/institutional_holders

Returns the amount of the company’s available stock owned by institutions (pension funds, insurance companies, investment firms, private foundations, endowments, or other large entities that manage funds on behalf of others).

API credits cost

1500 per symbol

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Symbol ticker of instrument. For preffered stocks use dot(.) delimiter. E.g. BRK.A or BRK.B will be correct

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: United States

meta

object

Meta information about the financial instrument

Attributes

symbol

string

Ticker symbol of instrument

name

string

Name of symbol

currency

string

Currency of the instrument according to the ISO 4217 standard

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

institutional_holders

array of object

List of institutional holders for the financial instrument

Attributes

entity_name

string

Refers to the legal name of the institution

date_reported

string

Refers to date reported

integer

Refers to the number of shares owned

value

integer

Total value of shares owned, calculated by multiplying shares by the current price

percent_held

double

Represents the percentage of shares outstanding that are owned by the financial institution

Request example

https://api.twelvedata.com/institutional_holders?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "exchange_timezone": "America/New_York"
    },
    "institutional_holders": [
        {
            "entity_name": "Vanguard Group, Inc. (The)",
            "date_reported": "2021-06-30",
            "shares": 1264936543,
            "value": 173245708929,
            "percent_held": 0.0765
        }
    ]
}

Fund Holders

/fund_holders

Returns the amount of the company’s available stock owned by mutual fund holders.

API credits cost

1500 per symbol

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ symbol

string

Symbol ticker of instrument. For preffered stocks use dot(.) delimiter. E.g. BRK.A or BRK.B will be correct

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: United States

meta

object

Meta information about the financial instrument

Attributes

symbol

string

Ticker symbol of instrument

name

string

Name of symbol

currency

string

Currency of the instrument according to the ISO 4217 standard

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

fund_holders

array of object

List of fund holders for the financial instrument

Attributes

entity_name

string

Refers to the legal name of the institution

date_reported

string

Refers to date reported

integer

Refers to the number of shares owned

value

integer

Total value of shares owned, calculated by multiplying shares by the current price

percent_held

double

Represents the percentage of shares outstanding that are owned by the financial institution

Request example

https://api.twelvedata.com/fund_holders?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "exchange_timezone": "America/New_York"
    },
    "fund_holders": [
        {
            "entity_name": "Vanguard Group, Inc. (The)",
            "date_reported": "2021-06-30",
            "shares": 1264936543,
            "value": 173245708929,
            "percent_held": 0.0765
        }
    ]
}

Direct Holders New

/direct_holders

Returns the amount of the stocks owned directly and recorded in the company's share registry.

API credits cost

1500 per symbol

This API endpoint is available starting with the Ultra plan and currently working in beta for the Tadawul exchange.

Parameters Response

✱ symbol

string

Symbol ticker of instrument. For preffered stocks use dot(.) delimiter. E.g. BRK.A or BRK.B will be correct

Example: AAPL

figi

string

Filter by financial instrument global identifier (FIGI)

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

Country where instrument is traded, e.g., United States or US

Example: United States

meta

object

Meta information about the financial instrument

Attributes

symbol

string

Ticker symbol of instrument

name

string

Name of symbol

currency

string

Currency of the instrument according to the ISO 4217 standard

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

direct_holders

array of object

List of direct holders for the financial instrument

Attributes

entity_name

string

Refers to the legal name of the institution

date_reported

string

Refers to date reported

integer

Refers to the number of shares owned

value

integer

Total value of shares owned, calculated by multiplying shares by the current price

percent_held

double

Represents the percentage of shares outstanding that are owned by the financial institution

Request example

https://api.twelvedata.com/direct_holders?symbol=AAPL&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "name": "Apple Inc",
        "currency": "USD",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "exchange_timezone": "America/New_York"
    },
    "direct_holders": [
        {
            "entity_name": "Vanguard Group, Inc. (The)",
            "date_reported": "2021-06-30",
            "shares": 1264936543,
            "value": 173245708929,
            "percent_held": 0.0765
        }
    ]
}

Sanctioned entities New

/sanctions/{source}

This API endpoint returns a list of sanctioned entities for a given sanction source (ofac, uk, eu, au, etc)

API credits cost

50 per request

This API endpoint is available starting with the Ultra plan.

Parameters Response

✱ source

string

Sanctions source

Supports: ofac, uk, eu, au

Example: ofac

sanctions

array of object

List of sanctioned entities

Attributes

symbol

string

The instrument symbol ticker

name

string

The instrument name

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

country

string

Country name

sanction

object

Attributes

source

string

The sanction source

program

string

The sanction program

notes

string

Notes for the sanction

lists

array of object

Sanction lists

Attributes

name

string

The sanction list name

published_at

string

The sanction published date in the current sanctions list

count

integer

Total number of sanctioned entities

status

string

Response status

Request example

https://api.twelvedata.com/sanctions/ofac?apikey=demo&source=docs

Response

{
    "sanctions": [
        {
            "symbol": "LOKESHMACH",
            "name": "Lokesh Machines Ltd.",
            "mic_code": "NSE",
            "country": "India",
            "sanction": {
                "source": "ofac",
                "program": "RUSSIA-EO14024",
                "notes": "Block",
                "lists": [
                    {
                        "name": "SDN List",
                        "published_at": "2024-10-30"
                    }
                ]
            }
        }
    ],
    "count": 143,
    "status": "ok"
}

Advanced

Batches Useful

/batch

This endpoint allows you to request multiple instruments, intervals, and endpoints simultaneously.

Request body

Only JSON POST requests are supported. The request content structure consists of key-value items. The key is a unique request ID. The value is requested url.

Response

The response contains key-value data. The key is a unique request ID. The value is returned data.

API credits

The number of concurrent requests is limited by your subscription plan.
Credits are consumed per requested endpoint, with the total usage equal to the sum of individual requests in the batch.
If the requested data exceeds your available credits, only partial data will be returned asynchronously until your quota is exhausted.
If one or more requests in the batch contain errors (e.g., invalid symbols or unsupported intervals), it will not affect the successful processing of other requests. Errors are reported individually within the response, allowing you to identify and correct specific issues without impacting the entire batch.

Parameters Response

No parameters are required

Request example

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&source=docs&outputsize=2"
    },
    "req_2": {
        "url": "/exchange_rate?symbol=USD/JPY&apikey=demo&source=docs"
    },
    "req_3": {
        "url": "/currency_conversion?symbol=USD/JPY&amount=122&apikey=demo&source=docs"
    }
}
EOF

Response

{
    "code": 200,
    "status": "success",
    "data": {
        "req_1": {
            "response": {
                "meta": {
                    "currency": "USD",
                    "exchange": "NASDAQ",
                    "exchange_timezone": "America/New_York",
                    "interval": "1min",
                    "mic_code": "XNGS",
                    "symbol": "AAPL",
                    "type": "Common Stock"
                },
                "status": "ok",
                "values": [
                    {
                        "close": "248.6",
                        "datetime": "2025-02-21 12:51:00",
                        "high": "248.6",
                        "low": "248.4",
                        "open": "248.5",
                        "volume": "22290"
                    },
                    {
                        "close": "248.52",
                        "datetime": "2025-02-21 12:50:00",
                        "high": "248.59",
                        "low": "248.43",
                        "open": "248.52",
                        "volume": "64085"
                    }
                ]
            },
            "status": "success"
        },
        "req_2": {
            "response": {
                "rate": 149.25999,
                "symbol": "USD/JPY",
                "timestamp": 1740160260
            },
            "status": "success"
        },
        "req_3": {
            "response": {
                "amount": 18209.71933,
                "rate": 149.25999,
                "symbol": "USD/JPY",
                "timestamp": 1740160260
            },
            "status": "success"
        }
    }
}

API Usage

/api_usage

This endpoint will provide information on the current usage of Twelve Data API.

API credits cost

1 per request

Parameters Response

format

string

Output format

Supports: JSON, CSV

Default: JSON

delimiter

string

Specify the delimiter used when downloading the CSV file

Default: ;

Request example

https://api.twelvedata.com/api_usage?apikey=demo&source=docs

Response

{
    "timestamp": "2025-05-07 11:10:12",
    "current_usage": 4003,
    "plan_limit": 4181
}

Technical Indicators

Technical indicators return real-time and historical values of the demanded indicator at the selected interval. If you don‘t see the necessary technical indicator, you may request it to be added.

Overlap Studies

Plotted directly on the price chart to smooth or envelope price data, highlighting trend direction, support/resistance, and mean-reversion levels (e.g. moving averages, Bollinger Bands, Parabolic SAR, Ichimoku Cloud, Keltner Channels, McGinley Dynamic).

BBANDS High demand

/bbands

Bollinger Bands (BBANDS) are volatility bands placed above and below a moving average, measuring price volatility and helping traders identify potential overbought or oversold conditions.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

ma_type

string

The type of moving average used

Supports: SMA, EMA, WMA, DEMA, TEMA, TRIMA, KAMA, MAMA, T3MA

Default: SMA

number

Number of standard deviations. Must be at least 1

Default: 2

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 20

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

ma_type

string

Moving average type

double

Number of standard deviations

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

upper_band

string

Upper band value

middle_band

string

Middle band value

lower_band

string

Lower band value

status

string

Response status

Request example

https://api.twelvedata.com/bbands?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "BBANDS - Bollinger Bands\u00ae",
            "ma_type": "SMA",
            "sd": 2,
            "series_type": "close",
            "time_period": 20
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "upper_band": "203.36511",
            "middle_band": "202.04999",
            "lower_band": "200.73486"
        }
    ],
    "status": "ok"
}

DEMA

/dema

The Double Exponential Moving Average (DEMA) is a more responsive moving average that reduces lag by giving more weight to recent price data, helping traders identify trends and potential entry or exit points.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

dema

string

Dema value

status

string

Response status

Request example

https://api.twelvedata.com/dema?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "DEMA - Double Exponential Moving Average",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "dema": "200.93371"
        }
    ],
    "status": "ok"
}

EMA High demand

/ema

The Exponential Moving Average (EMA) is a weighted moving average that gives more importance to recent price data, making it more responsive to new information and helping traders identify trends and potential entry or exit points.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

ema

string

EMA value

status

string

Response status

Request example

https://api.twelvedata.com/ema?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "EMA - Exponential Moving Average",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "ema": "201.38109"
        }
    ],
    "status": "ok"
}

HT_TRENDLINE

/ht_trendline

The Hilbert Transform Instantaneous Trendline (HT_TRENDLINE) is a smoothed moving average that follows the dominant market cycle, helping traders identify trends and potential entry or exit points.

You can read more about it in the Rocket Science for Traders book by John F. Ehlers.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

ht_trendline

string

HT_TRENDLINE value

status

string

Response status

Request example

https://api.twelvedata.com/ht_trendline?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "HT_TRENDLINE - Hilbert Transform Instantaneous Trendline",
            "series_type": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "ht_trendline": "202.26597"
        }
    ],
    "status": "ok"
}

ICHIMOKU

/ichimoku

The Ichimoku Cloud (ICHIMOKU) is a comprehensive trend-following indicator that combines multiple moving averages and support/resistance levels to help traders identify potential entry and exit points, trend direction, and momentum.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

conversion_line_period

integer

The time period used for generating the conversation line. Takes values in the range from 1 to 800

Default: 9

base_line_period

integer

The time period used for generating the base line. Takes values in the range from 1 to 800

Default: 26

leading_span_b_period

integer

The time period used for generating the leading span B line. Takes values in the range from 1 to 800

Default: 52

lagging_span_period

integer

The time period used for generating the lagging span line. Takes values in the range from 1 to 800

Default: 26

include_ahead_span_period

boolean

Indicates whether to include ahead span period

Default: true

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

conversion_line_period

integer

The time period used for generating the conversation line

base_line_period

integer

The time period used for generating the base line

leading_span_b_period

integer

The time period used for generating the leading span B line

lagging_span_period

integer

The time period used for generating the lagging span line

include_ahead_span_period

boolean

Indicates whether to include ahead span period

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

tenkan_sen

string

Tenkan-sen value

kijun_sen

string

Kijun-sen value

senkou_span_a

string

Senkou span A value

senkou_span_b

string

Senkou span B value

chikou_span

string

Chikou span value

status

string

Response status

Request example

https://api.twelvedata.com/ichimoku?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "ICHIMOKU - Ichimoku Kink\u014d Hy\u014d",
            "conversion_line_period": 9,
            "base_line_period": 26,
            "leading_span_b_period": 52,
            "lagging_span_period": 26,
            "include_ahead_span_period": true
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "tenkan_sen": "200.33",
            "kijun_sen": "201.42",
            "senkou_span_a": "201.49",
            "senkou_span_b": "200.35501",
            "chikou_span": "199.95499"
        }
    ],
    "status": "ok"
}

KAMA

/kama

The Kaufman Adaptive Moving Average (KAMA) is a moving average that adjusts its length based on market volatility, providing a balance between responsiveness and noise reduction.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

kama

string

Kama value

status

string

Response status

Request example

https://api.twelvedata.com/kama?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "KAMA - Kaufman's Adaptive Moving Average",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "kama": "201.06741"
        }
    ],
    "status": "ok"
}

KELTNER

/keltner

The Keltner Channel (KELTNER) is a volatility-based indicator that uses a combination of EMA and the ATR to create a channel around a security's price. The channel helps traders identify potential overbought or oversold conditions, as well as trend direction and potential price breakouts.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 20

atr_time_period

integer

The time period used for calculating the Average True Range. Takes values in the range from 1 to 800

Default: 10

multiplier

integer

The factor used to adjust the indicator's sensitivity

Default: 2

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

ma_type

string

The type of moving average used

Supports: SMA, EMA, WMA, DEMA, TEMA, TRIMA, KAMA, MAMA, T3MA

Default: SMA

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

Number of periods to average over

atr_time_period

integer

The time period used for calculating the Average True Range

multiplier

integer

The factor used to adjust the indicator's sensitivity

series_type

string

Price type on which technical indicator is calculated

ma_type

string

The type of moving average used

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

upper_line

string

Upper line value

middle_line

string

Middle line value

lower_line

string

Lower line value

status

string

Response status

Request example

https://api.twelvedata.com/keltner?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "KELTNER - Keltner Channels",
            "time_period": 20,
            "atr_time_period": 10,
            "multiplier": 2,
            "series_type": "close",
            "ma_type": "SMA"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "upper_line": "202.25298",
            "middle_line": "201.80985",
            "lower_line": "201.36672"
        }
    ],
    "status": "ok"
}

MA

/ma

The Moving Average (MA) is a smoothing indicator that calculates the average price of a security over a specified period, helping traders identify trends and potential support or resistance levels.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

ma_type

string

The type of moving average used

Supports: SMA, EMA, WMA, DEMA, TEMA, TRIMA, KAMA, MAMA, T3MA

Default: SMA

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

ma_type

string

The type of moving average used

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

string

MA value

status

string

Response status

Request example

https://api.twelvedata.com/ma?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MA - Moving Average",
            "series_type": "close",
            "time_period": 9,
            "ma_type": "SMA"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "ma": "201.41205"
        }
    ],
    "status": "ok"
}

MAMA

/mama

The MESA Adaptive Moving Average (MAMA) is a moving average that adapts to price movement based on the dominant market cycle, providing a balance between responsiveness and noise reduction. More about MAMA can be read here.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

fast_limit

number

The limit for the fast moving average.

Default: 0.5

slow_limit

number

The limit for the slow moving average.

Default: 0.05

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

fast_limit

double

The limit for the fast moving average

slow_limit

double

The limit for the slow moving average

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

mama

string

MAMA value

fama

string

FAMA value

status

string

Response status

Request example

https://api.twelvedata.com/mama?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MAMA - MESA Adaptive Moving Average",
            "series_type": "close",
            "fast_limit": 0.5,
            "slow_limit": 0.05
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "mama": "201.38887",
            "fama": "202.05517"
        }
    ],
    "status": "ok"
}

MCGINLEY_DYNAMIC

/mcginley_dynamic

The McGinley Dynamic (MCGINLEY_DYNAMIC) indicator is a smoothing tool designed to minimize the lag between the indicator and price action. It adjusts its speed based on the volatility of the security, providing a more accurate representation of price trends and potential support or resistance levels compared to traditional moving averages.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 14

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

mcginley_dynamic

string

McGinley Dynamic value

status

string

Response status

Request example

https://api.twelvedata.com/mcginley_dynamic?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MCGINLEY_DYNAMIC - McGinley Dynamic",
            "time_period": 14
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "mcginley_dynamic": "201.93983"
        }
    ],
    "status": "ok"
}

MIDPOINT

/midpoint

The Midpoint (MIDPOINT) indicator calculates the midpoint of a data series over a specified period, often used to smooth out data fluctuations and identify trends.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

midpoint

string

Midpoint value

status

string

Response status

Request example

https://api.twelvedata.com/midpoint?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MIDPOINT - MidPoint over period",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "midpoint": "201.4925"
        }
    ],
    "status": "ok"
}

MIDPRICE

/midprice

The Midprice (MIDPRICE) indicator calculates the average of a security's high and low prices over a specified period, providing a smoothed view of price action and potential support or resistance levels.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

The time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

midprice

string

Midprice value

status

string

Response status

Request example

https://api.twelvedata.com/midprice?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MIDPRICE - Midpoint Price over period",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "midprice": "201.535"
        }
    ],
    "status": "ok"
}

PIVOT_POINTS_HL

/pivot_points_hl

The Pivot Points High Low (PIVOT_POINTS_HL) indicator calculates support and resistance levels based on the highest high and lowest low of a security's price over a specified period, providing potential entry and exit points.

API credits cost

1 per symbol

This API endpoint is available starting with the Pro plan.

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 10

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

The time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

pivot_point_h

integer

1 if it is a high pivot point, otherwise 0

pivot_point_l

integer

1 if it is a low pivot point, otherwise 0

status

string

Response status

Request example

https://api.twelvedata.com/pivot_points_hl?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "PIVOT_POINTS_HL - Pivot Points (High/Low)",
            "time_period": 10
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "pivot_point_h": 1,
            "pivot_point_l": 0
        }
    ],
    "status": "ok"
}

SAR

/sar

The Parabolic SAR (SAR) is a trend-following indicator that calculates potential support and resistance levels based on a security's price and time, helping traders identify potential entry and exit points.

API credits cost

1 per symbol

This API endpoint is available starting with the Grow plan.

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

acceleration

number

The rate of change in the indicator's values.

Default: 0.02

maximum

number

The maximum value considered for the indicator calculation.

Default: 0.2

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

acceleration

double

The acceleration factor used in the indicator calculation

maximum

double

The maximum value considered for the indicator calculation

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

sar

string

SAR value

status

string

Response status

Request example

https://api.twelvedata.com/sar?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "SAR - Parabolic SAR",
            "acceleration": 0.02,
            "maximum": 0.2
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "sar": "201.54365"
        }
    ],
    "status": "ok"
}

SAREXT

/sarext

The Parabolic SAR Extended (SAREXT) is a customizable version of the Parabolic SAR indicator, allowing traders to choose different parameters for increased flexibility in identifying potential entry and exit points.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

start_value

number

The initial value for the indicator calculation.

Default: 0

offset_on_reverse

number

The adjustment applied when the indicator's direction changes.

Default: 0

acceleration_limit_long

number

The maximum acceleration value for long positions.

Default: 0.02

acceleration_long

number

The acceleration value for long positions.

Default: 0.02

acceleration_max_long

number

The highest allowed acceleration for long positions.

Default: 0.2

acceleration_limit_short

number

The maximum acceleration value for short positions.

Default: 0.02

acceleration_short

number

The acceleration value for short positions.

Default: 0.02

acceleration_max_short

number

The highest allowed acceleration for short positions.

Default: 0.2

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

start_value

double

The initial value for the indicator calculation

offset_on_reverse

double

The adjustment applied when the indicator's direction changes

acceleration_limit_long

double

The maximum acceleration value for long positions

acceleration_long

double

The acceleration value for long positions

acceleration_max_long

double

The highest allowed acceleration for long positions

acceleration_limit_short

double

The maximum acceleration value for short positions

acceleration_short

double

The acceleration value for short positions

acceleration_max_short

double

The highest allowed acceleration for short positions

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

sarext

string

SAREXT value

status

string

Response status

Request example

https://api.twelvedata.com/sarext?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "SAREXT - Parabolic SAR Extended",
            "start_value": 0,
            "offset_on_reverse": 0,
            "acceleration_limit_long": 0.02,
            "acceleration_long": 0.02,
            "acceleration_max_long": 0.2,
            "acceleration_limit_short": 0.02,
            "acceleration_short": 0.02,
            "acceleration_max_short": 0.2
        }
    },
    "values": [
        {
            "datetime": "2025-04-02",
            "sarext": "214.059460"
        }
    ],
    "status": "ok"
}

SMA High demand

/sma

The Simple Moving Average (SMA) is a smoothing indicator that calculates the average price of a security over a specified period, helping traders identify trends and potential support or resistance levels.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

The time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

sma

string

SMA value

status

string

Response status

Request example

https://api.twelvedata.com/sma?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "SMA - Simple Moving Average",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "sma": "201.41205"
        }
    ],
    "status": "ok"
}

T3MA

/t3ma

The Triple Exponential Moving Average (T3MA) is a smoothing indicator that applies three exponential moving averages to price data, reducing lag and providing a more accurate representation of trends.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

v_factor

number

The factor used to adjust the indicator's volatility. Takes values in the range from 0 to 1

Default: 0.7

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

The time period used for calculation in the indicator

v_factor

double

The factor used to adjust the indicator's volatility

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

t3ma

string

T3MA value

status

string

Response status

Request example

https://api.twelvedata.com/t3ma?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "T3MA - Triple Exponential Moving Average",
            "series_type": "close",
            "time_period": 9,
            "v_factor": 0.7
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "t3ma": "201.56277"
        }
    ],
    "status": "ok"
}

TEMA

/tema

The Triple Exponential Moving Average (TEMA) is a smoothing indicator that applies three exponential moving averages to price data, reducing lag and providing a more accurate representation of trends.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

The time period used for calculation in the indicator. Default is 9.

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

The time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

tema

string

TEMA value

status

string

Response status

Request example

https://api.twelvedata.com/tema?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "TEMA - Triple Exponential Moving Average",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "tema": "200.83136"
        }
    ],
    "status": "ok"
}

TRIMA

/trima

The Triangular Moving Average (TRIMA) is a smoothing indicator that calculates the average price of a security over a specified period, weighting prices in the middle of the range more heavily, providing a balanced view of price action.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

The time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

trima

string

TRIMA value

status

string

Response status

Request example

https://api.twelvedata.com/trima?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "TRIMA - Triangular Moving Average",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "trima": "201.36415"
        }
    ],
    "status": "ok"
}

VWAP

/vwap

The Volume Weighted Average Price (VWAP) indicator offers an insightful measure of the average trading price weighted by volume, commonly used for trading analysis and execution evaluation.

API credits cost

1 per symbol

Take note that this endpoint is applicable to all instruments except currencies.

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

number

The standard deviation applied in the calculation. Must be greater than 0. Recommended value is 2. This parameter is only used together with sd_time_period.

Default: 0

sd_time_period

integer

The time period for the standard deviation calculation. Must be greater than 0. Recommended value is 9. This parameter is only used together with sd.

Default: 0

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

sd_time_period

integer

Standard deviation time period

double

Standard deviation value

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

vwap

string

VWAP value

status

string

Response status

Request example

https://api.twelvedata.com/vwap?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "VWAP - Volume Weighted Average Price",
            "sd_time_period": 0,
            "sd": 0
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "vwap": "201.05266"
        }
    ],
    "status": "ok"
}

WMA

/wma

The Weighted Moving Average (WMA) is a smoothing indicator that calculates the average price of a security over a specified period, with more weight given to recent prices, providing a more responsive view of price action.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

The time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

wma

string

WMA value

status

string

Response status

Request example

https://api.twelvedata.com/wma?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "WMA - Weighted Moving Average",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "wma": "201.20579"
        }
    ],
    "status": "ok"
}

Momentum Indicators

Oscillators that measure the speed or strength of price movement, helping detect overbought/oversold conditions, divergences, and shifts in trend momentum (e.g. RSI, MACD, ROC, Stochastics, ADX, CCI, Coppock Curve, TRIX).

ADX High demand

/adx

The Average Directional Index (ADX) measures the strength of a trend, regardless of direction, helping traders determine if a market is trending or ranging.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 14

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

adx

string

ADX value

status

string

Response status

Request example

https://api.twelvedata.com/adx?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "ADX - Average Directional Index",
            "time_period": 14
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "adx": "49.22897"
        }
    ],
    "status": "ok"
}

ADXR

/adxr

The Average Directional Movement Index Rating (ADXR) is a smoothed version of ADX, providing a more stable measure of trend strength over time.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 14

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

adxr

string

Adxr value

status

string

Response status

Request example

https://api.twelvedata.com/adxr?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "ADXR - Average Directional Movement Index Rating",
            "time_period": 14
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "adxr": "37.43665"
        }
    ],
    "status": "ok"
}

APO

/apo

The Absolute Price Oscillator (APO) is a momentum indicator that measures the difference between two moving averages, helping traders identify potential price trends and reversals.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

fast_period

integer

Number of periods for fast moving average. Takes values in the range from 1 to 800

Default: 12

ma_type

string

The type of moving average used

Supports: SMA, EMA, WMA, DEMA, TEMA, TRIMA, KAMA, MAMA, T3MA

Default: SMA

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

slow_period

integer

Number of periods for slow moving average. Takes values in the range from 1 to 800

Default: 26

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

fast_period

integer

Number of periods for fast moving average

ma_type

string

Type of moving average used

slow_period

integer

Number of periods for slow moving average

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

apo

string

APO value

status

string

Response status

Request example

https://api.twelvedata.com/apo?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "APO - Absolute Price Oscillator",
            "series_type": "close",
            "fast_period": 12,
            "ma_type": "SMA",
            "slow_period": 26
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "apo": "-0.54508"
        }
    ],
    "status": "ok"
}

AROON

/aroon

The Aroon indicator detects the presence and strength of trends by measuring the time elapsed since the highest high and lowest low within a specific period.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 14

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

aroon_down

string

Aroon down value

aroon_up

string

Aroon up value

status

string

Response status

Request example

https://api.twelvedata.com/aroon?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "AROON - Aroon Indicator",
            "time_period": 14
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "aroon_down": "92.85714",
            "aroon_up": "0.0"
        }
    ],
    "status": "ok"
}

AROONOSC

/aroonosc

The Aroon Oscillator is the difference between the Aroon Up and Aroon Down lines, indicating trend strength and potential reversals.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 14

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

aroonosc

string

Aroon oscillator value

status

string

Response status

Request example

https://api.twelvedata.com/aroonosc?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "AROONOSC - Aroon Oscillator",
            "time_period": 14
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "aroonosc": "-92.85714"
        }
    ],
    "status": "ok"
}

BOP

/bop

The Balance of Power (BOP) indicator measures the balance between buying and selling pressure in a security by comparing its open, high, low, and close prices, helping traders identify potential price trends.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

bop

string

Bop value

status

string

Response status

Request example

https://api.twelvedata.com/bop?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "BOP - Balance of Power"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "bop": "0.27231"
        }
    ],
    "status": "ok"
}

CCI

/cci

The Commodity Channel Index (CCI) is a momentum oscillator that measures the deviation of a security's price from its average relative to its typical price range, helping traders identify overbought or oversold conditions.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 20

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

cci

string

CCI value

status

string

Response status

Request example

https://api.twelvedata.com/cci?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "CCI - Commodity Channel Index",
            "time_period": 20
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "cci": "-122.30794"
        }
    ],
    "status": "ok"
}

CMO

/cmo

The Chande Momentum Oscillator (CMO) is a momentum indicator that measures the relative strength of up and down price movements, helping traders identify overbought or oversold conditions and potential trend reversals.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

cmo

string

CMO value

status

string

Response status

Request example

https://api.twelvedata.com/cmo?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "CMO - Chande Momentum Oscillator",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "cmo": "-71.24979"
        }
    ],
    "status": "ok"
}

COPPOCK

/coppock

The Coppock Curve is a momentum oscillator that measures the rate of change in a security's price, helping traders identify potential long-term trend reversals, especially in bottoming markets.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

long_roc_period

integer

Number of periods for long term rate of change. Takes values in the range from 1 to 800

Default: 14

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

short_roc_period

integer

Number of periods for short term rate of change. Takes values in the range from 1 to 800

Default: 11

wma_period

integer

Number of periods for weighted moving average. Takes values in the range from 1 to 800

Default: 10

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

wma_period

integer

Number of periods for weighted moving average

long_roc_period

integer

Number of periods for long term rate of change

short_roc_period

integer

Number of periods for short term rate of change

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

coppock

string

Coppock value

status

string

Response status

Request example

https://api.twelvedata.com/coppock?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "COPPOCK - Coppock Curve",
            "series_type": "close",
            "wma_period": 10,
            "long_roc_period": 14,
            "short_roc_period": 11
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "coppock": "-1.37253"
        }
    ],
    "status": "ok"
}

CRSI

/crsi

The Connors RSI is a composite indicator combining the Relative Strength Index (RSI), the Rate of Change (ROC), and the Up/Down Length, providing a more comprehensive view of momentum and potential trend reversals.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

percent_rank_period

integer

Number of periods used to calculate PercentRank. Takes values in the range from 1 to 800

Default: 100

rsi_period

integer

Number of periods for RSI used to calculate price momentum. Takes values in the range from 1 to 800

Default: 3

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

up_down_length

integer

Number of periods for RSI used to calculate up/down trend. Takes values in the range from 1 to 800

Default: 2

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

rsi_period

integer

Number of periods for RSI used to calculate price momentum

up_down_length

integer

Number of periods for RSI used to calculate up/down trend

percent_rank_period

integer

Number of periods used to calculate PercentRank

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

crsi

string

crsi value

status

string

Response status

Request example

https://api.twelvedata.com/crsi?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "CRSI - ConnorsRSI",
            "series_type": "close",
            "rsi_period": 3,
            "up_down_length": 2,
            "percent_rank_period": 100
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "crsi": "74.76102"
        }
    ],
    "status": "ok"
}

DPO

/dpo

The Detrended Price Oscillator (DPO) is a momentum oscillator that removes the underlying trend from price data, helping traders identify potential cyclical patterns and overbought or oversold conditions.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

centered

boolean

Specifies if there should be a shift to match the current price

Default: false

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

centered

boolean

Specifies if there should be a shift to match the current price

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

dpo

string

DPO value

status

string

Response status

Request example

https://api.twelvedata.com/dpo?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "DPO - Detrended Price Oscillator",
            "series_type": "close",
            "time_period": 21,
            "centered": false
        }
    },
    "values": [
        {
            "datetime": "2025-04-01",
            "dpo": "-7.99619"
        }
    ],
    "status": "ok"
}

DX

/dx

The Directional Movement Index (DX) is a component of the ADX indicator, measuring the strength of the positive and negative directional movements in a security's price.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 14

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

string

dx value

status

string

Response status

Request example

https://api.twelvedata.com/dx?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "DX - Directional Movement Index",
            "time_period": 14
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "dx": "68.70803"
        }
    ],
    "status": "ok"
}

KST

/kst

The Know Sure Thing (KST) is a momentum oscillator that combines four different smoothed rates of change to generate a single trend-following indicator. By measuring the price momentum across multiple timeframes, KST helps traders identify potential trend reversals, overbought, or oversold conditions, and trading opportunities.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

roc_period_1

integer

The time period for the first Rate of Change calculation.

Default: 10

roc_period_2

integer

The time period for the second Rate of Change calculation.

Default: 15

roc_period_3

integer

The time period for the third Rate of Change calculation.

Default: 20

roc_period_4

integer

The time period for the forth Rate of Change calculation.

Default: 30

sma_period_1

integer

The time period for the first Simple Moving Average.

Default: 10

sma_period_2

integer

The time period for the second Simple Moving Average.

Default: 10

sma_period_3

integer

The time period for the third Simple Moving Average.

Default: 10

sma_period_4

integer

The time period for the forth Simple Moving Average.

Default: 15

signal_period

integer

The time period used for generating the signal line.

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

roc_period_1

integer

The time period for the first Rate of Change calculation

roc_period_2

integer

The time period for the second Rate of Change calculation

roc_period_3

integer

The time period for the third Rate of Change calculation

roc_period_4

integer

The time period for the forth Rate of Change calculation

sma_period_1

integer

The time period for the first Simple Moving Average

sma_period_2

integer

The time period for the second Simple Moving Average

sma_period_3

integer

The time period for the third Simple Moving Average

sma_period_4

integer

The time period for the forth Simple Moving Average

signal_period

integer

The time period used for generating the signal line

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

kst

string

KST value

kst_signal

string

KST signal value

status

string

Response status

Request example

https://api.twelvedata.com/kst?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "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"
        }
    ],
    "status": "ok"
}

MACD High demand

/macd

The Moving Average Convergence Divergence (MACD) is a momentum indicator that measures the difference between two moving averages, with a signal line used to identify potential trend reversals and trading opportunities.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

fast_period

integer

Number of periods for fast moving average. Takes values in the range from 1 to 800

Default: 12

slow_period

integer

Number of periods for slow moving average. Takes values in the range from 1 to 800

Default: 26

signal_period

integer

The time period used for generating the signal line.

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

fast_period

integer

Fast period value

slow_period

integer

Slow period value

signal_period

integer

Signal period value

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

macd

string

MACD value

macd_signal

string

MACD signal line value

macd_hist

string

MACD histogram value

status

string

Response status

Request example

https://api.twelvedata.com/macd?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MACD - Moving Average Convergence Divergence",
            "series_type": "close",
            "fast_period": 12,
            "slow_period": 26,
            "signal_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "macd": "-0.3998",
            "macd_signal": "-0.25279",
            "macd_hist": "-0.147"
        }
    ],
    "status": "ok"
}

MACD SLOPE

/macd_slope

The MACD Slope is the rate of change of the MACD line, helping traders identify the acceleration or deceleration of momentum in a security's price.

API credits cost

1 per symbol

This API endpoint is available starting with the Pro plan.

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

fast_period

integer

Number of periods for fast moving average. Takes values in the range from 1 to 800

Default: 12

slow_period

integer

Number of periods for slow moving average. Takes values in the range from 1 to 800

Default: 26

signal_period

integer

The time period used for generating the signal line.

Default: 9

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

fast_period

integer

The shorter time period for calculation

slow_period

integer

The longer time period for calculation

signal_period

integer

The time period used for generating the signal line

time_period

integer

The time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

macd_slope

string

MACD slope value

macd_signal_slope

string

MACD signal slope value

macd_hist_slope

string

MACD histogram slope value

status

string

Response status

Request example

https://api.twelvedata.com/macd_slope?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MACD_SLOPE - Moving Average Convergence Divergence Regression Slope",
            "series_type": "close",
            "fast_period": 12,
            "slow_period": 26,
            "signal_period": 9,
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "macd_slope": "0.13358",
            "macd_signal_slope": "0.05345",
            "macd_hist_slope": "0.08013"
        }
    ],
    "status": "ok"
}

MACDEXT

/macdext

The MACD Extension (MACDEXT) is a customizable version of the MACD indicator, allowing traders to choose different moving average types and parameters for increased flexibility.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

fast_period

integer

Number of periods for fast moving average. Takes values in the range from 1 to 800

Default: 12

fast_ma_type

string

The type of fast moving average used in the calculation.

Supports: SMA, EMA, WMA, DEMA, TEMA, TRIMA, KAMA, MAMA, T3MA

Default: SMA

slow_period

integer

Number of periods for slow moving average. Takes values in the range from 1 to 800

Default: 26

slow_ma_type

string

The type of slow moving average used in the calculation.

Supports: SMA, EMA, WMA, DEMA, TEMA, TRIMA, KAMA, MAMA, T3MA

Default: SMA

signal_period

integer

The time period used for generating the signal line.

Default: 9

signal_ma_type

string

The type of fast moving average used for generating the signal line.

Supports: SMA, EMA, WMA, DEMA, TEMA, TRIMA, KAMA, MAMA, T3MA

Default: SMA

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

fast_period

integer

The shorter time period for calculation

fast_ma_type

string

The type of fast moving average used in the calculation

slow_period

integer

The longer time period for calculation

slow_ma_type

string

The type of slow moving average used in the calculation

signal_period

integer

The time period used for generating the signal line

signal_ma_type

string

The type of moving average used for generating the signal line

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

macd

string

MACD value

macd_signal

string

MACD signal line value

macd_hist

string

MACD histogram value

status

string

Response status

Request example

https://api.twelvedata.com/macdext?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MACDEXT - Moving Average Convergence Divergence Extended",
            "series_type": "close",
            "fast_period": 12,
            "fast_ma_type": "SMA",
            "slow_period": 26,
            "slow_ma_type": "SMA",
            "signal_period": 9,
            "signal_ma_type": "SMA"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "macd": "-0.54508",
            "macd_signal": "-0.25615",
            "macd_hist": "-0.28894"
        }
    ],
    "status": "ok"
}

MFI

/mfi

The Money Flow Index (MFI) is a volume-weighted momentum oscillator that measures buying and selling pressure by comparing positive and negative money flow, helping traders identify overbought or oversold conditions.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 14

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

mfi

string

MFI value

status

string

Response status

Request example

https://api.twelvedata.com/mfi?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MFI - Money Flow Index",
            "time_period": 14
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "mfi": "22.68525"
        }
    ],
    "status": "ok"
}

MINUS_DI

/minus_di

The Minus Directional Indicator (MINUS_DI) is a component of the ADX indicator, measuring the strength of a security's downward price movement.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

minus_di

string

Minus_di value

status

string

Response status

Request example

https://api.twelvedata.com/minus_di?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MINUS_DI - Minus Directional Indicator",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "minus_di": "46.60579"
        }
    ],
    "status": "ok"
}

MINUS_DM

/minus_dm

The Minus Directional Movement (MINUS_DM) is a component of the ADX indicator, measuring the extent of a security's downward price movement.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

The time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

minus_dm

string

Minus Directional Movement value

status

string

Response status

Request example

https://api.twelvedata.com/minus_dm?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MINUS_DM - Minus Directional Movement",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "minus_dm": "0.96291"
        }
    ],
    "status": "ok"
}

MOM

/mom

The Momentum (MOM) indicator measures the rate of change of a security's price over a specified period, helping traders identify potential price trends and reversals.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

The time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

mom

string

Mom value

status

string

Response status

Request example

https://api.twelvedata.com/mom?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MOM - Momentum",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "mom": "-1.14"
        }
    ],
    "status": "ok"
}

PERCENT_B High demand

/percent_b

The Percent B (%B) is a component of the Bollinger Bands indicator, measuring the position of a security's price relative to the bands, helping traders identify potential overbought or oversold conditions.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

number

The standard deviation applied in the calculation. Must be at least 1

Default: 2

ma_type

string

The type of moving average used

Supports: SMA, EMA, WMA, DEMA, TEMA, TRIMA, KAMA, MAMA, T3MA

Default: SMA

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

The time period used for calculation in the indicator

double

The standard deviation applied in the calculation

ma_type

string

The type of moving average used

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

percent_b

string

Percent_b value

status

string

Response status

Request example

https://api.twelvedata.com/percent_b?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "PERCENT_B - %B Indicator",
            "series_type": "close",
            "time_period": 20,
            "sd": 2,
            "ma_type": "SMA"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "percent_b": "0.11981"
        }
    ],
    "status": "ok"
}

PLUS_DI

/plus_di

The Plus Directional Indicator (PLUS_DI) is a component of the ADX indicator, measuring the strength of a security's upward price movement.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

The time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

plus_di

string

plus_di value

status

string

Response status

Request example

https://api.twelvedata.com/plus_di?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "PLUS_DI - Plus Directional Indicator",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "plus_di": "7.69578"
        }
    ],
    "status": "ok"
}

PLUS_DM

/plus_dm

The Plus Directional Movement (PLUS_DM) is a component of the ADX indicator, measuring the extent of a security's upward price movement.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

plus_dm

string

plus_dm value

status

string

Response status

Request example

https://api.twelvedata.com/plus_dm?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "PLUS_DM - Plus Directional Movement",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "plus_dm": "0.159"
        }
    ],
    "status": "ok"
}

PPO

/ppo

The Percentage Price Oscillator (PPO) is a momentum oscillator that measures the percentage difference between two moving averages, helping traders identify potential trend reversals and trading opportunities.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

fast_period

integer

Number of periods for fast moving average. Takes values in the range from 1 to 800

Default: 12

slow_period

integer

Number of periods for slow moving average. Takes values in the range from 1 to 800

Default: 26

ma_type

string

The type of moving average used

Supports: SMA, EMA, WMA, DEMA, TEMA, TRIMA, KAMA, MAMA, T3MA

Default: SMA

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

fast_period

integer

The shorter time period for calculation

slow_period

integer

The longer time period for calculation

ma_type

string

The type of moving average used

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

ppo

string

PPO value

status

string

Response status

Request example

https://api.twelvedata.com/ppo?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "PPO - Percentage Price Oscillator",
            "series_type": "close",
            "fast_period": 12,
            "slow_period": 26,
            "ma_type": "SMA"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "ppo": "-0.2696"
        }
    ],
    "status": "ok"
}

ROC

/roc

The Rate of Change (ROC) indicator measures the percentage change in a security's price over a specified period, helping traders identify potential price trends and reversals.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

The time period used for calculation

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

roc

string

roc value

status

string

Response status

Request example

https://api.twelvedata.com/roc?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "ROC - Rate of change",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "roc": "-0.56383"
        }
    ],
    "status": "ok"
}

ROCP

/rocp

The Rate of Change Percentage (ROCP) indicator calculates the percentage change in a security's price over a specified period, providing insight into momentum and potential trend reversals.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

rocp

string

ROCP value

status

string

Response status

Request example

https://api.twelvedata.com/rocp?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "ROCP - Rate of change percentage",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "rocp": "-0.00564"
        }
    ],
    "status": "ok"
}

ROCR

/rocr

The Rate of Change Ratio (ROCR) indicator measures the ratio of a security's current price to its price a specified number of periods ago, helping traders identify potential price trends and reversals.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

name

string

Name of the technical indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

rocr

string

ROCR value

status

string

Response status

Request example

https://api.twelvedata.com/rocr?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "series_type": "close",
            "time_period": 9,
            "name": "ROCR - Rate of change ratio"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "rocr": "0.99436"
        }
    ],
    "status": "ok"
}

ROCR100

/rocr100

The Rate of Change Ratio 100 (ROCR100) indicator measures the percentage change in a security's price over a specified period, expressed as a ratio to 100, providing insight into momentum and potential trend reversals.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

The time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

rocr100

string

rocr100 value

status

string

Response status

Request example

https://api.twelvedata.com/rocr100?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "ROCR100 - Rate of change ratio 100 scale",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "rocr100": "99.43617"
        }
    ],
    "status": "ok"
}

RSI High demand

/rsi

The Relative Strength Index (RSI) is a momentum oscillator that measures the speed and change of price movements, helping traders identify potential overbought or oversold conditions and trend reversals.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 14

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

The time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

rsi

string

RSI value

status

string

Response status

Request example

https://api.twelvedata.com/rsi?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "RSI - Relative Strength Index",
            "series_type": "close",
            "time_period": 14
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "rsi": "16.57887"
        }
    ],
    "status": "ok"
}

STOCH High demand

/stoch

The Stochastic Oscillator (STOCH) is a momentum indicator that compares a security's closing price to its price range over a specified period, helping traders identify potential overbought or oversold conditions and trend reversals.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

fast_k_period

integer

The time period for the fast %K line in the Stochastic Oscillator. Takes values in the range from 1 to 800

Default: 14

slow_k_period

integer

The time period for the slow %K line in the Stochastic Oscillator. Takes values in the range from 1 to 800

Default: 1

slow_d_period

integer

The time period for the slow %D line in the Stochastic Oscillator. Takes values in the range from 1 to 800

Default: 3

slow_kma_type

string

The type of slow %K Moving Average used. Default is SMA.

Supports: SMA, EMA, WMA, DEMA, TEMA, TRIMA, KAMA, MAMA, T3MA

Default: SMA

slow_dma_type

string

The type of slow Displaced Moving Average used. Default is SMA.

Supports: SMA, EMA, WMA, DEMA, TEMA, TRIMA, KAMA, MAMA, T3MA

Default: SMA

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

fast_k_period

integer

The time period for the fast %K line in the Stochastic Oscillator

slow_k_period

integer

The time period for the slow %K line in the Stochastic Oscillator

slow_d_period

integer

The time period for the slow %D line in the Stochastic Oscillator

slow_kma_type

string

The type of slow %K Moving Average used

slow_dma_type

string

The type of slow Displaced Moving Average used

name

string

Name of the technical indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

slow_k

string

slow_k value

slow_d

string

slow_d value

status

string

Response status

Request example

https://api.twelvedata.com/stoch?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "fast_k_period": 14,
            "slow_k_period": 1,
            "slow_d_period": 3,
            "slow_kma_type": "SMA",
            "slow_dma_type": "SMA",
            "name": "STOCH - Stochastic Oscillator"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "slow_k": "11.35168",
            "slow_d": "7.5293"
        }
    ],
    "status": "ok"
}

STOCHF

/stochf

The Stochastic Fast (STOCHF) is a variation of the Stochastic Oscillator, using fewer periods for calculation, making it more responsive to price changes but also more prone to false signals.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

fast_k_period

integer

The time period for the fast %K line in the Stochastic Oscillator. Takes values in the range from 1 to 800

Default: 14

fast_d_period

integer

The time period for the fast %D line in the Stochastic Oscillator. Takes values in the range from 1 to 800

Default: 3

fast_dma_type

string

The type of fast Displaced Moving Average used.

Supports: SMA, EMA, WMA, DEMA, TEMA, TRIMA, KAMA, MAMA, T3MA

Default: SMA

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

fast_k_period

integer

The fast_k period used for calculation in the indicator

fast_d_period

integer

The fast_d period used for calculation in the indicator

fast_dma_type

string

The type of fast Displaced Moving Average used

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

fast_k

string

fast_k value

fast_d

string

fast_d value

status

string

Response status

Request example

https://api.twelvedata.com/stochf?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "STOCHF - Stochastic Fast",
            "fast_k_period": 14,
            "fast_d_period": 3,
            "fast_dma_type": "SMA"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "fast_k": "11.35168",
            "fast_d": "7.5293"
        }
    ],
    "status": "ok"
}

STOCHRSI

/stochrsi

The Stochastic RSI (STOCHRSI) is an oscillator that applies the Stochastic formula to RSI values, providing a more sensitive indicator for identifying overbought or oversold conditions and potential trend reversals.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

stoch_length

integer

Period length for computing the stochastic oscillator of the RSI. Takes values in the range from 1 to 800

Default: 14

k_period

integer

Period for smoothing the %K line. Takes values in the range from 1 to 800

Default: 3

d_period

integer

Period for smoothing the %D line, which is a moving average of %K. Takes values in the range from 1 to 800

Default: 3

series_type

string

Specifies the price data type: open, high, low, or close.

Supports: open, high, low, close

Default: close

rsi_length

integer

Length of period for calculating the RSI component. Takes values in the range from 1 to 800

Default: 14

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

slow_kma_type

string

slow_dma_type

string

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

rsi_length

integer

Length of period for calculating the RSI component

stoch_length

integer

Period length for computing the stochastic oscillator of the RSI

k_period

integer

Period for smoothing the %K line

d_period

integer

Period for smoothing the %D line, which is a moving average of %K

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

string

K value

string

D value

status

string

Response status

Request example

https://api.twelvedata.com/stochrsi?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "STOCHRSI - Stochastic RSI",
            "series_type": "close",
            "rsi_length": 14,
            "stoch_length": 14,
            "k_period": 3,
            "d_period": 3
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "k": "100.0",
            "d": "33.33333"
        }
    ],
    "status": "ok"
}

ULTOSC

/ultosc

The Ultimate Oscillator (ULTOSC) is a momentum oscillator that combines short, intermediate, and long-term price action to identify potential overbought or oversold conditions and trend reversals.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period_1

integer

The first time period used for calculation in the indicator. Takes values in the range from 1 to 800

Default: 7

time_period_2

integer

The second time period used for calculation in the indicator. Takes values in the range from 1 to 800

Default: 14

time_period_3

integer

The third time period used for calculation in the indicator. Takes values in the range from 1 to 800

Default: 28

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period_1

integer

The first time period used for calculation in the indicator

time_period_2

integer

The second time period used for calculation in the indicator

time_period_3

integer

The third time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

ultosc

string

Ultimate Oscillator value

status

string

Response status

Request example

https://api.twelvedata.com/ultosc?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "ULTOSC - Ultimate Oscillator",
            "time_period_1": 7,
            "time_period_2": 14,
            "time_period_3": 28
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "ultosc": "25.17927"
        }
    ],
    "status": "ok"
}

WILLR

/willr

The Williams %R (WILLR) is a momentum oscillator that measures the level of a security's closing price in relation to the high and low range over a specified period, helping traders identify potential overbought or oversold conditions and trend reversals.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 14

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

The time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

willr

string

Williams %R value

status

string

Response status

Request example

https://api.twelvedata.com/willr?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "WILLR - Williams %R",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "willr": "-84.8916"
        }
    ],
    "status": "ok"
}

Volume Indicators

Use trading volume to confirm price moves or warn of exhaustion—volume and price in tandem suggest trend strength, while divergences can signal reversals (e.g. OBV, Chaikin AD, Accumulation/Distribution Oscillator).

/ad

The Accumulation/Distribution (AD) technical indicator is a volume-based tool used in chart analysis to identify potential buying or selling pressure in a security. It measures the cumulative flow of money into and out of a financial instrument by comparing its closing price to its price range, while considering trading volume. The AD line's trend can help traders gauge the strength of a price move and spot potential reversals.

API credits cost

1 per symbol

Take note that this endpoint is applicable to all instruments except currencies.

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

values

array of object

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

string

AD value

status

string

Response status

Request example

https://api.twelvedata.com/ad?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "AD - Chaikin A/D Line"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "ad": "2262629.83773"
        }
    ],
    "status": "ok"
}

ADOSC

/adosc

The Accumulation/Distribution Oscillator (ADOSC) is a momentum indicator derived from the AD line, used to identify buying or selling pressure and potential trend reversals by comparing short-term and long-term price and volume trends.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

fast_period

integer

Number of periods for fast moving average. Takes values in the range from 1 to 800

Default: 12

slow_period

integer

Number of periods for slow moving average. Takes values in the range from 1 to 800

Default: 26

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

fast_period

integer

Number of periods for fast moving average

slow_period

integer

Number of periods for slow moving average

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

adosc

string

Adosc value

status

string

Response status

Request example

https://api.twelvedata.com/adosc?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "ADOSC - Chaikin A/D Oscillator",
            "fast_period": 12,
            "slow_period": 26
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "adosc": "-233315.15185"
        }
    ],
    "status": "ok"
}

OBV

/obv

The On Balance Volume (OBV) indicator is a cumulative volume-based tool used to measure buying and selling pressure, helping traders identify potential price trends and reversals.

API credits cost

1 per symbol

Take note that this endpoint is applicable to all instruments except currencies.

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

obv

string

obv value

status

string

Response status

Request example

https://api.twelvedata.com/obv?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "OBV - On Balance Volume",
            "series_type": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "obv": "540374.0"
        }
    ],
    "status": "ok"
}

RVOL

/rvol

The Relative Volume (RVOL) is a ratio that compares a security's current trading volume to its average trading volume over a specified period. By measuring volume activity relative to its historical norm, RVOL helps traders identify unusual market activity, potential breakouts, and the strength of price movements.

API credits cost

1 per symbol

This API endpoint is available starting with the Grow plan.

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 14

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

The time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

rvol

string

RVOL value

status

string

Response status

Request example

https://api.twelvedata.com/rvol?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "RVOL - Relative Volume Indicator",
            "time_period": 14
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "rvol": "2.9054"
        }
    ],
    "status": "ok"
}

Volatility Indicators

Quantify the range or dispersion of price over time to gauge risk, size stops, or identify breakouts (e.g. ATR, NATR, True Range) and adaptive overlays like SuperTrend.

ATR

/atr

The Average True Range (ATR) is a volatility indicator that measures the average range of price movement over a specified period, helping traders assess market volatility.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 14

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

atr

string

ATR value

status

string

Response status

Request example

https://api.twelvedata.com/atr?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "ATR - Average True Range",
            "time_period": 14
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "atr": "0.19828"
        }
    ],
    "status": "ok"
}

NATR

/natr

The Normalized Average True Range (NATR) is a volatility indicator that measures the average range of price movement over a specified period, expressed as a percentage of the security's price, allowing for comparisons across different securities.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 14

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

The time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

natr

string

natr value

status

string

Response status

Request example

https://api.twelvedata.com/natr?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "NATR - Normalized Average True Range",
            "time_period": 14
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "natr": "0.09862"
        }
    ],
    "status": "ok"
}

SUPERTREND

/supertrend

The Supertrend indicator is a trend-following tool that uses a combination of price, time, and volatility to generate potential entry and exit points in trending markets.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

period

integer

The period used for calculation in the indicator. Takes values in the range from 1 to 800

Default: 10

multiplier

integer

The factor used to adjust the indicator's sensitivity.

Default: 3

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

period

integer

The period used for calculation in the indicator

multiplier

integer

The factor used to adjust the indicator's sensitivity

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

supertrend

string

SuperTrend value

status

string

Response status

Request example

https://api.twelvedata.com/supertrend?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "SUPERTREND - SuperTrend Indicator",
            "period": 10,
            "multiplier": 3
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "supertrend": "201.56432"
        }
    ],
    "status": "ok"
}

SUPERTREND HEIKINASHICANDLES

/supertrend_heikinashicandles

The Supertrend and Heikin Ashi Candles indicator delivers a combined analysis of trend-following signals and smoothed price action visualization, widely used for identifying trends and potential entry or exit points in trading.

API credits cost

1 per symbol

This API endpoint is available starting with the Grow plan.

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

period

integer

The period used for calculation in the indicator. Takes values in the range from 1 to 800

Default: 10

multiplier

integer

The factor used to adjust the indicator's sensitivity.

Default: 3

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

multiplier

integer

The multiplier used for calculation in the indicator

period

integer

The period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

supertrend

string

SuperTrend value

heikinopens

string

Heikin-Ashi open values

heikinhighs

string

Heikin-Ashi high values

heikinlows

string

Heikin-Ashi low values

heikincloses

string

Heikin-Ashi close values

status

string

Response status

Request example

https://api.twelvedata.com/supertrend_heikinashicandles?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "SUPERTREND_HEIKINASHICANDLES - SuperTrendHeikinAshiCandles Indicator",
            "multiplier": 3,
            "period": 10
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "supertrend": "201.66713",
            "heikinopens": "200.9825",
            "heikinhighs": "201.25599",
            "heikinlows": "200.85199",
            "heikincloses": "201.02449"
        }
    ],
    "status": "ok"
}

TRANGE

/trange

The True Range (TRANGE) indicator measures the range of price movement over a specified period, providing a volatility measure that helps traders identify potential trading opportunities and risk management.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

values

array of object

Array of time series data points

Attributes

datetime

string

datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

trange

string

trange value

status

string

Response status

Request example

https://api.twelvedata.com/trange?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "TRANGE - True Range"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "trange": "0.404"
        }
    ],
    "status": "ok"
}

Price Transform

Convert raw OHLC data into derived series or aggregated values to feed other indicators or reveal different perspectives on price (e.g. typical price, HLC3, weighted close, arithmetic transforms like SUM, AVG, LOG, SQRT).

ADD

/add

The Addition (ADD) indicator performs a simple arithmetic addition of two input data series, typically used to combine multiple technical indicators or price data.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type_1

string

Price type used as the first part of technical indicator

Supports: close, open, high, low, volume

Default: open

series_type_2

string

Price type used as the second part of technical indicator

Supports: close, open, high, low, volume

Default: close

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type_1

string

Price type used as the first part of technical indicator

series_type_2

string

Price type used as the second part of technical indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

add

string

Add value

status

string

Response status

Request example

https://api.twelvedata.com/add?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "ADD - Arithmetic Addition",
            "series_type_1": "open",
            "series_type_2": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "add": "402.10798"
        }
    ],
    "status": "ok"
}

AVG

/avg

The Average (AVG) indicator calculates the arithmetic mean of a data series over a specified period, often used to smooth out data fluctuations.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

avg

string

Avg value

status

string

Response status

Request example

https://api.twelvedata.com/avg?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "AVG - Average",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "avg": "201.53871"
        }
    ],
    "status": "ok"
}

AVGPRICE

/avgprice

The Average Price (AVGPRICE) indicator computes the average of a security's open, high, low, and close prices, providing a simplified view of price action.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

avgprice

string

Avgprice value

status

string

Response status

Request example

https://api.twelvedata.com/avgprice?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "AVGPRICE - Average Price"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "avgprice": "201.02449"
        }
    ],
    "status": "ok"
}

CEIL

/ceil

The Ceiling (CEIL) indicator rounds input data up to the nearest integer, often used in conjunction with other indicators for data analysis or calculation purposes.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

ceil

string

Ceil value

status

string

Response status

Request example

https://api.twelvedata.com/ceil?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "CEIL - Vector CEIL",
            "series_type": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "ceil": "202.0"
        }
    ],
    "status": "ok"
}

DIV

/div

The Division (DIV) indicator performs arithmetic division between two input data series, typically used to combine or normalize multiple technical indicators or price data.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type_1

string

Price type used as the first part of technical indicator

Supports: close, open, high, low, volume

Default: open

series_type_2

string

Price type used as the second part of technical indicator

Supports: close, open, high, low, volume

Default: close

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type_1

string

Price type used as the first part of technical indicator

series_type_2

string

Price type used as the second part of technical indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

div

string

Div value

status

string

Response status

Request example

https://api.twelvedata.com/div?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "DIV - Arithmetic Division",
            "series_type_1": "open",
            "series_type_2": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "div": "1.00201"
        }
    ],
    "status": "ok"
}

EXP

/exp

The Exponential (EXP) indicator calculates the exponential value of a given input, often used in advanced mathematical analysis or calculations in financial markets.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

exp

string

Exp value

status

string

Response status

Request example

https://api.twelvedata.com/exp?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "EXP - Exponential",
            "series_type": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "exp": "2.0649375034375067e+87"
        }
    ],
    "status": "ok"
}

FLOOR

/floor

The Floor (FLOOR) indicator rounds input data down to the nearest integer, often used in conjunction with other indicators for data analysis or calculation purposes.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

floor

string

Floor value

status

string

Response status

Request example

https://api.twelvedata.com/floor?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "FLOOR - Vector FLOOR",
            "series_type": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "floor": "201.0"
        }
    ],
    "status": "ok"
}

HEIKINASHICANDLES

/heikinashicandles

Heikin Ashi Candles are a modified form of Japanese candlestick charts, using averaged price data to smooth out noise and better highlight trends and potential trend reversals.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

heikinhighs

string

Heikin-Ashi highs value

heikinopens

string

Heikin-Ashi opens value

heikincloses

string

Heikin-Ashi closes value

heikinlows

string

Heikin-Ashi lows value

status

string

Response status

Request example

https://api.twelvedata.com/heikinashicandles?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "HEIKINASHICANDLES - Heikin-Ashi Candles"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "heikinhighs": "201.25599",
            "heikinopens": "200.9825",
            "heikincloses": "201.02449",
            "heikinlows": "200.85199"
        }
    ],
    "status": "ok"
}

HLC3

/hlc3

The High, Low, Close Average (HLC3) indicator calculates the average of a security's high, low, and close prices, providing a simplified view of price action.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

hlc3

string

hlc3 value

status

string

Response status

Request example

https://api.twelvedata.com/hlc3?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "HLC3 - High, Low, Close Average Values"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "hlc3": "201.05266"
        }
    ],
    "status": "ok"
}

LN

/ln

The Natural Logarithm (LN) indicator calculates the natural logarithm of a given input value, often used in advanced mathematical analysis or calculations in financial markets.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

string

Natural logarithm value

status

string

Response status

Request example

https://api.twelvedata.com/ln?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "LN - Natural Logarithm to the base of constant e",
            "series_type": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "ln": "5.30355"
        }
    ],
    "status": "ok"
}

LOG10

/log10

The Base-10 Logarithm (LOG10) indicator calculates the base-10 logarithm of a given input value, commonly used in advanced mathematical analysis or calculations in financial markets.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

log10

string

Log10 value

status

string

Response status

Request example

https://api.twelvedata.com/log10?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "LOG10 - Logarithm to base 10",
            "series_type": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "log10": "2.3033"
        }
    ],
    "status": "ok"
}

MEDPRICE

/medprice

The Median Price (MEDPRICE) indicator calculates the midpoint between a security's high and low prices, providing a simplified view of price action.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

medprice

string

Medprice value

status

string

Response status

Request example

https://api.twelvedata.com/medprice?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MEDPRICE - Median Price"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "medprice": "201.05399"
        }
    ],
    "status": "ok"
}

MULT

/mult

The Multiplication (MULT) indicator performs arithmetic multiplication of two input data series, typically used to combine or normalize multiple technical indicators or price data.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type_1

string

Price type used as the first part of technical indicator

Supports: close, open, high, low, volume

Default: open

series_type_2

string

Price type used as the second part of technical indicator

Supports: close, open, high, low, volume

Default: close

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type_1

string

Specifies the first price data type

series_type_2

string

Specifies the second price data type

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

mult

string

Mult value

status

string

Response status

Request example

https://api.twelvedata.com/mult?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MULT - Arithmetic Multiply",
            "series_type_1": "open",
            "series_type_2": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "mult": "40422.66609"
        }
    ],
    "status": "ok"
}

SQRT

/sqrt

The Square Root (SQRT) indicator calculates the square root of a given input value, often used in advanced mathematical analysis or calculations in financial markets.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

sqrt

string

SQRT value

status

string

Response status

Request example

https://api.twelvedata.com/sqrt?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "SQRT - Square Root",
            "series_type": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "sqrt": "14.17921"
        }
    ],
    "status": "ok"
}

SUB

/sub

The Subtraction (SUB) indicator performs arithmetic subtraction of two input data series, typically used to combine or normalize multiple technical indicators or price data.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type_1

string

Price type used as the first part of technical indicator

Supports: close, open, high, low, volume

Default: open

series_type_2

string

Price type used as the second part of technical indicator

Supports: close, open, high, low, volume

Default: close

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type_1

string

First price data type on which technical indicator is calculated

series_type_2

string

Second price data type on which technical indicator is calculated

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

sub

string

SUB value

status

string

Response status

Request example

https://api.twelvedata.com/sub?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "SUB - Arithmetic Subtraction",
            "series_type_1": "open",
            "series_type_2": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "sub": "0.404"
        }
    ],
    "status": "ok"
}

SUM

/sum

The Summation (SUM) indicator calculates the sum of a data series over a specified period, often used in conjunction with other indicators for data analysis or calculation purposes.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

The time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

sum

string

Sum value

status

string

Response status

Request example

https://api.twelvedata.com/sum?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "SUM - Vector Summation",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "sum": "1812.70842"
        }
    ],
    "status": "ok"
}

TYPPRICE

/typprice

The Typical Price (TYPPRICE) indicator calculates the average of a security's high, low, and close prices, providing a simplified view of price action.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

typprice

string

typprice value

status

string

Response status

Request example

https://api.twelvedata.com/typprice?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "TYPPRICE - Typical Price"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "typprice": "201.05266"
        }
    ],
    "status": "ok"
}

WCLPRICE

/wclprice

The Weighted Close Price (WCLPRICE) indicator calculates the average of a security's high, low, and close prices, with extra weight given to the close price, providing a balanced view of price action.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

values

array of object

Array of time series data points

Attributes

datetime

string

datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

wclprice

double

wclprice value

status

string

Response status

Request example

https://api.twelvedata.com/wclprice?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "WCLPRICE - Weighted Close Price"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "wclprice": 201.052
        }
    ],
    "status": "ok"
}

Cycle Indicators

Detect and follow recurring periodic patterns in price action using Hilbert Transform–based measures of cycle period and phase (e.g. HT_SINE, HT_DCPERIOD, HT_DCPHASE, HT_PHASOR, HT_TRENDMODE).

HT_DCPERIOD

/ht_dcperiod

The Hilbert Transform Dominant Cycle Period (HT_DCPERIOD) identifies the dominant market cycle length, helping traders adapt their strategies to different market conditions.

You can read more about it in the Rocket Science for Traders book by John F. Ehlers.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

ht_dcperiod

string

ht_dcperiod value

status

string

Response status

Request example

https://api.twelvedata.com/ht_dcperiod?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "HT_DCPERIOD - Hilbert Transform Dominant Cycle Period",
            "series_type": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "ht_dcperiod": "28.12565"
        }
    ],
    "status": "ok"
}

HT_DCPHASE

/ht_dcphase

The Hilbert Transform Dominant Cycle Phase (HT_DCPHASE) measures the current phase of the dominant market cycle, helping traders identify potential entry and exit points in relation to the cycle.

You can read more about it in the Rocket Science for Traders book by John F. Ehlers.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

ht_dcphase

string

HT_DCPHASE value

status

string

Response status

Request example

https://api.twelvedata.com/ht_dcphase?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "HT_DCPHASE - Hilbert Transform Dominant Cycle Phase",
            "series_type": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "ht_dcphase": "-38.50975"
        }
    ],
    "status": "ok"
}

HT_PHASOR

/ht_phasor

The Hilbert Transform Phasor Components (HT_PHASOR) decomposes a price series into in-phase and quadrature components, providing insight into cyclical patterns and trend direction.

You can read more about it in the Rocket Science for Traders book by John F. Ehlers.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

in_phase

string

In_phase value

quadrature

string

Quadrature value

status

string

Response status

Request example

https://api.twelvedata.com/ht_phasor?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "HT_PHASOR - Hilbert Transform Phasor Components",
            "series_type": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "in_phase": "-0.56826",
            "quadrature": "-0.43318"
        }
    ],
    "status": "ok"
}

HT_SINE

/ht_sine

The Hilbert Transform Sine Wave (HT_SINE) indicator calculates sine and cosine wave components based on the dominant market cycle, helping traders identify potential turning points and trend direction.

You can read more about it in the Rocket Science for Traders book by John F. Ehlers.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

ht_sine

string

ht_sine value

ht_leadsine

string

ht_leadsine value

status

string

Response status

Request example

https://api.twelvedata.com/ht_sine?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "HT_SINE - Hilbert Transform SineWave",
            "series_type": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "ht_sine": "-0.62265",
            "ht_leadsine": "0.11303"
        }
    ],
    "status": "ok"
}

HT_TRENDMODE

/ht_trendmode

The Hilbert Transform Trend vs Cycle Mode (HT_TRENDMODE) distinguishes between trending and cyclical market phases, helping traders adapt their strategies accordingly.

You can read more about it in the Rocket Science for Traders book by John F. Ehlers.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

ht_trendmode

string

ht_trendmode value

status

string

Response status

Request example

https://api.twelvedata.com/ht_trendmode?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "HT_TRENDMODE - Hilbert Transform Trend vs Cycle Mode",
            "series_type": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "ht_trendmode": "0"
        }
    ],
    "status": "ok"
}

Statistic Functions

Compute fundamental statistical metrics on price series—dispersion, regression, correlation, and forecasting components—for standalone analysis or as inputs to other models (e.g. STDDEV, VAR, LINEARREG, CORREL, TSF, BETA).

BETA

/beta

The Beta indicator measures a security's sensitivity to market movements, comparing its price changes to a benchmark index to assess systematic risk.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type_1

string

Price type used as the first part of technical indicator

Supports: close, open, high, low, volume

Default: open

series_type_2

string

Price type used as the second part of technical indicator

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type_1

string

Price type used as the first part of technical indicator

series_type_2

string

Price type used as the second part of technical indicator

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

beta

string

Beta value

status

string

Response status

Request example

https://api.twelvedata.com/beta?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "BETA - Beta",
            "series_type_1": "open",
            "series_type_2": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "beta": "-0.05742"
        }
    ],
    "status": "ok"
}

CORREL

/correl

The Correlation (CORREL) indicator measures the statistical relationship between two securities, helping traders identify potential diversification opportunities or pairs trading candidates.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type_1

string

Price type used as the first part of technical indicator

Supports: close, open, high, low, volume

Default: open

series_type_2

string

Price type used as the second part of technical indicator

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type_1

string

Price type used as the first part of technical indicator

series_type_2

string

Price type used as the second part of technical indicator

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

correl

string

Correl value

status

string

Response status

Request example

https://api.twelvedata.com/correl?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "CORREL - Pearson's Correlation Coefficient",
            "series_type_1": "open",
            "series_type_2": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "correl": "0.93282"
        }
    ],
    "status": "ok"
}

LINEARREG

/linearreg

The Linear Regression (LINEARREG) indicator calculates the best-fit straight line through a series of data points, helping traders identify trends and potential support or resistance levels.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

linearreg

string

linearreg value

status

string

Response status

Request example

https://api.twelvedata.com/linearreg?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "LINEARREG - Linear Regression",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "linearreg": "200.79327"
        }
    ],
    "status": "ok"
}

LINEARREGANGLE

/linearregangle

The Linear Regression Angle (LINEARREGANGLE) measures the angle of the linear regression line, indicating the slope and direction of the underlying trend.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

linearregangle

string

Linear regression angle value

status

string

Response status

Request example

https://api.twelvedata.com/linearregangle?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "LINEARREGANGLE - Linear Regression Angle",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "linearregangle": "-8.79357"
        }
    ],
    "status": "ok"
}

LINEARREGINTERCEPT

/linearregintercept

The Linear Regression Intercept (LINEARREGINTERCEPT) calculates the point where the linear regression line intersects the vertical axis, providing a reference point for trend analysis.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

Number of periods to average over

series_type

string

Price type on which technical indicator is calculated

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

linearregintercept

string

Linear Regression Intercept value

status

string

Response status

Request example

https://api.twelvedata.com/linearregintercept?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "LINEARREGINTERCEPT - Linear Regression Intercept",
            "time_period": 9,
            "series_type": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "linearregintercept": "202.03082"
        }
    ],
    "status": "ok"
}

LINEARREGSLOPE

/linearregslope

The Linear Regression Slope (LINEARREGSLOPE) measures the steepness of the linear regression line, indicating the rate of change of the underlying trend.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

linearregslope

string

linearregslope value

status

string

Response status

Request example

https://api.twelvedata.com/linearregslope?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "LINEARREGSLOPE - Linear Regression Slope",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "linearregslope": "-0.15469"
        }
    ],
    "status": "ok"
}

MAX

/max

The Maximum (MAX) indicator calculates the highest value of a data series over a specified period, often used to identify potential resistance levels or extreme price movements.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

max

string

Max value

status

string

Response status

Request example

https://api.twelvedata.com/max?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MAX - Highest value over period",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "max": "202.05"
        }
    ],
    "status": "ok"
}

MAXINDEX

/maxindex

The Maximum Index (MAXINDEX) returns the index of the highest value in a data series over a specified period, providing information about the timing of extreme price movements.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

maxidx

string

maxidx value

status

string

Response status

Request example

https://api.twelvedata.com/maxindex?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MAXINDEX - Index of highest value over period",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "maxidx": "491"
        }
    ],
    "status": "ok"
}

MIN

/min

The Minimum (MIN) indicator calculates the lowest value of a data series over a specified period, often used to identify potential support levels or extreme price movements.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

min

string

Min value

status

string

Response status

Request example

https://api.twelvedata.com/min?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MIN - Lowest value over period",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "min": "200.935"
        }
    ],
    "status": "ok"
}

MININDEX

/minindex

The Minimum Index (MININDEX) returns the index of the lowest value in a data series over a specified period, providing information about the timing of extreme price movements.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

minidx

string

Index of lowest value over period

status

string

Response status

Request example

https://api.twelvedata.com/minindex?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MININDEX - Index of lowest value over period",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "minidx": "498"
        }
    ],
    "status": "ok"
}

MINMAX

/minmax

The Minimum and Maximum (MINMAX) indicator calculates the lowest and highest values of a data series over a specified period, often used to identify potential support and resistance levels or extreme price movements.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

min

string

Min value

max

string

Max value

status

string

Response status

Request example

https://api.twelvedata.com/minmax?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MINMAX - Lowest and highest values over period",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "min": "200.935",
            "max": "202.05"
        }
    ],
    "status": "ok"
}

MINMAXINDEX

/minmaxindex

The Minimum and Maximum Index (MINMAXINDEX) returns the indices of the lowest and highest values in a data series over a specified period, providing information about the timing of extreme price movements.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

minidx

string

Index of the lowest value over the specified period

maxidx

string

Index of the highest value over the specified period

status

string

Response status

Request example

https://api.twelvedata.com/minmaxindex?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MINMAXINDEX - Indexes of lowest and highest values over period",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "minidx": "498",
            "maxidx": "491"
        }
    ],
    "status": "ok"
}

STDDEV

/stddev

The Standard Deviation (STDDEV) indicator measures the dispersion of a data series from its mean, often used as a volatility indicator to identify potential trading opportunities and risk management.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

number

The standard deviation applied in the calculation.

Default: 2

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

The time period used for calculation in the indicator

double

The standard deviation applied in the calculation

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

stddev

string

Standard Deviation value

status

string

Response status

Request example

https://api.twelvedata.com/stddev?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "STDDEV - Standard Deviation",
            "series_type": "close",
            "time_period": 9,
            "sd": 2
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "stddev": "0.86613"
        }
    ],
    "status": "ok"
}

TSF

/tsf

The Time Series Forecast (TSF) indicator projects future price levels based on linear regression analysis, helping traders identify potential support, resistance, and trend direction.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

The time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

tsf

string

TSF value

status

string

Response status

Request example

https://api.twelvedata.com/tsf?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "TSF - Time Series Forecast",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "tsf": "200.63858"
        }
    ],
    "status": "ok"
}

VAR

/var

The Variance (VAR) indicator measures the dispersion of a data series from its mean, often used as a volatility indicator to identify potential trading opportunities and risk management.

API credits cost

1 per symbol

Parameters Response

✱ symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested

Example: BBG01293F5X4

isin

string

Filter by international securities identification number (ISIN)

Example: US0378331005

cusip

string

The CUSIP of an instrument for which data is requested

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 5h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 9

type

string

The asset class to which the instrument belongs

Supports: 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

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided.

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

1. Exchange for local exchange time
2. UTC for datetime at universal UTC standard
3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2021-10-27

start_date

string

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15: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.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22 16:04:05

previous_close

boolean

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object.

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

The time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

var

string

VAR value

status

string

Response status

Request example

https://api.twelvedata.com/var?symbol=AAPL&interval=1min&apikey=demo&source=docs

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "VAR - Variance",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "var": "0.18755"
        }
    ],
    "status": "ok"
}

WebSocket

WebSocket will automatically send the data to you once a new piece of data is available on the exchange. In the beginning, you need to establish a connection between the server and the client. Then all data is controlled by sending event messages to the server. WebSocket is opposed to the API, where the data has to be explicitly requested from the server.

Connect & Authorize

You may use the API key to connect to the Twelve Data Distributed WebSocket System (TDDWS). This system will manage all your requests to all available instruments across different exchanges. You can establish up to 3 connections (typically used in production, stage, and local environments) across the whole lifespan of the application; if you open more, the previous connections will be closed.

You may subscribe to all symbols available at Twelve Data; meanwhile, the format remains the same as the API unless there are constraints in the endpoint. Moreover, you may combine symbols across different types, and TDDWS will manage the routing. There are some limitations, though:

Server limits to receive up to 100 events from the client-side. This constraint does not affect the number of messages sent from the server to the client.
There is no limit on the number of input symbols; however, the size of the input message can not exceed 1 MB.

Please note that full access to WebSocket is available for the users on the Pro plan and above. However, testing can be done on the Basic and Grow tier plans with only one connection and up to 8 simultaneous symbols subscriptions among the permitted list.

Resources

You can try out streaming via WebSocket Playground located in the personal dashboard. On Basic and Grow plans, only trial symbols can be used; on Pro plan and above, any instrument can be streamed.

Trial symbols

WebSocket FAQ

How to stream data tutorial

Connect & Authorize

# Pass API key as connection parameter
wss://ws.twelvedata.com/v1/{$route}?apikey=your_api_key

# Or pass API key separately in header
wss://ws.twelvedata.com/v1/{$route}
X-TD-APIKEY: your_api_key

Real-time price Useful

wss://ws.twelvedata.com/v1/quotes/price?apikey=your_api_key

This method allows you to get real-time price streaming from the exchange. Equities also have day volume information.

WebSocket credits cost

1 per symbol

Precious metals include bid/ask prices.

Response

There are two general return event types: status and price.

Status events return the information about the events itself, which symbols were successfully subscribed/unsubscribed, etc.

Price events return the real-time tick prices for particular instruments. The body will include the meta information, UNIX timestamp, and the price itself. Price events return the real-time tick prices, with the following structure:

Field*	Description
event	type of event
symbol	symbol ticker of instrument
type	general instrument type
timestamp	timestamp in UNIX format
price	real-time price for the underlying instrument
day_volume	volume of the instrument for the current trading day

*Some additional meta response field will be received, depending on the class of the instrument.

Further steps

At this stage you might decide that you no longer want to be subscribed for particular symbols, therefore you have two options:

Manually unsubscribe from symbols. This is done with the same format as the subscription, but with action set to "action": "unsubscribe".
Reset subscription. This will reset your current connection from all subscriptions.
Send the {"action": "reset"} event.

We also recommend sending {"action": "heartbeat"} events to the server every 10 seconds or so. This will make sure to keep your connection stable.

Subscribe to multiple symbols

# You may subscribe to multiple symbols by
# calling subscribe action. Additionally,
# you can pass the exchange name after
# the colon(:).

{
  "action": "subscribe", 
  "params": {
    "symbols": "AAPL,RY,RY:TSX,EUR/USD,BTC/USD"
  }
}

Subscribe using extended format

# Alternatively, if you need to get data from the 
# ambiguos symbol you may use the extended format

{ "action": "subscribe", 
  "params": {
    "symbols": [{
        "symbol": "AAPL",
        "exchange": "NASDAQ"
      }, {
        "symbol": "RY", 
        "mic_code": "XNYS"
      }, {
        "symbol": "EUR/USD",
        "type": "Forex"
      }
]}}

Success subscription

{
  "event": "subscribe-status",
  "status": "ok",
  "success": [
    { 
      "symbol":"AAPL","exchange":"NASDAQ",
      "country":"United States",
      "type":"Common Stock"
    },
    { 
      "symbol":"RY","exchange":"NYSE",
      "country":"United States",
      "type":"Common Stock"
    },
    {
      "symbol":"RY","exchange":"TSX",
      "country":"Canada",
      "type":"Common Stock"
    },
    {
      "symbol":"EUR/USD","exchange":"FOREX",
      "country":"",
      "type":"Physical Currency"
    },
    {
      "symbol":"BTC/USD","exchange":"FOREX",
      "country":"",
      "type":"Physical Currency"
    }
  ],
  "fails": []
}

Price event data response

{
  "event": "price",
  "symbol": "AAPL",
  "currency": "USD",
  "exchange": "NASDAQ",
  "type": "Common Stock",
  "timestamp": 1592249566,
  "price": 342.0157,
  "day_volume": 27631112
}

Bid/Ask data response (precious metals only)

{
  "event": "price",
  "symbol": "XAU/USD",
  "currency": "USD",
  "currency_base": "Gold Spot",
  "currency_quote": "US Dollar",
  "type": "Physical Currency",
  "timestamp": 1647950462,
  "price": 1925.18,
  "bid": 1925.05,
  "ask": 1925.32
}