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.

code & output ${examples} can be found in this section

AuthenticationImportant

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

ParametersUseful

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.

Exchanges

Symbol might be also passed in the form symbol:exchange_name.
E.g. ?symbol=RY:TSX, ?symbol=AAPL:NASDAQ

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.

Batch RequestsUseful

This section covers a method that will be deprecated soon. Please use the /batch endpoint as the recommended alternative.

Batch requests might be used on top of most endpoints including technical indicators. It allows requesting multiple symbols simultaneously.

HTTP request example

https://api.twelvedata.com/time_series?symbol=AAPL,EUR/USD,ETH/BTC:Huobi,TRP:TSX&interval=1min&apikey=your_api_key

This request will return JSON with the following structure

{
   "AAPL": {
      "meta": {
         "symbol": "AAPL",
         "interval": "1min",
         "currency": "USD",
         "exchange_timezone": "America/New_York",
         "exchange": "NASDAQ",
         "type": "Common Stock"
      },
      "values": [
         {
            "datetime": "2020-02-26 15:59:00",
            "open": "292.89001",
            "high": "293.10001",
            "low": "292.50000",
            "close": "292.64999",
            "volume": "385977"
         },
         {...}
      ],
      "status": "ok"
   },
   "EUR/USD": {
      {...}
   },
   "ETH/BTC:Huobi": {
      {...}
   }, 
   "TRP:TSX": {
      {...}
   }
}

Request

Basic call

All symbols should be comma delimited and provided in symbol parameter. E.g:
/time_series?symbol=AAPL,QQQ,EUR/USD,CBQK

Exchange specific call

In order to call symbol from the specific exchange, use symbol_ticker:exchange format. E.g:
/bbands?symbol=ETH/BTC:Huobi,TRP:TSX,INFY:BSE

General

All instruments might be called in an arbitrary order and mixes, such as stocks, forex, crypto, and ETFs.
Request count will be incremented according to the number of passed symbols.
Batch requests only support JSON format.
Limited to 120 symbols per request.

Response

The response consists of the main object where the key is the symbol passed and value is the normal object consisting of meta, values, status.
The response header will also include is_batch set to true if the request is batch with multiple returns symbols.

Error handling

In the case that there was an error during processing one of the symbols, the error will only be returned for that specific symbol without affecting other instrument responses.

JSON request example

https://api.twelvedata.com/time_series?symbol=AAPL,EUR/USD,CBQK&interval=1min&apikey=demo

https://api.twelvedata.com/time_series?symbol=ETH/BTC:Huobi,TRP:TSX,INFY:BSE&interval=30min&outputsize=12&apikey=demo

Errors

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

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

Possible output error codes are:

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

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.

LibrariesUseful

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

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

HTTP request example

https://api.twelvedata.com/stocks

This request will return JSON with the following structure

[
  {
    "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"
  },
  {
    "symbol": "AAT",
    "name": "American Assets Trust Inc",
    "currency": "USD",
    "exchange": "NYSE",
    "mic_code": "XNYS",
    "country": "United States",
    "type": "Real Estate Investment Trust (REIT)",
    "figi_code": "BBG00161BCW4",
    "cfi_code": "ESVUFR",
    "isin": "US0240131047"
  },
  {...}
]

// with &show_plan=true
{
  "data": [
    {
      "symbol": "TCS",
      "name": "Tata Consultancy Services Limited",
      "currency": "INR",
      "exchange": "NSE",
      "mic_code": "XNSE",
      "country": "India",
      "type": "Common Stock",
      "figi_code": "BBG000Q0WGC6",
      "cfi_code": "ESVUFR",
      "isin": "INE467B01029",
      "access": {
        "global": "Level A",
        "plan": "Grow"
      }
    },
    {
      "symbol": "TCS",
      "name": "Axon Enterprise Inc",
      "currency": "EUR",
      "exchange": "FSX",
      "mic_code": "XFRA",
      "country": "Germany",
      "type": "Common Stock",
      "figi_code": "BBG000FB37K7",
      "cfi_code": "ESVUFR",
      "isin": "",
      "access": {
        "global": "Level A",
        "plan": "Grow"
      }
    },
    {...}
  ],
  "status": "ok"
}

HTTP route

/stocks

API credits

1 per request

API parameters

Parameter	Details
symbol	• Parameter is optional • Filter by symbol
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	• Parameter is optional • Filter by exchange name or mic code
mic_code	• Parameter is optional • Filter by market identifier code (MIC) under ISO 10383 standard
country	• Parameter is optional • Filter by country name or alpha code
type	• Parameter is optional • Filter by instrument type
format	• Parameter is optional • Value can be `JSON` or `CSV`; Default `JSON`
delimiter	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
show_plan	• Parameter is optional • Adds info on which plan symbol is available • Boolean; Default `false`
include_delisted	• Parameter is optional • Include delisted identifiers • Boolean; Default `false`

Response

Key	Description
symbol	instrument symbol (ticker)
name	full name of instrument
currency	currency of the instrument according to the ISO 4217 standard
exchange	exchange where instrument is traded
mic_code	market identifier code (MIC) under ISO 10383 standard
country	country where exchange is located
type	common issue type
figi_code	financial instrument global identifier (FIGI)
cfi_code	classification of Financial Instruments (CFI)
isin	international securities identification number (ISIN), available by individual request to support

JSON request example

https://api.twelvedata.com/stocks

https://api.twelvedata.com/stocks?symbol=AAPL

Downloadable CSV example

https://api.twelvedata.com/stocks?format=CSV

Forex Pairs List

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

HTTP request example

https://api.twelvedata.com/forex_pairs

This request will return JSON with the following structure

[
  {
    "symbol": "EUR/USD",
    "currency_group": "Major",
    "currency_base": "Euro",
    "currency_quote": "US Dollar"
  },
  {
    "symbol": "XAU/USD",
    "currency_group": "Exotic",
    "currency_base": "Gold Spot",
    "currency_quote": "US Dollar"
  },
  {...}
]

HTTP route

/forex_pairs

API credits

1 per request

API parameters

Parameter	Details
symbol	• Parameter is optional • Filter by symbol
currency_base	• Parameter is optional • Filter by currency base
currency_quote	• Parameter is optional • Filter by currency quote
format	• Parameter is optional • Value can be `CSV` or `JSON`; Default `JSON`
delimiter	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`

Response

Key	Description
symbol	currency pair according to ISO 4217 standard codes with slash(/) delimiter
currency_group	group to which currency pair belongs to, could be: Major, Minor, Exotic and Exotic-Cross
currency_base	base currency name according to ISO 4217 standard
currency_quote	quote currency name according to ISO 4217 standard

JSON request example

https://api.twelvedata.com/forex_pairs

https://api.twelvedata.com/forex_pairs?symbol=EUR/USD

Downloadable CSV example

https://api.twelvedata.com/forex_pairs?format=CSV

Cryptocurrencies List

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

HTTP request example

https://api.twelvedata.com/cryptocurrencies

This request will return JSON with the following structure

[
  {
    "symbol": "BTC/USD",
    "available_exchanges": ["ABCC", "Allcoin", "BTC-Alpha", "BTCTurk", "Bibox", "BigONE", "Binance", "Bit-Z", "BitForex", "BitMEX", "BitMart", "BitMax", "BitStamp", "Bitex.la", "Bitfinex", "Bitibu", "Bitinka", "Bitlish", "Bitrue", "Bittrex", "Btcwinex", "C2CX", "CBX", "CEX.IO", "COINEGG", "Cobinhood", "CoinAll", "CoinField", "CoinHub", "CoinTiger", "Coinbase Pro", "Coinbene", "CoinsBank", "Coinsbit", "CryptalDash", "DragonEX", "EXX", "Exmo", "Exrates", "GDAX", "Gate.io", "Gemini", "HitBTC", "Huobi", "IDAX", "IDCM", "Independent Reserve", "Kraken", "Kryptono", "Kucoin", "LBank", "LakeBTC", "Livecoin", "OKCoin", "OKEx", "OOOBTC", "Panxora", "Poloniex", "QUOINE", "SIMEX", "Tidex", "Upbit", "YoBit", "ZB.COM", "bitFlyer", "itBit", "n.exchange", "p2pb2b", "xBTCe"],
    "currency_base": "Bitcoin",
    "currency_quote": "US Dollar"
  },
  {
    "symbol": "ETH/BTC",
    "available_exchanges": ["ABCC", "Allcoin", "BTC Indonesia", "BTC Markets", "BTC-Alpha", "BXThailand", "Bibox", "BigONE", "Bilaxy", "Binance", "Bit-Z", "BitBay", "BitForex", "BitMart", "BitStamp", "Bitbank", "Bitci.com", "BiteBTC", "Bitfinex", "Bitibu", "Bitlish", "Bittrex", "Btcwinex", "CBX", "CEX.IO", "COINEGG", "Cobinhood", "CoinAll", "CoinExchange", "CoinMex", "CoinTiger", "Coinbase Pro", "Coinbene", "Coinsbit", "EXX", "Exmo", "Exrates", "Fatbtc", "GDAX", "GOPAX", "Gate.io", "Gemini", "HitBTC", "Hotbit", "Huobi", "IDAX", "IDCM", "Kraken", "Kryptono", "Kucoin", "LBank", "LakeBTC", "Livecoin", "OKEx", "Panxora", "Poloniex", "QUOINE", "SIMEX", "STEX", "TOKOK", "Tidex", "Upbit", "Vebitcoin", "YoBit", "ZB.COM", "Zaif", "bitFlyer", "p2pb2b", "xBTCe"],
    "currency_base": "Ethereum",
    "currency_quote": "Bitcoin"
  },
  {...}
]

HTTP route

/cryptocurrencies

API credits

1 per request

API parameters

Parameter	Details
symbol	• Parameter is optional • Filter by symbol
exchange	• Parameter is optional • Filter by exchange name
currency_base	• Parameter is optional • Filter by currency base
currency_quote	• Parameter is optional • Filter by currency quote
format	• Parameter is optional • Value can be `CSV` or `JSON`; Default `JSON`
delimiter	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`

Response

Key	Description
symbol	cryptocurrency pair codes with slash(/) delimiter
available_exchanges	array of exchanges where cryptocurrency is traded
currency_base	base cryptocurrency name
currency_quote	quote cryptocurrency name

JSON request example

https://api.twelvedata.com/cryptocurrencies

https://api.twelvedata.com/cryptocurrencies?symbol=BTC/USD

Downloadable CSV example

https://api.twelvedata.com/cryptocurrencies?format=CSV

Funds List

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

HTTP request example

https://api.twelvedata.com/funds

This request will return JSON with the following structure

{
  "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"
        },
        {
            "symbol": "003E",
            "name": "WisdomTree Trust - WisdomTree Japan Hedged Financials Fund",
            "country": "Germany",
            "currency": "EUR",
            "exchange": "XDUS",
            "mic_code": "XDUS",
            "type": "ETF",
            "figi_code": "",
            "cfi_code": "",
            "isin": ""
        },
        {...}
    ]
  },
  "status": "ok"
}

// with &show_plan=true
{
  "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"
        }
      },
      {
        "symbol": "003E",
        "name": "WisdomTree Trust - WisdomTree Japan Hedged Financials Fund",
        "country": "Germany",
        "currency": "EUR",
        "exchange": "XDUS",
        "mic_code": "XDUS",
        "type": "ETF",
        "figi_code": "",
        "cfi_code": "",
        "isin": ""
        "access": {
          "global": "Level A",
          "plan": "Grow"
        }
      },
      {...}
    ]
  },
  "status": "ok"
}

HTTP route

/funds

API credits

1 per request

API parameters

Parameter	Details
symbol	• Parameter is optional • Filter by symbol
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	• Parameter is optional • Filter by exchange name or mic code
country	• Parameter is optional • Filter by country name or alpha code
format	• Parameter is optional • Value can be `CSV` or `JSON`; Default `JSON`
delimiter	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
show_plan	• Parameter is optional • Adds info on which plan symbol is available • Boolean; Default `false`
page	• Parameter is optional • Page number; default `1`
outputsize	• Parameter is optional • Number of records in response; default `5000`

Response

Key	Description
count	total number of matching instruments
symbol	instrument symbol (ticker)
name	full name of instrument
country	country where the instrument is located
currency	currency in which instrument is traded by ISO 4217 standard
exchange	exchange where instrument is traded
type	group to which instrument belongs to
figi_code	financial instrument global identifier (FIGI)
cfi_code	classification of Financial Instruments (CFI)
isin	international securities identification number (ISIN), available by individual request to support

JSON request example

https://api.twelvedata.com/funds

https://api.twelvedata.com/funds?symbol=0P00000AMH

Downloadable CSV example

https://api.twelvedata.com/funds?format=CSV

Bonds List

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

HTTP request example

https://api.twelvedata.com/bonds

This request will return JSON with the following structure

{
  "result": {
    "count": 6,
    "list": [
      {
        "symbol": "US2Y",
        "name": "US Treasury Yield 2 Years",
        "country": "United States",
        "currency": "USD",
        "exchange": "NYSE",
        "mic_code": "XNYS",
        "type": "Bond"
      },
      {
        "symbol": "ZA10Y",
        "name": "South Africa 10 Year Government Bond",
        "country": "South Africa",
        "currency": "ZAR",
        "exchange": "JSE",
        "mic_code": "XJSE",
        "type": "Bond"
      },
      {...}
    ]
  },
  "status": "ok"
}


// with &show_plan=true
{
  "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": "Basic",
            "plan": "Basic"
        }
      },
      {
        "symbol": "ZA10Y",
        "name": "South Africa 10 Year Government Bond",
        "country": "South Africa",
        "currency": "ZAR",
        "exchange": "JSE",
        "mic_code": "XJSE",
        "type": "Bond",
        "access": {
            "global": "Level B",
            "plan": "Pro"
        }
      },
      {...}
    ]
  },
  "status": "ok"
}

HTTP route

/bonds

API credits

1 per request

API parameters

Parameter	Details
symbol	• Parameter is optional • Filter by symbol
exchange	• Parameter is optional • Filter by exchange name or mic code
country	• Parameter is optional • Filter by country name or alpha code
format	• Parameter is optional • Value can be `CSV` or `JSON`; Default `JSON`
delimiter	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
show_plan	• Parameter is optional • Adds info on which plan symbol is available • Boolean; Default `false`
page	• Parameter is optional • Page number; default `1`
outputsize	• Parameter is optional • Number of records in response; default `5000`

Response

Key	Description
count	total number of matching instruments
symbol	instrument symbol (ticker)
name	full name of instrument
country	country where the instrument is located
currency	currency in which instrument is traded by ISO 4217 standard
exchange	exchange where instrument is traded
type	group to which instrument belongs to

JSON request example

https://api.twelvedata.com/bonds

https://api.twelvedata.com/bonds?symbol=AJXA

Downloadable CSV example

https://api.twelvedata.com/bonds?format=CSV

ETFs List

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

HTTP request example

https://api.twelvedata.com/etfs

This request will return JSON with the following structure

[
  {
    "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",
  },
  {
    "symbol": "VTI",
    "name": "Vanguard Total Stock Market Index Fund ETF Shares",
    "currency": "USD",
    "exchange": "NYSE",
    "mic_code": "XNYS",
    "country": "Unites States",
    "figi_code": "BBG000HRBDF4",
    "cfi_code": "CECJEU",
    "isin": "US9229087690"
  },
  {...}
]

// with &show_plan=true
{
  "data": [
    {
      "symbol": "SPY",
      "name": "SPDR S&P 500 ETF Trust",
      "currency": "MXN",
      "exchange": "BMV",
      "mic_code": "XMEX",
      "country": "Mexico",
      "figi_code": "",
      "cfi_code": "CEOJLU",
      "isin": "US78462F1030",
      "access": {
        "global": "Level B",
        "plan": "Pro"
      }
    },
    {
      "symbol": "SPY",
      "name": "SPDR S&P 500 ETF Trust",
      "currency": "USD",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "country": "United States",
      "figi_code": "BBG000BDTF76",
      "cfi_code": "CECJEU",
      "isin": "US78462F1030",
      "access": {
        "global": "Basic",
        "plan": "Basic"
      }
    },
    {...}
  ],
  "status": "ok"
}

HTTP route

/etfs

API credits

1 per request

API parameters

Parameter	Details
symbol	• Parameter is optional • Filter by symbol
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	• Parameter is optional • Filter by exchange name or mic code
mic_code	• Parameter is optional • Filter by market identifier code (MIC) under ISO 10383 standard
country	• Parameter is optional • Filter by country name or alpha code
format	• Parameter is optional • Value can be `CSV` or `JSON`; Default `JSON`
delimiter	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
show_plan	• Parameter is optional • Adds info on which plan symbol is available • Boolean; Default `false`
include_delisted	• Parameter is optional • Include delisted identifiers • Boolean; Default `false`

Response

Key	Description
symbol	instrument symbol (ticker)
name	full name of instrument
currency	currency in which instrument is traded by ISO 4217 standard
exchange	exchange where ETF is traded
mic_code	market identifier code (MIC) under ISO 10383 standard
figi_code	financial instrument global identifier (FIGI)
cfi_code	classification of Financial Instruments (CFI)
isin	international securities identification number (ISIN), available by individual request to support

JSON request example

https://api.twelvedata.com/etfs

https://api.twelvedata.com/etfs?symbol=QQQ

Downloadable CSV example

https://api.twelvedata.com/etfs?format=CSV

Commodities List

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

HTTP request example

https://api.twelvedata.com/commodities

This request will return JSON with the following structure

[
    {
        "symbol": "XAG/AUD",
        "name": "Silver Spot",
        "category": "Precious Metal",
        "description": ""
    },
    {
        "symbol": "XAG/CAD",
        "name": "Silver Spot",
        "category": "Precious Metal",
        "description": ""
    },
    {...}
]

HTTP route

/commodities

API credits

1 per request

API parameters

Parameter	Details
symbol	• Parameter is optional • Filter by symbol
category	• Parameter is optional • Filter by category of commodity
format	• Parameter is optional • Value can be `CSV` or `JSON`; Default `JSON`
delimiter	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`

Response

Key	Description
symbol	currency pair according to ISO 4217 standard codes with slash(/) delimiter
name	full name of the instrument
category	category of commodity
description	short description of the commodity

JSON request example

https://api.twelvedata.com/commodities

https://api.twelvedata.com/commodities?symbol=XAU/USD

Downloadable CSV example

https://api.twelvedata.com/commodities?format=CSV

Cross listings

This API call returns an array of cross listed symbols. This list is updated daily.

HTTP request example

https://api.twelvedata.com/cross_listings?symbol=NVDA&mic_code=XNGS&apikey=your_api_key

This request will return JSON with the following structure

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

HTTP route

/cross_listings

API credits

40 per request

API parameters

Parameter	Details
symbol	ticker symbol of instrument
exchange	• Parameter is optional • exchange where instrument is traded
mic_code	• Parameter is optional • market identifier code (MIC) under ISO 10383 standard
country	• Parameter is optional • country to which stock exchange belongs to

Response

Key	Description
symbol	ticker symbol of instrument
name	name of exchange
exchange	exchange where instrument is traded
mic_code	market identifier code (MIC) under ISO 10383 standard

JSON request example

https://api.twelvedata.com/cross_listings?symbol=NVDA&mic_code=XNGS&apikey=your_api_key

ExchangesHigh Demand

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

HTTP request example

https://api.twelvedata.com/exchanges

This request will return JSON with the following structure

[
  {
    "name": "NASDAQ",
    "code": "XNGS",
    "country": "United States",
    "timezone": "America/New_York"
  },
  {
    "name": "NYSE",
    "code": "XNYS",
    "country": "United States",
    "timezone": "America/New_York"
  },
  {
    "name": "SGX",
    "code": "XSES",
    "country": "Singapore",
    "timezone": "Asia/Singapore"
    },
  {...}
]

// with &show_plan=true
{
  "data": [
    {
      "name": "SSE",
      "code": "XSHG",
      "country": "China",
      "timezone": "Asia/Shanghai",
      "access": {
        "global": "Level B",
        "plan": "Pro"
      }
    },
    {
      "name": "SZSE",
      "code": "XSHE",
      "country": "China",
      "timezone": "Asia/Shanghai",
      "access": {
        "global": "Level B",
        "plan": "Pro"
      }
    }
  ],
  "status": "ok"
}

HTTP route

/exchanges

API credits

1 per request

API parameters

Parameter	Details
type	• The asset class to which the instrument belongs • Supports 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`, and `Warrant`
name	• Parameter is optional • Filter by exchange name
code	• Parameter is optional • Filter by market identifier code (MIC) under ISO 10383 standard
country	• Parameter is optional • Filter by country name or alpha code
format	• Parameter is optional • Value can be `CSV` or `JSON`; Default `JSON`
delimiter	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
show_plan	• Parameter is optional • Adds info on which plan symbol is available • Boolean; Default `false`

Response

Key	Description
name	name of exchange
code	market identifier code (MIC) under ISO 10383 standard
country	country to which stock exchange belongs to
timezone	time zone where exchange is located

JSON request example

https://api.twelvedata.com/exchanges

https://api.twelvedata.com/exchanges?type=etf

Downloadable CSV example

https://api.twelvedata.com/exchanges?format=CSV

Exchange schedule

This API call return exchanges details and trading hours.

HTTP request example

https://api.twelvedata.com/exchange_schedule?apikey=your_api_key

This request will return JSON with the following structure

{
    "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"},
            {"open_time": "09:30:00", "close_time": "16:00:00", "session_name": "Market", "session_type": "quotes"},
            {"open_time": "16:00:00", "close_time": "20:00:00", "session_name": "Post market", "session_type": "post"}
          ]
        },
        {...}
    ]
}

HTTP route

/exchange_schedule

API credits

100 per request

API parameters

Parameter	Details
date	• Parameter is optional • If a date is provided, the API returns the schedule for the specified date; otherwise, it returns the default (common) schedule. • The date can be specified in one of the following formats: - An exact date (e.g., `2021-10-27`) - A human-readable keyword: `today` or `yesterday` - 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
mic_name	• Parameter is optional • Filter by exchange name
mic_code	• Parameter is optional • Filter by market identifier code (MIC) under ISO 10383 standard
country	• Parameter is optional • Filter by country name or alpha code

Response

Key	Description
title	official name of exchange
name	name of exchange
code	market identifier code (MIC) under ISO 10383 standard
country	country to which stock exchange belongs to
timezone	time zone where exchange is located
sessions	exchange trading hours

JSON request example

https://api.twelvedata.com/exchange_schedule?apikey=your_api_key

https://api.twelvedata.com/exchange_schedule?date=today&apikey=your_api_key

Cryptocurrency Exchanges

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

HTTP request example

https://api.twelvedata.com/cryptocurrency_exchanges

This request will return JSON with the following structure

[
  {
    "name": "Binance",
  },
  {
    "name": "Upbit",
  },
  {
    "name": "Huobi",
  },
  {
    "name": "Bittrex",
  },
  {
    "name": "Bithumb",
  },
  {...}
]

HTTP route

/cryptocurrency_exchanges

API credits

1 per request

API parameters

Parameter	Details
format	• Parameter is optional • Value can be `CSV` or `JSON`; Default `JSON`
delimiter	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`

Response

Key	Description
name	name of cryptocurrency exchange

JSON request example

https://api.twelvedata.com/cryptocurrency_exchanges

Downloadable CSV example

https://api.twelvedata.com/cryptocurrency_exchanges?format=CSV

Market State

Check the state of all available exchanges, time to open, and time to close.

Returns all available stock exchanges by default

HTTP request example

https://api.twelvedata.com/market_state?apikey=your_api_key

This request will return JSON with the following structure

[
  {
    "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"
  },
  {
    "name": "NYSE",
    "code": "XASE",
    "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"
  },
  {
    "name": "NYSE",
    "code": "ARCX",
    "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"
  },
  {
    "name": "NASDAQ",
    "code": "XNGS",
    "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"
  },
  {
    "name": "NASDAQ",
    "code": "XNMS",
    "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"
  },
  {...}
]

HTTP route

/market_state

API credits

1 per request

API parameters

Key	Type	Description
exchange	string	• Parameter is optional • Takes exchange name or alpha code
code	string	• Parameter is optional • Takes MIC code of exchange
country	string	• Parameter is optional • Takes country name or alpha code
apikey	string	• Required parameter • Your API key, which you can obtain for free here

Response

Key	Description
name	the full name of exchange
code	Market Identifier Codes (MIC) under ISO 10383 standard
country	country where exchange is located
is_market_open	`true` if market is open; `false` if closed
time_after_open	time after market opening `HH:MM:SS` format; if currently closed - returns `00:00:00`
time_to_open	time to market opening in `HH:MM:SS` format; if currently open - returns `00:00:00`
time_to_close	time to market closing in `HH:MM:SS` format; if currently closed - returns `00:00:00`

JSON request example

https://api.twelvedata.com/market_state?exchange=NYSE&apikey=demo

https://api.twelvedata.com/market_state?exchange=XMAD&apikey=demo

https://api.twelvedata.com/market_state?country=India&apikey=demo

Instrument Type

Returns a list of instrument types

HTTP request example

https://api.twelvedata.com/instrument_type?apikey=your_api_key

This request will return JSON with the following structure

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

HTTP route

/instrument_type

API credits

1 per request

JSON request example

https://api.twelvedata.com/instrument_type?apikey=your_api_key

Countries

Returns a list of countries

HTTP request example

https://api.twelvedata.com/countries?apikey=your_api_key

This request will return JSON with the following structure

{
  "data": [
    {
      "iso2": "AF",
      "iso3": "AFG",
      "numeric": 4,
      "name": "Afghanistan",
      "official_name": "The Islamic Republic of Afghanistan",
      "capital": "Kabul",
      "currency": "AFN"
    },
    {
      "iso2": "AX",
      "iso3": "ALA",
      "numeric": 248,
      "name": "Åland Islands",
      "official_name": "Åland",
      "capital": "Mariehamn",
      "currency": "EUR"
    },
    {
      "iso2": "AL",
      "iso3": "ALB",
      "numeric": 8,
      "name": "Albania",
      "official_name": "The Republic of Albania",
      "capital": "Tirana",
      "currency": "ALL"
    }
  ]
}

HTTP route

/countries

API credits

1 per request

Response

Key	Description
iso2	two-letter country code defined in ISO 3166
iso3	three-letter country code defined in ISO 3166
numeric	numeric country code defined in ISO 3166
name	the full name of country
official_name	official name of country
capital	capital of country
currency	currency of country

JSON request example

https://api.twelvedata.com/countries?apikey=your_api_key

Technical Indicators Interface

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.

HTTP request example

https://api.twelvedata.com/technical_indicators

This request will return JSON with the following structure

[
  {
    "macd": {
      "enable": true,
      "full_name": "Moving Average Convergence Divergence",
      "description": "Moving Average Convergence Divergence(MACD) is a trend following momentum indicator, which works by subtracting the longer moving average from the shorter one. MACD has an unstable period ~ 100.",
      "type": "Momentum Indicators",
      "overlay": false,
      "parameters": {
        "series_type": {
          "default": "close",
          "range": ["open", "high", "low", "close"],
          "type": "string"
        },
        "fast_period": {
          "default": 12,
          "min_range": 1,
          "type": "int"
        },
        "slow_period": {
          "default": 26,
          "min_range": 1,
          "type": "int"
        },
        "signal_period": {
          "default": 9,
          "min_range": 1,
          "type": "int"
        }
      },
      "output_values": {
        "macd": {
          "default_color": "#2708A0",
          "display": "line"
        },
        "macd_signal": {
          "default_color": "#B80C09",
          "display": "line"
        },
        "macd_hist": {
          "default_color": "#B80C09",
          "display": "histogram"
        }
      }
    }
  },
  {...}
]

HTTP route

/technical_indicators

API credits

1 per request

API parameters

no input parameters

Response

Key	Description
enable	if the indicator is tested, approved and is recommended for use returns `true`, otherwise returns `false`
full_name	full indicator name
description	brief description of the indicator
type	group to which indicator belongs to
overlay	if indicator should be plotted over price bars returns `true`, otherwise returns `false`
parameters	an array of input parameters where each object might contain: default: specifies parameter value set by default range: an array of available parameter values min_range: if the parameter has lower bound in order to ensure correct calculation max_range: if the parameter has upper bound in order to ensure correct calculation type: type of parameter might be `string`, `int`, `float` or `array`
output_values	an array of output values where each object might contain: default_color: suggested color for displaying returns hex color code display: how output value should be rendered, might be `line`, `histogram`, `candle` or `points` min_range: if output value has minimum bound max_range: if output value has maximum bound
tinting	an array of tinting values used for proper indicator coloring display: render pattern color: returns hex color code transparency: transparency level returns float value from `0` to `1` level lower_bound: lower bound of tinting might be either number or one of the return parameters upper_bound: upper bound of tinting might be either number or one of the return parameters

JSON request example

https://api.twelvedata.com/technical_indicators

Earliest Timestamp

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

HTTP request example

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

This request will return JSON with the following structure

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

HTTP route

/earliest_timestamp

API credits

1 per request

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`

Response

Key	Description
datetime	earliest datetime, the format depends on interval
unix_time	datetime converted to UNIX timestamp

JSON request example

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

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

https://api.twelvedata.com/earliest_timestamp?symbol=EUR/USD&interval=1min&apikey=demo

Symbol SearchHigh Demand

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.

HTTP request example

https://api.twelvedata.com/symbol_search?symbol=AA

This request will return JSON with the following structure

{
  "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"
    },
    {
      "symbol": "AAA",
      "instrument_name": "BetaShares Australian High Interest Cash ETF",
      "exchange": "ASX",
      "mic_code": "XASX",
      "exchange_timezone": "Australia/Sydney",
      "instrument_type": "ETF",
      "country": "Australia",
      "currency": "AUD"
    },
    {...}
  ],
  "status": "ok"
}

// with &show_plan=true
{
  "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"
      }
    },
    {
      "symbol": "AAA",
      "instrument_name": "Listed Funds Trust - AAF First Priority CLO Bond ETF",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "exchange_timezone": "America/New_York",
      "instrument_type": "ETF",
      "country": "United States",
      "currency": "USD",
      "access": {
        "global": "Basic",
        "plan": "Basic"
      }
    },
    {...}
  ],
  "status": "ok"
}

HTTP route

/symbol_search

API credits

1 per request

API parameters

Parameter	Details
symbol	• Required parameter • Symbol to search
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
outputsize	• Parameter is optional • Number of matches in response • Default `30`, Max `120`;
show_plan	• Parameter is optional • Adds info on which plan symbol is available • Boolean; Default `false`

Response

Key	Description
symbol	ticker symbol of instrument
instrument_name	name of exchange
exchange	exchange where instrument is traded
mic_code	market identifier code (MIC) under ISO 10383 standard
exchange_timezone	time zone where exchange is located
instrument_type	type of instrument
country	country to which stock exchange belongs to

JSON request example

https://api.twelvedata.com/symbol_search?symbol=AA

https://api.twelvedata.com/symbol_search?symbol=XAU/

https://api.twelvedata.com/symbol_search?symbol=RY&show_plan=true

Core Data

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

Time SeriesHigh Demand

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.

HTTP request example

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

This request will return JSON with the following structure

{
  "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"
    },
    {
      "datetime": "2021-09-16 15:58:00",
      "open": "148.72000",
      "high": "148.78000",
      "low": "148.70000",
      "close": "148.74001",
      "volume": "274622"
    },
    {
      "datetime": "2021-09-16 15:57:00",
      "open": "148.77499",
      "high": "148.79500",
      "low": "148.71001",
      "close": "148.72501",
      "volume": "254725"
    },
    {
      "datetime": "2021-09-16 15:56:00",
      "open": "148.76500",
      "high": "148.78999",
      "low": "148.72000",
      "close": "148.78000",
      "volume": "230758"
    },
    {
      "datetime": "2021-09-16 15:55:00",
      "open": "148.80000",
      "high": "148.80000",
      "low": "148.70000",
      "close": "148.76230",
      "volume": "348577"
    }
  ],
  "status": "ok"
}

HTTP route

/time_series

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
prepost	string	• 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`
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; By default, the number of decimal places is automatically determined based on the values provided.
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
date	string	• Parameter is optional • 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`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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
previous_close	string	• Parameter is optional • If `true`, adds previous bar close price value to the current object • Only applicable to `/time_series` endpoint • Type `bool`; Default `false`
adjust	string	• Parameter is optional • Adjusting mode for prices • Supports all, splits, dividends, none • Default is splits

Response

Key	Description
meta	json object with request general information
datetime	datetime at local exchange time referring to when the bar with specified interval was opened
open	price at the opening of current bar
high	highest price which occurred during the current bar
low	lowest price which occurred during the current bar
close	close price at the end of the bar
volume	trading volume which occurred during the current bar

JSON request example

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

https://api.twelvedata.com/time_series?symbol=EUR/USD&interval=1day&outputsize=12&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/time_series?symbol=BTC/USD&interval=5min&format=CSV&apikey=demo

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.

HTTP request example

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

This request will return JSON with the following structure

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

HTTP route

/time_series/cross

API credits

5 per symbol

API parameters

Key	Type	Description
base_symbol	string	• Required parameter • Base symbol, for example: `JPY`
base_type	string	• Optional parameter • Base instrument type according to the `\instrument_type` endpoint, for example: `Physical Currency`
base_exchange	string	• Optional parameter • Base exchange, for example: Binance
base_mic_code	string	• Optional parameter • Base MIC code, for example: XNGS
quote_symbol	string	• Required parameter • Quote symbol, for example: `BTC`
quote_type	string	• Optional parameter • Quote instrument type according to the `\instrument_type` endpoint, for example: `Digital Currency`
quote_exchange	string	• Optional parameter • Quote exchange, for example: Coinbase
quote_mic_code	string	• Optional parameter • Quote MIC code, for example: XNYS
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
prepost	string	• 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`
start_date	string	• Parameter is optional • Format `2006-01-02`
end_date	string	• Parameter is optional • Format `2006-01-02`
adjust	string
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`

Response

Key	Description
meta	json object with request general information
datetime	datetime at local exchange time referring to when the bar with specified interval was opened
open	price at the opening of current bar
high	highest price which occurred during the current bar
low	lowest price which occurred during the current bar
close	close price at the end of the bar

JSON request example

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

https://api.twelvedata.com/time_series/cross?base=BTC&quote=JPY&interval=1min&end_date=2025-02-12&apikey=demo

Downloadable CSV example

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

Exchange Rate

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

HTTP request example

https://api.twelvedata.com/exchange_rate?symbol=USD/JPY&apikey=your_api_key

This request will return JSON with the following structure

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

HTTP route

/exchange_rate

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • 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
date	string	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`

Response

Key	Description
symbol	requested currency symbol
rate	real-time exchange rate for the corresponding symbol
timestamp	unix timestamp of the rate

JSON request example

https://api.twelvedata.com/exchange_rate?symbol=USD/JPY&apikey=demo

https://api.twelvedata.com/exchange_rate?symbol=USD/JPY&date=2022-02-22&apikey=demo

Downloadable CSV example

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

Currency ConversionUseful

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

HTTP request example

https://api.twelvedata.com/currency_conversion?symbol=USD/JPY&amount=122&apikey=your_api_key

This request will return JSON with the following structure

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

HTTP route

/currency_conversion

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • 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
amount	number	• Required parameter • Amount of base currency to be converted into quote currency. • Supports values in the range from `0` and above
date	string	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`

Response

Key	Description
symbol	requested currency symbol
rate	real-time exchange rate for the corresponding symbol
amount	amount of converted currency
timestamp	unix timestamp of the rate

JSON request example

https://api.twelvedata.com/currency_conversion?symbol=USD/JPY&amount=122&apikey=demo

https://api.twelvedata.com/currency_conversion?symbol=USD/JPY&amount=122&date=2022-02-22&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/currency_conversion?symbol=EUR/USD&amount=15&format=CSV&apikey=demo

QuoteHigh Demand

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

HTTP request example

https://api.twelvedata.com/quote?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

{
  "symbol": "AAPL",
  "name": "Apple Inc",
  "exchange": "NASDAQ",
  "mic_code": "XNAS",
  "currency": "USD",
  "datetime": "2021-09-16",
  "timestamp": 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_1d_change": "123.123",
  "rolling_7d_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,
  "last_quote_at": 1631772000,
}

HTTP route

/quote

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Optional parameter • Interval of the quote • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`; Default `1day`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
volume_time_period	string	• Optional parameter • Number of periods for Average Volume • Default `9`
type	string	• Parameter is optional • 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`, and `Warrant`
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
prepost	string	• 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	string	• Optional parameter • If true, then return data for closed day
rolling_period	string	• Optional parameter • Number of hours for calculate rolling change at period. By default set to 24, it can be in range [1, 168].
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`

Response

Key	Description
symbol	symbol passed
name	name of the instrument
exchange	exchange where instrument is traded
mic_code	market identifier code (MIC) under ISO 10383 standard
currency	currency in which the equity is denominated
timestamp	unix timestamp representing the opening candle of the specified interval
last_quote_at	unix timestamp of last minute candle
datetime	datetime in defined timezone referring to when the bar with specified interval was opened
open	price at the opening of current bar
high	highest price which occurred during the current bar
low	lowest price which occurred during the current bar
close	close price at the end of the bar
volume	trading volume during the bar
previous_close	close price at the end of the previous bar
change	close - previous_close
percent_change	(close - previous_close) / previous_close * 100
average_volume	average volume of the specified period
rolling_1d_change	percent change in price between the current and the backward one, where period is 1 day, available for crypto
rolling_7d_change	percent change in price between the current and the backward one, where period is 7 days, available for crypto
rolling_period_change	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	`true` if market is open; `false` if closed
fifty_two_week	collection of 52-week metrics
extended_change	diff between the regular close price and the latest extended price
extended_percent_change	percent change in price between the regular close price and the latest extended price
extended_price	latest extended price
extended_timestamp	unix timestamp of the last extended price

JSON request example

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

https://api.twelvedata.com/quote?symbol=EUR/USD&interval=30min&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/quote?symbol=CBQK&type=Common%20Stock&interval=5min&format=CSV&apikey=demo

Real-Time PriceHigh Demand

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

HTTP request example

https://api.twelvedata.com/price?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

{
    "price": "200.99001"
}

HTTP route

/price

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
type	string	• Parameter is optional • 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`, and `Warrant`
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
prepost	string	• 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`
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range `[0,11]` inclusive; default `5`

Response

Key	Description
price	real-time or the latest available price

JSON request example

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

https://api.twelvedata.com/price?symbol=TRP&country=Canada&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/price?symbol=USD/JPY&format=CSV&apikey=demo

End of Day Price

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

HTTP request example

https://api.twelvedata.com/eod?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

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

HTTP route

/eod

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
type	string	• Parameter is optional • 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`, and `Warrant`
date	string	• Parameter is optional • If not null, then return data from a specific date • Format 2006-01-02
apikey	string	• Required parameter • Your API key, which you can obtain for free here
prepost	string	• 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`
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range `[0,11]` inclusive; default `5`

Response

Key	Description
symbol	symbol passed
exchange	exchange where instrument is traded
mic_code	market identifier code (MIC) under ISO 10383 standard
currency	currency in which instrument is denominated
datetime	datetime in defined timezone referring to when the bar with specified interval was opened
close	the most recent end of day close price

JSON request example

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

https://api.twelvedata.com/eod?symbol=TRP&country=Canada&apikey=demo

Market Movers

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.

HTTP request example

https://api.twelvedata.com/market_movers/stocks?apikey=your_api_key

This request will return JSON with the following structure

{
  "values": [
    {
      "symbol": "BSET",
      "name": "Bassett Furniture Industries Inc",
      "exchange": "NASDAQ",
      "mic_code": "XNAS",
      "datetime": "2022-01-31 09:34:00",
      "last": 17.25,
      "high": 17.35,
      "low": 15.90999,
      "volume": 108297,
      "change": 3.31,
      "percent_change": 23.74462
    },
    {
      "symbol": "TWKS",
      "name": "Thoughtworks Holding, Inc.",
      "exchange": "NASDAQ",
      "mic_code": "XNAS",
      "datetime": "2022-01-31 09:34:40",
      "last": 20.09,
      "high": 19.62999,
      "low": 18.29999,
      "volume": 392376,
      "change": 3.98,
      "percent_change": 20.84861
    },
    {
      "symbol": "RMED",
      "name": "RA Medical Systems Inc",
      "exchange": "NYSE",
      "mic_code": "XNAS",
      "datetime": "2022-01-31 09:33:50",
      "last": 0.984,
      "high": 0.98519,
      "low": 0.984,
      "volume": 4480,
      "change": 0.159,
      "percent_change": 17.84511
    }
  ],
  "status": "ok"
}

HTTP routes

/market_movers/stocks
/market_movers/etf
/market_movers/mutual_funds
/market_movers/forex
/market_movers/crypto

API credits

100 per request

API parameters

Key	Type	Description
direction	string	• Parameter is optional • Specifies direction of the snapshot `gainers` or `losers` • By default `gainers`
outputsize	string	• Parameter is optional • Specifies the size of the snapshot • Can be in a range from `1` to `50`; default `30`
country	string	• Parameter is optional • Country of the snapshot, applicable to non-currencies only • Takes country name or alpha code; default `USA`
price_greater_than	string	Parameter is optional • Takes values with price grater than specified value
apikey	string	• Required parameter • Your API key, which you can obtain for free here
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range `[0,11]` inclusive; default `5`

Response

Key	Description
symbol	the exchange symbol ticker
name	the official name of the instrument
exchange	exchange where instrument is traded
mic_code	market identifier code (MIC) under ISO 10383 standard
datetime	the last updated datetime timestamp
last	the latest available price for the symbol today
high	the highest price for the symbol today
low	the lowest price for the symbol today
volume	the trading volume of the symbol today
change	the value of the change since the previous day
percent_change	the percentage change since the previous day

JSON request example

https://api.twelvedata.com/market_movers/stocks?country=india&outputsize=20&apikey=demo

https://api.twelvedata.com/market_movers/forex?direction=losers&apikey=demo

Mutual Funds

MFs ListUseful

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.

HTTP request example

https://api.twelvedata.com/mutual_funds/list?apikey=your_api_key

This request will return JSON with the following structure

{
  "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"
      },
      {
        "symbol": "0P00016LWW",
        "name": "RBC Select Balanced Portfolio O",
        "country": "Canada",
        "fund_family": "RBC Global Asset Management Inc.",
        "fund_type": "Global Neutral Balanced",
        "performance_rating": 3,
        "risk_rating": 3,
        "exchange": "TSX",
        "mic_code": "XTSE"
      },
      {
        "symbol": "0P00005WT4",
        "name": "Kotak Savings Fund Monthly Dividend Payout",
        "country": "India",
        "fund_family": "Kotak Mahindra Asset Management Co Ltd",
        "fund_type": "Ultrashort Bond",
        "performance_rating": 3,
        "risk_rating": 3,
        "exchange": "BSE",
        "mic_code": "XBOM"
      },
      {...}
    ]
  },
  "status": "ok"
}

HTTP route

/mutual_funds/list

API credits

1 per request

API parameters

Parameter	Details
symbol	• Parameter is optional • Filter by symbol
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
fund_family	• Parameter is optional • Filter by investment company that manages the fund
fund_type	• Parameter is optional • Filter by the type of fund
performance_rating	• Parameter is optional • Filter by performance rating from 0 to 5
risk_rating	• Parameter is optional • Filter by risk rating from 0 to 5
page	• Parameter is optional • Page number; default `1`
outputsize	• Parameter is optional • Number of records in response; default `100`
apikey	• Required parameter • Your API key at the Basic plan or above

Response

Key	Description
count	total number of matching funds
symbol	fund symbol ticker
name	fund name
country	country of fund incorporation
fund_family	investment company that manages the fund
fund_type	type of fund
performance_rating	performance rating from 0 to 5
risk_rating	risk rating from 0 to 5
exchange	exchange name where the fund is listed
mic_code	market identifier code (MIC) under ISO 10383 standard

JSON request example

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

https://api.twelvedata.com/mutual_funds/list?fund_family=Vanguard&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/mutual_funds/list?format=CSV&apikey=demo

MFs Family List

This API request returns a list of mutual funds families.

HTTP request example

https://api.twelvedata.com/mutual_funds/family?apikey=your_api_key

This request will return JSON with the following structure

{
  "result": {
    "India": [
      "Aberdeen Standard Fund Managers Limited",
      "Aditya Birla Sun Life AMC Ltd",
      "Aditya Birla Sun Life Insurance Company Limited",
      "Aegon Life Insurance Company Ltd.",
      "Aviva Life Insur Co. India Pvt. Ltd.",
      "Axis Asset Management Company Limited",
      "Bajaj Allianz Life Insurance Company Ltd",
      "Baring International Fund Mgrs (Ireland) Limited",
      "Baroda Asset Management India Limited"
    ],
    "United States": [
      "Aegon Asset Management UK PLC",
      "Ampega Investment GmbH",
      "Aviva SpA",
      "BBVA Asset Management SA SGIIC",
      "Caser Pensiones EGFP",
      "HSBC Investment Funds (HK) Limited",
      "Premier Portfolio Managers Limited",
      "SEI Investments Global Limited",
      "Vanguard"
    ]
  },
  "status": "ok"
}

HTTP route

/mutual_funds/family

API credits

1 per request

API parameters

Parameter	Details
country	• Parameter is optional • Filter by country name or alpha code
fund_family	• Parameter is optional • Filter by investment company that manages the fund
apikey	• Required parameter • Your API key at the Basic plan or above

Response

Key	Description
result	all available fund families segmented by country

JSON request example

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

https://api.twelvedata.com/mutual_funds/family?country=US&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/mutual_funds/family?format=CSV&apikey=demo

MFs Type List

This API request returns a list of mutual funds types.

HTTP request example

https://api.twelvedata.com/mutual_funds/type?apikey=your_api_key

This request will return JSON with the following structure

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

HTTP route

/mutual_funds/type

API credits

1 per request

API parameters

Parameter	Details
country	• Parameter is optional • Filter by country name or alpha code
fund_type	• Parameter is optional • Filter by the type of fund
apikey	• Required parameter • Your API key at the Basic plan or above

Response

Key	Description
result	all available fund types segmented by country

JSON request example

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

https://api.twelvedata.com/mutual_funds/type?country=US&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/mutual_funds/type?format=CSV&apikey=demo

All dataHigh Demand

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

HTTP request example

https://api.twelvedata.com/mutual_funds/world?symbol=0P0001LCQ3&apikey=your_api_key

This request will return JSON with the following structure

{
  "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 included in the index in proportion to their market capitalization weighting in the index. The index is a quarterly-rebalanced, float-adjusted market cap weighted index comprised of approximately 600 U.S. common equities and REITs that meet the index provider's criteria for market capitalization, public float, financial viability, liquidity, price reasonableness, and sector representation.",
      "people": [

      ]
    },
    "performance": {
      "trailing_returns": [
        {
          "period": "ytd",
          "share_class_return": -0.02986,
          "category_return": 0.2019,
          "rank_in_category": 76
        },
        {
          "period": "1_month",
          "share_class_return": -0.058,
          "category_return": 0.0002,
          "rank_in_category": 78
        },
        {
          "period": "3_month",
          "share_class_return": -0.10741,
          "category_return": 0.0436,
          "rank_in_category": 76
        },
        {
          "period": "1_year",
          "share_class_return": 0.06139,
          "category_return": 0.6018,
          "rank_in_category": 59
        },
        {
          "period": "3_year",
          "share_class_return": 0.02896,
          "category_return": 0.1132,
          "rank_in_category": 74
        },
        {
          "period": "5_year",
          "share_class_return": 0,
          "category_return": 0.1388,
          "rank_in_category": null
        },
        {
          "period": "10_year",
          "share_class_return": 0,
          "category_return": 0.1119,
          "rank_in_category": null
        }
      ],
      "annual_total_returns": [
        {
          "year": 2024,
          "share_class_return": 0.08546,
          "category_return": null
        },
        {
          "year": 2023,
          "share_class_return": 0.16078,
          "category_return": null
        },
        {
          "year": 2022,
          "share_class_return": -0.16237,
          "category_return": null
        },
        {
          "year": 2021,
          "share_class_return": null,
          "category_return": null
        }
      ],
      "quarterly_total_returns": [
        {
          "year": 2024,
          "q1": 0.02358,
          "q2": -0.03071,
          "q3": 0.10099,
          "q4": -0.00629
        },
        {
          "year": 2023,
          "q1": 0.02623,
          "q2": 0.03333,
          "q3": -0.04946,
          "q4": 0.15158
        },
        {
          "year": 2022,
          "q1": -0.05635,
          "q2": -0.1417,
          "q3": -0.05189,
          "q4": 0.0908
        },
        {
          "year": 2021,
          "q1": -0.0284,
          "q2": 0.05544,
          "q3": null,
          "q4": null
        }
      ],
      "load_adjusted_return": [
        {
          "period": "1_year",
          "return": 0.06139
        },
        {
          "period": "3_year",
          "return": 0.02896
        }
      ]
    },
    "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
        },
        {
          "period": "5_year",
          "alpha": null,
          "alpha_category": -0.0595,
          "beta": null,
          "beta_category": 0.0123,
          "mean_annual_return": null,
          "mean_annual_return_category": 0.0128,
          "r_squared": null,
          "r_squared_category": 0.77,
          "std": null,
          "std_category": 0.211,
          "sharpe_ratio": null,
          "sharpe_ratio_category": 0.0067,
          "treynor_ratio": null,
          "treynor_ratio_category": 0.1035
        },
        {
          "period": "10_year",
          "alpha": null,
          "alpha_category": -0.0551,
          "beta": null,
          "beta_category": 0.0122,
          "mean_annual_return": null,
          "mean_annual_return_category": 0.0104,
          "r_squared": null,
          "r_squared_category": 0.7752,
          "std": null,
          "std_category": 0.1886,
          "sharpe_ratio": null,
          "sharpe_ratio_category": 0.0063,
          "treynor_ratio": null,
          "treynor_ratio_category": 0.087
        }
      ],
      "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
        },
        {
          "sector": "Financial Services",
          "weight": 0.1735
        },
        {
          "sector": "Consumer Cyclical",
          "weight": 0.1461
        },
        {
          "sector": "Technology",
          "weight": 0.1319
        },
        {
          "sector": "Healthcare",
          "weight": 0.1065
        },
        {
          "sector": "Realestate",
          "weight": 0.0916
        },
        {
          "sector": "Energy",
          "weight": 0.0466
        },
        {
          "sector": "Consumer Defensive",
          "weight": 0.0421
        },
        {
          "sector": "Basic Materials",
          "weight": 0.0401
        },
        {
          "sector": "Communication Services",
          "weight": 0.0284
        },
        {
          "sector": "Utilities",
          "weight": 0.019
        }
      ],
      "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
        },
        {
          "symbol": "GKOS",
          "name": "Glaukos Corp",
          "weight": 0.00607
        },
        {
          "symbol": "ALK",
          "name": "Alaska Air Group Inc",
          "weight": 0.00604
        },
        {
          "symbol": "ATI",
          "name": "ATI Inc",
          "weight": 0.00575
        },
        {
          "symbol": "RHI",
          "name": "Robert Half Inc",
          "weight": 0.00525
        },
        {
          "symbol": "VFC",
          "name": "VF Corp",
          "weight": 0.00521
        },
        {
          "symbol": "SPSC",
          "name": "SPS Commerce Inc",
          "weight": 0.00507
        },
        {
          "symbol": "SPXC",
          "name": "SPX Technologies Inc",
          "weight": 0.00495
        },
        {
          "symbol": "JXN",
          "name": "Jackson Financial Inc",
          "weight": 0.00473
        },
        {
          "symbol": "QRVO",
          "name": "Qorvo Inc",
          "weight": 0.00465
        }
      ],
      "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": null,
      "corporate_esg_pillars": {
        "environmental": null,
        "social": null,
        "governance": null
      },
      "sustainable_investment": false,
      "corporate_aum": null
    }
  },
  "status": "ok"
}

HTTP route

/mutual_funds/world

API credits

1000 per request

API parameters

Parameter	Details
symbol	• Required parameter • Symbol ticker of mutual fund
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
dp	• Parameter is optional • Number of decimal places for floating values • Accepts value in range `[0,11]`; default `5`
apikey	• Required parameter • Your API key upgraded to the Ultra plan or above

Response

Key	Description
symbol	all available fund types segmented by country
name	fund name
fund_family	investment company that manages the fund
fund_type	type of the fund
currency	currency of fund price
share_class_inception_date	the date from which the fund started operations and the returns are calculated
ytd_return	percentage of profit of the fund since the first trading day of the current calendar year
expense_ratio_net	percentage of mutual fund assets steered toward a fund's operating expenses and fund management fees
yield	income returned to its investors through interest and dividends generated by the fund's investments
nav	last price of the fund
min_investment	investment minimum
turnover_rate	percentage rate at which mutual fund replaces its holdings on investment every year
net_assets	total assets of a fund minus its total liabilities
overview	description of the fund
people.name	manager name
people.tenure_since	manager tenuring date
trailing_returns.period	period of trailing returns
trailing_returns.share_class_return	fund returns (%) generated over a given period
trailing_returns.category_return	same category average returns (%) generated over a given period
trailing_returns.rank_in_category	rank of a fund in category by total returns
annual_total_returns.year	year of total returns
annual_total_returns.share_class_return	fund total returns (%) generated over a given year
annual_total_returns.category_return	same category average total returns (%) generated over a given year
quarterly_total_returns.year	year of a fund quarter return
quarterly_total_returns.q1	total return (%) of a fund in the first quarter
quarterly_total_returns.q2	total return (%) of a fund in the second quarter
quarterly_total_returns.q3	total return (%) of a fund in the third quarter
quarterly_total_returns.q4	total return (%) of a fund in the forth quarter
load_adjusted_return.period	period of a load adjusted return
load_adjusted_return.return	actual return (%) an investor sees after accounting for fees and sales charges are deducted from a mutual fund's performance
volatility_measures.period	period of a measure
volatility_measures.alpha	alpha score of a fund
volatility_measures.alpha_category	average alpha score of a fund's category
volatility_measures.beta	beta score of a fund
volatility_measures.beta_category	average beta score of a fund's category
volatility_measures.mean_annual	mean annual return of a fund
volatility_measures.mean_annual_category	average mean annual return of a fund's category
volatility_measures.r_squared	r-squared metric of a fund
volatility_measures.r_squared_category	average r-squared metric of a fund's category
volatility_measures.std	standard deviation of a fund
volatility_measures.std_category	average standard deviation of a fund's category
volatility_measures.sharpe_ratio	sharpe ratio of a fund
volatility_measures.sharpe_ratio_category	average sharpe ratio of a fund's category
volatility_measures.treynor_ratio	treynor ratio of a fund
volatility_measures.treynor_ratio_category	average treynor ratio of a fund's category
valuation_metrics.price_to_earnings	fund price to earnings metric
valuation_metrics.price_to_earnings_category	average price to earnings metric of funds in the same category
valuation_metrics.price_to_book	fund price to book metric
valuation_metrics.price_to_book_category	average price to book metric of funds in the same category
valuation_metrics.price_to_sales	fund price to sales metric
valuation_metrics.price_to_sales_category	average price to sales metric of funds in the same category
valuation_metrics.price_to_cashflow	fund price to cashflow metric
valuation_metrics.price_to_cashflow_category	average price to cashflow metric of funds in the same category
valuation_metrics.median_market_capitalization	median market capitalization of a fund
valuation_metrics.median_market_capitalization_category	median market capitalization of funds in the same category
valuation_metrics.3_year_earnings_growth	earnings growth over the last three years
valuation_metrics.3_year_earnings_growth_category	earnings growth over the last three years of funds in the same category
performance_rating	performance rating from 0 to 5
risk_rating	risk rating from 0 to 5
return_rating	return rating from 0 to 5
major_market_sectors.sector	sector category of a fund exposure
major_market_sectors.weight	weight (%) of a fund exposure in a sector
asset_allocation.cash	percentage of overall portfolio composition in cash
asset_allocation.stocks	percentage of overall portfolio composition in stocks
asset_allocation.preferred_stocks	percentage of overall portfolio composition in preferred stocks
asset_allocation.convertables	percentage of overall portfolio composition in convertable securities
asset_allocation.bonds	percentage of overall portfolio composition in bond
asset_allocation.others	percentage of overall portfolio composition in other forms of holding
top_holdings.symbol	symbol ticker of a holding instrument
top_holdings.name	name of a holding instrument
top_holdings.weight	weight (%) of a holding instrument in overall portfolio composition
bond_breakdown.average_maturity.fund	average maturity of bond holding of a fund
bond_breakdown.average_maturity.category	average maturity of bond holding of funds in the same category
bond_breakdown.average_duration.fund	average duration of bond holding of a fund
bond_breakdown.average_duration.category	average duration of bond holding of funds in the same category
bond_breakdown.credit_quality.grade	rating of bond holding of a fund from AAA to below B
bond_breakdown.credit_quality.weight	weight of bond holding in fund portfolio
expenses.expense_ratio_gross	annual cost of investing in a mutual fund
expenses.expense_ratio_net	percentage of mutual fund assets steered toward a fund's operating expenses and fund management fees
minimums.initial_investment	investment minimum
minimums.additional_investment	minimum amount of additional investment
minimums.initial_ira_investment	investment minimum for IRA
minimums.additional_ira_investment	minimum amount of additional investment for IRA
pricing.nav	last price of the fund
pricing.12_month_low	lowest price of the fund over the last year
pricing.12_month_high	highest price of the fund over the last year
pricing.last_month	fund price at the end of the last month
brokerages	list of brokerages where mutual fund can be purchased
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.environmental	ESG environmental score
corporate_esg_pillars.social	ESG social score
corporate_esg_pillars.governance	ESG governance score
sustainable_investment	indication that the fund discloses in their prospectus that they employ socially responsible or ESG principles in their investment selection processes
corporate_aum	percentage of AUM used to calculate sustainability score

JSON request example

https://api.twelvedata.com/mutual_funds/world?symbol=0P0001LCQ3&apikey=demo

Summary

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

HTTP request example

https://api.twelvedata.com/mutual_funds/world/summary?symbol=0P0001LCQ3&apikey=your_api_key

This request will return JSON with the following structure

{
  "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 included in the index in proportion to their market capitalization weighting in the index. The index is a quarterly-rebalanced, float-adjusted market cap weighted index comprised of approximately 600 U.S. common equities and REITs that meet the index provider's criteria for market capitalization, public float, financial viability, liquidity, price reasonableness, and sector representation.",
      "people": [

      ]
    }
  },
  "status": "ok"
}

HTTP route

/mutual_funds/world/summary

API credits

200 per request

API parameters

Parameter	Details
symbol	• Required parameter • Symbol ticker of mutual fund
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
dp	• Parameter is optional • Number of decimal places for floating values • Accepts value in range `[0,11]`; default `5`
apikey	• Required parameter • Your API key upgraded to the Ultra plan or above

Response

Key	Description
symbol	all available fund types segmented by country
name	fund name
fund_family	investment company that manages the fund
fund_type	type of the fund
currency	currency of fund price
share_class_inception_date	the date from which the fund started operations and the returns are calculated
ytd_return	percentage of profit of the fund since the first trading day of the current calendar year
expense_ratio_net	percentage of mutual fund assets steered toward a fund's operating expenses and fund management fees
yield	income returned to its investors through interest and dividends generated by the fund's investments
nav	last price of the fund
min_investment	investment minimum
turnover_rate	percentage rate at which mutual fund replaces its holdings on investment every year
net_assets	total assets of a fund minus its total liabilities
overview	description of the fund
people.name	manager name
people.tenure_since	manager tenuring date

JSON request example

https://api.twelvedata.com/mutual_funds/world/summary?symbol=0P0001LCQ3&apikey=demo

PerformanceHigh Demand

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

HTTP request example

https://api.twelvedata.com/mutual_funds/world/performance?symbol=0P0001LCQ3&apikey=your_api_key

This request will return JSON with the following structure

{
  "mutual_fund": {
    "performance": {
      "trailing_returns": [
        {
          "period": "ytd",
          "share_class_return": -0.02986,
          "category_return": 0.2019,
          "rank_in_category": 76
        },
        {
          "period": "1_month",
          "share_class_return": -0.058,
          "category_return": 0.0002,
          "rank_in_category": 78
        },
        {
          "period": "3_month",
          "share_class_return": -0.10741,
          "category_return": 0.0436,
          "rank_in_category": 76
        },
        {
          "period": "1_year",
          "share_class_return": 0.06139,
          "category_return": 0.6018,
          "rank_in_category": 59
        },
        {
          "period": "3_year",
          "share_class_return": 0.02896,
          "category_return": 0.1132,
          "rank_in_category": 74
        },
        {
          "period": "5_year",
          "share_class_return": 0,
          "category_return": 0.1388,
          "rank_in_category": null
        },
        {
          "period": "10_year",
          "share_class_return": 0,
          "category_return": 0.1119,
          "rank_in_category": null
        }
      ],
      "annual_total_returns": [
        {
          "year": 2024,
          "share_class_return": 0.08546,
          "category_return": null
        },
        {
          "year": 2023,
          "share_class_return": 0.16078,
          "category_return": null
        },
        {
          "year": 2022,
          "share_class_return": -0.16237,
          "category_return": null
        },
        {
          "year": 2021,
          "share_class_return": null,
          "category_return": null
        }
      ],
      "quarterly_total_returns": [
        {
          "year": 2024,
          "q1": 0.02358,
          "q2": -0.03071,
          "q3": 0.10099,
          "q4": -0.00629
        },
        {
          "year": 2023,
          "q1": 0.02623,
          "q2": 0.03333,
          "q3": -0.04946,
          "q4": 0.15158
        },
        {
          "year": 2022,
          "q1": -0.05635,
          "q2": -0.1417,
          "q3": -0.05189,
          "q4": 0.0908
        },
        {
          "year": 2021,
          "q1": -0.0284,
          "q2": 0.05544,
          "q3": null,
          "q4": null
        }
      ],
      "load_adjusted_return": [
        {
          "period": "1_year",
          "return": 0.06139
        },
        {
          "period": "3_year",
          "return": 0.02896
        }
      ]
    }
  },
  "status": "ok"
}

HTTP route

/mutual_funds/world/performance

API credits

200 per request

API parameters

Parameter	Details
symbol	• Required parameter • Symbol ticker of mutual fund
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
dp	• Parameter is optional • Number of decimal places for floating values • Accepts value in range `[0,11]`; default `5`
apikey	• Required parameter • Your API key upgraded to the Ultra plan or above

Response

Key	Description
trailing_returns.period	period of trailing returns
trailing_returns.share_class_return	fund returns (%) generated over a given period
trailing_returns.category_return	same category average returns (%) generated over a given period
trailing_returns.rank_in_category	rank of a fund in category by total returns
annual_total_returns.year	year of total returns
annual_total_returns.share_class_return	fund total returns (%) generated over a given year
annual_total_returns.category_return	same category average total returns (%) generated over a given year
quarterly_total_returns.year	year of a fund quarter return
quarterly_total_returns.q1	total return (%) of a fund in the first quarter
quarterly_total_returns.q2	total return (%) of a fund in the second quarter
quarterly_total_returns.q3	total return (%) of a fund in the third quarter
quarterly_total_returns.q4	total return (%) of a fund in the forth quarter
load_adjusted_return.period	period of a load adjusted return
load_adjusted_return.return	actual return (%) an investor sees after accounting for fees and sales charges are deducted from a mutual fund's performance

JSON request example

https://api.twelvedata.com/mutual_funds/world/performance?symbol=0P0001LCQ3&apikey=demo

Risk

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

HTTP request example

https://api.twelvedata.com/mutual_funds/world/risk?symbol=0P0001LCQ3&apikey=your_api_key

This request will return JSON with the following structure

{
  "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
        },
        {
          "period": "5_year",
          "alpha": null,
          "alpha_category": -0.0595,
          "beta": null,
          "beta_category": 0.0123,
          "mean_annual_return": null,
          "mean_annual_return_category": 0.0128,
          "r_squared": null,
          "r_squared_category": 0.77,
          "std": null,
          "std_category": 0.211,
          "sharpe_ratio": null,
          "sharpe_ratio_category": 0.0067,
          "treynor_ratio": null,
          "treynor_ratio_category": 0.1035
        },
        {
          "period": "10_year",
          "alpha": null,
          "alpha_category": -0.0551,
          "beta": null,
          "beta_category": 0.0122,
          "mean_annual_return": null,
          "mean_annual_return_category": 0.0104,
          "r_squared": null,
          "r_squared_category": 0.7752,
          "std": null,
          "std_category": 0.1886,
          "sharpe_ratio": null,
          "sharpe_ratio_category": 0.0063,
          "treynor_ratio": null,
          "treynor_ratio_category": 0.087
        }
      ],
      "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"
}

HTTP route

/mutual_funds/world/risk

API credits

200 per request

API parameters

Parameter	Details
symbol	• Required parameter • Symbol ticker of mutual fund
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
dp	• Parameter is optional • Number of decimal places for floating values • Accepts value in range `[0,11]`; default `5`
apikey	• Required parameter • Your API key upgraded to the Ultra plan or above

Response

Key	Description
volatility_measures.period	period of a measure
volatility_measures.alpha	alpha score of a fund
volatility_measures.alpha_category	average alpha score of a fund's category
volatility_measures.beta	beta score of a fund
volatility_measures.beta_category	average beta score of a fund's category
volatility_measures.mean_annual	mean annual return of a fund
volatility_measures.mean_annual_category	average mean annual return of a fund's category
volatility_measures.r_squared	r-squared metric of a fund
volatility_measures.r_squared_category	average r-squared metric of a fund's category
volatility_measures.std	standard deviation of a fund
volatility_measures.std_category	average standard deviation of a fund's category
volatility_measures.sharpe_ratio	sharpe ratio of a fund
volatility_measures.sharpe_ratio_category	average sharpe ratio of a fund's category
volatility_measures.treynor_ratio	treynor ratio of a fund
volatility_measures.treynor_ratio_category	average treynor ratio of a fund's category
valuation_metrics.price_to_earnings	fund price to earnings metric
valuation_metrics.price_to_earnings_category	average price to earnings metric of funds in the same category
valuation_metrics.price_to_book	fund price to book metric
valuation_metrics.price_to_book_category	average price to book metric of funds in the same category
valuation_metrics.price_to_sales	fund price to sales metric
valuation_metrics.price_to_sales_category	average price to sales metric of funds in the same category
valuation_metrics.price_to_cashflow	fund price to cashflow metric
valuation_metrics.price_to_cashflow_category	average price to cashflow metric of funds in the same category
valuation_metrics.median_market_capitalization	median market capitalization of a fund
valuation_metrics.median_market_capitalization_category	median market capitalization of funds in the same category
valuation_metrics.3_year_earnings_growth	earnings growth over the last three years
valuation_metrics.3_year_earnings_growth_category	earnings growth over the last three years of funds in the same category

JSON request example

https://api.twelvedata.com/mutual_funds/world/risk?symbol=0P0001LCQ3&apikey=demo

Ratings

This API request returns ratings of a mutual fund.

HTTP request example

https://api.twelvedata.com/mutual_funds/world/ratings?symbol=0P0001LCQ3&apikey=your_api_key

This request will return JSON with the following structure

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

HTTP route

/mutual_funds/world/ratings

API credits

200 per request

API parameters

Parameter	Details
symbol	• Required parameter • Symbol ticker of mutual fund
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
dp	• Parameter is optional • Number of decimal places for floating values • Accepts value in range `[0,11]`; default `5`
apikey	• Required parameter • Your API key upgraded to the Ultra plan or above

Response

Key	Description
performance_rating	performance rating from 0 to 5
risk_rating	risk rating from 0 to 5
return_rating	return rating from 0 to 5

JSON request example

https://api.twelvedata.com/mutual_funds/world/ratings?symbol=0P0001LCQ3&apikey=demo

CompositionHigh Demand

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

HTTP request example

https://api.twelvedata.com/mutual_funds/world/composition?symbol=0P0001LCQ3&apikey=your_api_key

This request will return JSON with the following structure

{
  "mutual_fund": {
    "composition": {
      "major_market_sectors": [
        {
          "sector": "Industrials",
          "weight": 0.1742
        },
        {
          "sector": "Financial Services",
          "weight": 0.1735
        },
        {
          "sector": "Consumer Cyclical",
          "weight": 0.1461
        },
        {
          "sector": "Technology",
          "weight": 0.1319
        },
        {
          "sector": "Healthcare",
          "weight": 0.1065
        },
        {
          "sector": "Realestate",
          "weight": 0.0916
        },
        {
          "sector": "Energy",
          "weight": 0.0466
        },
        {
          "sector": "Consumer Defensive",
          "weight": 0.0421
        },
        {
          "sector": "Basic Materials",
          "weight": 0.0401
        },
        {
          "sector": "Communication Services",
          "weight": 0.0284
        },
        {
          "sector": "Utilities",
          "weight": 0.019
        }
      ],
      "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
        },
        {
          "symbol": "GKOS",
          "name": "Glaukos Corp",
          "weight": 0.00607
        },
        {
          "symbol": "ALK",
          "name": "Alaska Air Group Inc",
          "weight": 0.00604
        },
        {
          "symbol": "ATI",
          "name": "ATI Inc",
          "weight": 0.00575
        },
        {
          "symbol": "RHI",
          "name": "Robert Half Inc",
          "weight": 0.00525
        },
        {
          "symbol": "VFC",
          "name": "VF Corp",
          "weight": 0.00521
        },
        {
          "symbol": "SPSC",
          "name": "SPS Commerce Inc",
          "weight": 0.00507
        },
        {
          "symbol": "SPXC",
          "name": "SPX Technologies Inc",
          "weight": 0.00495
        },
        {
          "symbol": "JXN",
          "name": "Jackson Financial Inc",
          "weight": 0.00473
        },
        {
          "symbol": "QRVO",
          "name": "Qorvo Inc",
          "weight": 0.00465
        }
      ],
      "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"
}

HTTP route

/mutual_funds/world/composition

API credits

200 per request

API parameters

Parameter	Details
symbol	• Required parameter • Symbol ticker of mutual fund
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
dp	• Parameter is optional • Number of decimal places for floating values • Accepts value in range `[0,11]`; default `5`
apikey	• Required parameter • Your API key upgraded to the Ultra plan or above

Response

Key	Description
major_market_sectors.sector	sector category of a fund exposure
major_market_sectors.weight	weight (%) of a fund exposure in a sector
asset_allocation.cash	percentage of overall portfolio composition in cash
asset_allocation.stocks	percentage of overall portfolio composition in stocks
asset_allocation.preferred_stocks	percentage of overall portfolio composition in preferred stocks
asset_allocation.convertables	percentage of overall portfolio composition in convertable securities
asset_allocation.bonds	percentage of overall portfolio composition in bond
asset_allocation.others	percentage of overall portfolio composition in other forms of holding
top_holdings.symbol	symbol ticker of a holding instrument
top_holdings.name	name of a holding instrument
top_holdings.weight	weight (%) of a holding instrument in overall portfolio composition
bond_breakdown.average_maturity.fund	average maturity of bond holding of a fund
bond_breakdown.average_maturity.category	average maturity of bond holding of funds in the same category
bond_breakdown.average_duration.fund	average duration of bond holding of a fund
bond_breakdown.average_duration.category	average duration of bond holding of funds in the same category
bond_breakdown.credit_quality.grade	rating of bond holding of a fund from AAA to below B
bond_breakdown.credit_quality.weight	weight of bond holding in fund portfolio

JSON request example

https://api.twelvedata.com/mutual_funds/world/composition?symbol=0P0001LCQ3&apikey=demo

Purchase Info

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

HTTP request example

https://api.twelvedata.com/mutual_funds/world/purchase_info?symbol=0P0001LCQ3&apikey=your_api_key

This request will return JSON with the following structure

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

HTTP route

/mutual_funds/world/purchase_info

API credits

200 per request

API parameters

Parameter	Details
symbol	• Required parameter • Symbol ticker of mutual fund
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
dp	• Parameter is optional • Number of decimal places for floating values • Accepts value in range `[0,11]`; default `5`
apikey	• Required parameter • Your API key upgraded to the Ultra plan or above

Response

Key	Description
expenses.expense_ratio_gross	annual cost of investing in a mutual fund
expenses.expense_ratio_net	percentage of mutual fund assets steered toward a fund's operating expenses and fund management fees
minimums.initial_investment	investment minimum
minimums.additional_investment	minimum amount of additional investment
minimums.initial_ira_investment	investment minimum for IRA
minimums.additional_ira_investment	minimum amount of additional investment for IRA
pricing.nav	last price of the fund
pricing.12_month_low	lowest price of the fund over the last year
pricing.12_month_high	highest price of the fund over the last year
pricing.last_month	fund price at the end of the last month
brokerages	list of brokerages where mutual fund can be purchased

JSON request example

https://api.twelvedata.com/mutual_funds/world/purchase_info?symbol=0P0001LCQ3&apikey=demo

Sustainability

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

HTTP request example

https://api.twelvedata.com/mutual_funds/world/sustainability?symbol=0P0001LCQ3&apikey=your_api_key

This request will return JSON with the following structure

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

HTTP route

/mutual_funds/world/sustainability

API credits

200 per request

API parameters

Parameter	Details
symbol	• Required parameter • Symbol ticker of mutual fund
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
dp	• Parameter is optional • Number of decimal places for floating values • Accepts value in range `[0,11]`; default `5`
apikey	• Required parameter • Your API key upgraded to the Ultra plan or above

Response

Key	Description
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.environmental	ESG environmental score
corporate_esg_pillars.social	ESG social score
corporate_esg_pillars.governance	ESG governance score
sustainable_investment	indication that the fund discloses in their prospectus that they employ socially responsible or ESG principles in their investment selection processes
corporate_aum	percentage of AUM used to calculate sustainability score

JSON request example

https://api.twelvedata.com/mutual_funds/world/sustainability?symbol=0P0001LCQ3&apikey=demo

ETFs

ETFs ListUseful

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.

HTTP request example

https://api.twelvedata.com/etfs/list?apikey=your_api_key

This request will return JSON with the following structure

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

HTTP route

/etfs/list

API credits

1 per request

API parameters

Parameter	Details
symbol	• Parameter is optional • Filter by symbol
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
fund_family	• Parameter is optional • Filter by investment company that manages the fund
fund_type	• Parameter is optional • Filter by the type of fund
page	• Parameter is optional • Page number; default `1`
outputsize	• Parameter is optional • Number of records in response; default `50`
apikey	• Required parameter • Your API key at the Basic plan or above

Response

Key	Description
count	total number of matching funds
symbol	fund symbol ticker
name	fund name
country	country of fund incorporation
mic_code	market identifier code (MIC) under ISO 10383 standard
fund_family	investment company that manages the fund
fund_type	type of fund

JSON request example

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

https://api.twelvedata.com/etfs/list?fund_family=Vanguard&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/etfs/list?format=CSV&apikey=demo

ETFs Family List

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

HTTP request example

https://api.twelvedata.com/etfs/family?apikey=your_api_key

This request will return JSON with the following structure

{
  "result": {
    "India": [
      "Aberdeen Standard Fund Managers Limited",
      "Aditya Birla Sun Life AMC Ltd",
      "Aditya Birla Sun Life Insurance Company Limited",
      "Aegon Life Insurance Company Ltd.",
      "Aviva Life Insur Co. India Pvt. Ltd.",
      "Axis Asset Management Company Limited",
      "Bajaj Allianz Life Insurance Company Ltd",
      "Baring International Fund Mgrs (Ireland) Limited",
      "Baroda Asset Management India Limited"
    ],
    "United States": [
      "Aegon Asset Management UK PLC",
      "Ampega Investment GmbH",
      "Aviva SpA",
      "BBVA Asset Management SA SGIIC",
      "Caser Pensiones EGFP",
      "HSBC Investment Funds (HK) Limited",
      "Premier Portfolio Managers Limited",
      "SEI Investments Global Limited",
      "Vanguard"
    ]
  },
  "status": "ok"
}

HTTP route

/etfs/family

API credits

1 per request

API parameters

Parameter	Details
country	• Parameter is optional • Filter by country name or alpha code
fund_family	• Parameter is optional • Filter by investment company that manages the fund
apikey	• Required parameter • Your API key at the Basic plan or above

Response

Key	Description
result	all available fund families segmented by country

JSON request example

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

https://api.twelvedata.com/etfs/family?country=US&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/etfs/family?format=CSV&apikey=demo

ETFs Type List

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

HTTP request example

https://api.twelvedata.com/etfs/type?apikey=your_api_key

This request will return JSON with the following structure

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

HTTP route

/etfs/type

API credits

1 per request

API parameters

Parameter	Details
country	• Parameter is optional • Filter by country name or alpha code
fund_type	• Parameter is optional • Filter by the type of fund
apikey	• Required parameter • Your API key at the Basic plan or above

Response

Key	Description
result	all available fund types segmented by country

JSON request example

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

https://api.twelvedata.com/etfs/type?country=US&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/etfs/type?format=CSV&apikey=demo

All dataHigh Demand

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

HTTP request example

https://api.twelvedata.com/etfs/world?symbol=IVV&apikey=your_api_key

This request will return JSON with the following structure

{
  "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 Index that measures the investment return of large-capitalization stocks.  The fund employs an indexing investment approach designed to track the performance of the Standard & Poor&#39;s 500 Index, a widely recognized benchmark of U.S. stock market performance that is dominated by the stocks of large U.S. companies. The advisor attempts to replicate the target index by investing all, or substantially all, of its assets in the stocks that make up the index, holding each stock in approximately the same proportion as its weighting in the index."
    },
    "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": null
        }
      ]
    },
    "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
        },
        {
          "country": "India",
          "allocation": 0.0045
        }
      ],
      "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"
}

HTTP route

/etfs/world

API credits

800 per request

API parameters

Parameter	Details
symbol	• Required parameter • Symbol ticker of etf
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
dp	• Parameter is optional • Number of decimal places for floating values • Accepts value in range `[0,11]`; default `5`
apikey	• Required parameter • Your API key upgraded to the Ultra plan or above

Response

Key	Description
symbol	all available fund types segmented by country
name	fund name
fund_family	investment company that manages the fund
fund_type	type of the fund
currency	currency of fund price
share_class_inception_date	the date from which the fund started operations and the returns are calculated
ytd_return	percentage of profit of the fund since the first trading day of the current calendar year
expense_ratio_net	percentage of etf assets steered toward a fund's operating expenses and fund management fees
yield	income returned to its investors through interest and dividends generated by the fund's investments
nav	last price of the fund
last_price	last price of the fund
min_investment	investment minimum
turnover_rate	percentage rate at which etf replaces its holdings on investment every year
net_assets	total assets of a fund minus its total liabilities
overview	description of the fund
people.name	manager name
people.tenure_since	manager tenuring date
trailing_returns.period	period of trailing returns
trailing_returns.share_class_return	fund returns (%) generated over a given period
trailing_returns.category_return	same category average returns (%) generated over a given period
annual_total_returns.year	year of total returns
annual_total_returns.share_class_return	fund total returns (%) generated over a given year
annual_total_returns.category_return	same category average total returns (%) generated over a given year
volatility_measures.period	period of a measure
volatility_measures.alpha	alpha score of a fund
volatility_measures.alpha_category	average alpha score of a fund's category
volatility_measures.beta	beta score of a fund
volatility_measures.beta_category	average beta score of a fund's category
volatility_measures.mean_annual	mean annual return of a fund
volatility_measures.mean_annual_category	average mean annual return of a fund's category
volatility_measures.r_squared	r-squared metric of a fund
volatility_measures.r_squared_category	average r-squared metric of a fund's category
volatility_measures.std	standard deviation of a fund
volatility_measures.std_category	average standard deviation of a fund's category
volatility_measures.sharpe_ratio	sharpe ratio of a fund
volatility_measures.sharpe_ratio_category	average sharpe ratio of a fund's category
volatility_measures.treynor_ratio	treynor ratio of a fund
volatility_measures.treynor_ratio_category	average treynor ratio of a fund's category
valuation_metrics.price_to_earnings	fund price to earnings metric
valuation_metrics.price_to_earnings_category	average price to earnings metric of funds in the same category
valuation_metrics.price_to_book	fund price to book metric
valuation_metrics.price_to_book_category	average price to book metric of funds in the same category
valuation_metrics.price_to_sales	fund price to sales metric
valuation_metrics.price_to_sales_category	average price to sales metric of funds in the same category
valuation_metrics.price_to_cashflow	fund price to cashflow metric
valuation_metrics.price_to_cashflow_category	average price to cashflow metric of funds in the same category
valuation_metrics.median_market_capitalization	median market capitalization of a fund
valuation_metrics.median_market_capitalization_category	median market capitalization of funds in the same category
valuation_metrics.3_year_earnings_growth	earnings growth over the last three years
valuation_metrics.3_year_earnings_growth_category	earnings growth over the last three years of funds in the same category
major_market_sectors.sector	sector category of a fund exposure
major_market_sectors.weight	weight (%) of a fund exposure in a sector
country_allocation.country	country name
country_allocation.allocation	percentages of a fund's net assets distributed to securities of the country
asset_allocation.cash	percentage of overall portfolio composition in cash
asset_allocation.stocks	percentage of overall portfolio composition in stocks
asset_allocation.preferred_stocks	percentage of overall portfolio composition in preferred stocks
asset_allocation.convertables	percentage of overall portfolio composition in convertable securities
asset_allocation.bonds	percentage of overall portfolio composition in bond
asset_allocation.others	percentage of overall portfolio composition in other forms of holding
top_holdings.symbol	symbol ticker of a holding instrument
top_holdings.name	name of a holding instrument
top_holdings.weight	weight (%) of a holding instrument in overall portfolio composition
bond_breakdown.average_maturity.fund	average maturity of bond holding of a fund
bond_breakdown.average_maturity.category	average maturity of bond holding of funds in the same category
bond_breakdown.average_duration.fund	average duration of bond holding of a fund
bond_breakdown.average_duration.category	average duration of bond holding of funds in the same category
bond_breakdown.credit_quality.grade	rating of bond holding of a fund from AAA to below B
bond_breakdown.credit_quality.weight	weight of bond holding in fund portfolio

JSON request example

https://api.twelvedata.com/etfs/world?symbol=QQQ&apikey=demo

Summary

This API request returns a brief summary of a etf.

HTTP request example

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

This request will return JSON with the following structure

{
  "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 Index that measures the investment return of large-capitalization stocks.  The fund employs an indexing investment approach designed to track the performance of the Standard & Poor&#39;s 500 Index, a widely recognized benchmark of U.S. stock market performance that is dominated by the stocks of large U.S. companies. The advisor attempts to replicate the target index by investing all, or substantially all, of its assets in the stocks that make up the index, holding each stock in approximately the same proportion as its weighting in the index."
    }
  },
  "status": "ok"
}

HTTP route

/etfs/world/summary

API credits

200 per request

API parameters

Parameter	Details
symbol	• Required parameter • Symbol ticker of etf
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
dp	• Parameter is optional • Number of decimal places for floating values • Accepts value in range `[0,11]`; default `5`
apikey	• Required parameter • Your API key upgraded to the Ultra plan or above

Response

Key	Description
symbol	all available fund types segmented by country
name	fund name
fund_family	investment company that manages the fund
fund_type	type of the fund
currency	currency of fund price
share_class_inception_date	the date from which the fund started operations and the returns are calculated
ytd_return	percentage of profit of the fund since the first trading day of the current calendar year
expense_ratio_net	percentage of etf assets steered toward a fund's operating expenses and fund management fees
yield	income returned to its investors through interest and dividends generated by the fund's investments
nav	last price of the fund
last_price	last price of the fund
min_investment	investment minimum
turnover_rate	percentage rate at which etf replaces its holdings on investment every year
net_assets	total assets of a fund minus its total liabilities
overview	description of the fund
people.name	manager name
people.tenure_since	manager tenuring date

JSON request example

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

PerformanceHigh Demand

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

HTTP request example

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

This request will return JSON with the following structure

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

HTTP route

/etfs/world/performance

API credits

200 per request

API parameters

Parameter	Details
symbol	• Required parameter • Symbol ticker of etf
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
dp	• Parameter is optional • Number of decimal places for floating values • Accepts value in range `[0,11]`; default `5`
apikey	• Required parameter • Your API key upgraded to the Ultra plan or above

Response

Key	Description
trailing_returns.period	period of trailing returns
trailing_returns.share_class_return	fund returns (%) generated over a given period
trailing_returns.category_return	same category average returns (%) generated over a given period
annual_total_returns.year	year of total returns
annual_total_returns.share_class_return	fund total returns (%) generated over a given year
annual_total_returns.category_return	same category average total returns (%) generated over a given year

JSON request example

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

Risk

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

HTTP request example

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

This request will return JSON with the following structure

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

HTTP route

/etfs/world/risk

API credits

200 per request

API parameters

Parameter	Details
symbol	• Required parameter • Symbol ticker of etf
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
dp	• Parameter is optional • Number of decimal places for floating values • Accepts value in range `[0,11]`; default `5`
apikey	• Required parameter • Your API key upgraded to the Ultra plan or above

Response

Key	Description
volatility_measures.period	period of a measure
volatility_measures.alpha	alpha score of a fund
volatility_measures.alpha_category	average alpha score of a fund's category
volatility_measures.beta	beta score of a fund
volatility_measures.beta_category	average beta score of a fund's category
volatility_measures.mean_annual	mean annual return of a fund
volatility_measures.mean_annual_category	average mean annual return of a fund's category
volatility_measures.r_squared	r-squared metric of a fund
volatility_measures.r_squared_category	average r-squared metric of a fund's category
volatility_measures.std	standard deviation of a fund
volatility_measures.std_category	average standard deviation of a fund's category
volatility_measures.sharpe_ratio	sharpe ratio of a fund
volatility_measures.sharpe_ratio_category	average sharpe ratio of a fund's category
volatility_measures.treynor_ratio	treynor ratio of a fund
volatility_measures.treynor_ratio_category	average treynor ratio of a fund's category
valuation_metrics.price_to_earnings	fund price to earnings metric
valuation_metrics.price_to_earnings_category	average price to earnings metric of funds in the same category
valuation_metrics.price_to_book	fund price to book metric
valuation_metrics.price_to_book_category	average price to book metric of funds in the same category
valuation_metrics.price_to_sales	fund price to sales metric
valuation_metrics.price_to_sales_category	average price to sales metric of funds in the same category
valuation_metrics.price_to_cashflow	fund price to cashflow metric
valuation_metrics.price_to_cashflow_category	average price to cashflow metric of funds in the same category
valuation_metrics.median_market_capitalization	median market capitalization of a fund
valuation_metrics.median_market_capitalization_category	median market capitalization of funds in the same category
valuation_metrics.3_year_earnings_growth	earnings growth over the last three years
valuation_metrics.3_year_earnings_growth_category	earnings growth over the last three years of funds in the same category

JSON request example

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

CompositionHigh Demand

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

HTTP request example

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

This request will return JSON with the following structure

{
  "etf": {
    "composition": {
      "major_market_sectors": [
        {
          "sector": "Technology",
          "weight": 0.2424
        }
      ],
      "country_allocation": [
        {
          "country": "United Kingdom",
          "allocation": 0.9855
        },
        {
          "country": "India",
          "allocation": 0.0045
        }
      ],
      "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"
}

HTTP route

/etfs/world/composition

API credits

200 per request

API parameters

Parameter	Details
symbol	• Required parameter • Symbol ticker of etf
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
dp	• Parameter is optional • Number of decimal places for floating values • Accepts value in range `[0,11]`; default `5`
apikey	• Required parameter • Your API key upgraded to the Ultra plan or above

Response

Key	Description
major_market_sectors.sector	sector category of a fund exposure
major_market_sectors.weight	weight (%) of a fund exposure in a sector
country_allocation.country	country name
country_allocation.allocation	percentages of a fund's net assets distributed to securities of the country
asset_allocation.cash	percentage of overall portfolio composition in cash
asset_allocation.stocks	percentage of overall portfolio composition in stocks
asset_allocation.preferred_stocks	percentage of overall portfolio composition in preferred stocks
asset_allocation.convertables	percentage of overall portfolio composition in convertable securities
asset_allocation.bonds	percentage of overall portfolio composition in bond
asset_allocation.others	percentage of overall portfolio composition in other forms of holding
top_holdings.symbol	symbol ticker of a holding instrument
top_holdings.name	name of a holding instrument
top_holdings.weight	weight (%) of a holding instrument in overall portfolio composition
bond_breakdown.average_maturity.fund	average maturity of bond holding of a fund
bond_breakdown.average_maturity.category	average maturity of bond holding of funds in the same category
bond_breakdown.average_duration.fund	average duration of bond holding of a fund
bond_breakdown.average_duration.category	average duration of bond holding of funds in the same category
bond_breakdown.credit_quality.grade	rating of bond holding of a fund from AAA to below B
bond_breakdown.credit_quality.weight	weight of bond holding in fund portfolio

JSON request example

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

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

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

HTTP request example

https://api.twelvedata.com/logo?symbol=AAPL&apikey=your_api_key

https://api.twelvedata.com/logo?symbol=BTC/USD&apikey=your_api_key

https://api.twelvedata.com/logo?symbol=EUR/USD&apikey=your_api_key

This request will return JSON with the following structure

// Equity
{
  "meta": {
    "symbol": "AAPL",
    "name": "Apple Inc",
    "currency": "USD",
    "exchange": "NASDAQ",
    "mic_code": "XNAS",
    "exchange_timezone": "America/New_York"
  },
  "url": "https://api.twelvedata.com/logo/apple.com"
}

// Crypto
{
  "meta": {
    "symbol": "BTC/USD",
  },
  "logo_base": "https://logo.twelvedata.com/crypto/btc.png",
  "logo_quote": "https://logo.twelvedata.com/crypto/usd.png"
}

// Forex
{
  "meta": {
    "symbol": "EUR/USD"
  },
  "logo_base": "https://logo.twelvedata.com/forex/eur.png",
  "logo_quote": "https://logo.twelvedata.com/forex/usd.png"
}

HTTP route

/logo

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
apikey	string	• Required parameter • Your API key, which you can obtain for free here

Response

Key	Type	Description
url	string	link to download the logo

JSON request example

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

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

https://api.twelvedata.com/logo?symbol=EUR/USD&apikey=demo

ProfileUseful

Returns general information about the company.

HTTP request example

https://api.twelvedata.com/profile?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

{
  "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 accessories worldwide. It also sells various related services. The company offers iPhone, a line of smartphones; Mac, a line of personal computers; iPad, a line of multi-purpose tablets; and wearables, home, and accessories comprising AirPods, Apple TV, Apple Watch, Beats products, HomePod, iPod touch, and other Apple-branded and third-party accessories. It also provides AppleCare support services; cloud services store services; and operates various platforms, including the App Store, that allow customers to discover and download applications and digital content, such as books, music, video, games, and podcasts. In addition, the company offers various services, such as Apple Arcade, a game subscription service; Apple Music, which offers users a curated listening experience with on-demand radio stations; Apple News+, a subscription news and magazine service; Apple TV+, which offers exclusive original content; Apple Card, a co-branded credit card; and Apple Pay, a cashless payment service, as well as licenses its intellectual property. The company serves consumers, and small and mid-sized businesses; and the education, enterprise, and government markets. It sells and delivers third-party applications for its products through the App Store. The company also sells its products through its retail and online stores, and direct sales force; and third-party cellular network carriers, wholesalers, retailers, and resellers. Apple Inc. was founded in 1977 and is headquartered in Cupertino, California.",
  "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"
}

HTTP route

/profile

API credits

10 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of instrument • For preffered stocks use dot(.) delimiter E.g. `BRK.A` or `BRK.B` will be correct
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
apikey	string	• Required parameter • Your API key upgraded to the Grow plan or above, which can be obtained here

Response

Key	Type	Description
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	number	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

JSON request example

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

Dividends

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

HTTP request example

https://api.twelvedata.com/dividends?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

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

HTTP route

/dividends

API credits

20 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of instrument • For preffered stocks use dot(.) delimiter E.g. `BRK.A` or `BRK.B` will be correct
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
range	string	• Parameter is optional `last` - the last dividend - default `1m` - one month `3m` - three months `6m` - six months `ytd` - year-to-date `1y` - one year `2y` - two years `5y` - 5 years `full` - complete history
start_date	string	• Parameter is optional • Format `2006-01-02`
end_date	string	• Parameter is optional • Format `2006-01-02`
adjust	string	• Parameter is optional • Specifies if there should be an adjustment • Default `true`
apikey	string	• Required parameter • Your API key upgraded to the Grow plan or above, which can be obtained here

Response

Key	Type	Description
ex_date	string	Stands for the ex date
amount	number	Stands for the payment amount

JSON request example

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

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.

HTTP request example

https://api.twelvedata.com/dividends_calendar?apikey=your_api_key

This request will return JSON with the following structure

[
    {
        "symbol": "MSFT",
        "mic_code": "XNGS",
        "exchange": "NASDAQ",
        "amount": 0.75,
        "ex_date": "2024-02-14"
    },
    {
        "symbol": "AAPL",
        "mic_code": "XNGS",
        "exchange": "NASDAQ",
        "amount": 0.24,
        "ex_date": "2024-02-09"
    },
    {
        "symbol": "MSFT",
        "mic_code": "XNGS",
        "exchange": "NASDAQ",
        "amount": 0.75,
        "ex_date": "2023-11-15"
    },
    {
        "symbol": "AAPL",
        "mic_code": "XNGS",
        "exchange": "NASDAQ",
        "amount": 0.24,
        "ex_date": "2023-11-10"
    },
]

HTTP route

/dividends_calendar

API credits

40 per symbol

API parameters

Key	Type	Description
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
start_date	string	• Parameter is optional • Format `2006-01-02`
end_date	string	• Parameter is optional • Format `2006-01-02`
outputsize	number	• Parameter is optional • Number of data points to retrieve • Supports values in the range from `1` to `500` • Default `100` when no date parameters are set, otherwise set to maximum
page	string	• Parameter is optional • Page number; default `1`
apikey	string	• Required parameter • Your API key upgraded to the Grow plan or above, which can be obtained here

Response

Key	Type	Description
symbol	string	Ticker of the company
mic_code	string	Market Identifier Code (MIC) under ISO 10383 standard
exchange	string	Exchange name where the company is listed
ex_date	string	Stands for the ex date
amount	number	Stands for the payment amount

JSON request example

https://api.twelvedata.com/dividends_calendar?apikey=your_api_key

Splits

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

HTTP request example

https://api.twelvedata.com/splits?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

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

HTTP route

/splits

API credits

20 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of instrument • For preffered stocks use dot(.) delimiter E.g. `BRK.A` or `BRK.B` will be correct
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
range	string	• Parameter is optional `last` - the last split - default `1m` - one month `3m` - three months `6m` - six months `ytd` - year-to-date `1y` - one year `2y` - two years `5y` - 5 years `full` - complete history
start_date	string	• Parameter is optional • Format `2006-01-02`
end_date	string	• Parameter is optional • Format `2006-01-02`
apikey	string	• Required parameter • Your API key upgraded to the Grow plan or above, which can be obtained here

Response

Key	Type	Description
date	string	Stands for the split date
description	string	Specification of the split event
ratio	number	The ratio by which the number of a company's outstanding shares of stock are increased following a stock split. For example, a 4-for-1 split results in four times as many outstanding shares, with each share selling at one forth of its pre-split price
from_factor	number	To factor of the split
to_factor	number	From factor of the split

JSON request example

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

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.

HTTP request example

https://api.twelvedata.com/splits_calendar?apikey=your_api_key

This request will return JSON with the following structure

[
  {
    "date": "2024-04-23",
    "symbol": "AAPL",
    "mic_code": "XNGS",
    "exchange": "NASDAQ",
    "description": "1-for-1 split",
    "ratio": 1,
    "from_factor": 1,
    "to_factor": 1
  },
  {
    "date": "2024-02-23",
    "symbol": "LYT",
    "mic_code": "XNCM",
    "exchange": "NASDAQ",
    "description": "1-for-60 split",
    "ratio": 60,
    "from_factor": 1,
    "to_factor": 60
  },
  {
    "date": "2024-02-21",
    "symbol": "HAUS",
    "mic_code": "BATS",
    "exchange": "CBOE",
    "description": "1-for-10 split",
    "ratio": 10,
    "from_factor": 1,
    "to_factor": 10
  },
  {
    "date": "2024-02-21",
    "symbol": "TRBA",
    "mic_code": "XSTU",
    "exchange": "XSTU",
    "description": "1-for-5 split",
    "ratio": 5,
    "from_factor": 1,
    "to_factor": 5
  }
]

HTTP route

/splits_calendar

API credits

40 per symbol

API parameters

Key	Type	Description
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
start_date	string	• Parameter is optional • Format `2006-01-02`
end_date	string	• Parameter is optional • Format `2006-01-02`
outputsize	number	• Parameter is optional • Number of data points to retrieve • Supports values in the range from `1` to `500` • Default `100` when no date parameters are set, otherwise set to maximum
page	string	• Parameter is optional • Page number; default `1`
apikey	string	• Required parameter • Your API key upgraded to the Grow plan or above, which can be obtained here

Response

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

JSON request example

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

Earnings

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

HTTP request example

https://api.twelvedata.com/earnings?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

{
  "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
    },
    {
       "date": "2020-01-28",
       "time": "After Hours",
       "eps_estimate": 4.54,
       "eps_actual": 4.99,
       "difference": 0.45,
       "surprise_prc": 9.91
    },
    {
       "date": "2019-10-30",
       "time": "After Hours",
       "eps_estimate": 2.84,
       "eps_actual": 3.03,
       "difference": 0.19,
       "surprise_prc": 6.69
    },
    {
       "date": "2010-07-30",
       "time": "After Hours",
       "eps_estimate": 2.10,
       "eps_actual": 2.18,
       "difference": 0.08,
       "surprise_prc": 3.81
    },
    {
       "date": "2019-04-30",
       "time": "After Hours",
       "eps_estimate": 2.37,
       "eps_actual": 2.46,
       "difference": 0.09,
       "surprise_prc": 3.8
    },
    {...}
  ],
  "status":"ok"
}

HTTP route

/earnings

API credits

20 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of instrument • For preffered stocks use dot(.) delimiter E.g. `BRK.A` or `BRK.B` will be correct
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
type	string	• Parameter is optional • 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`, and `Warrant`
period	string	• Parameter is optional • Type of earning, returns only 1 record • When is not empty, dates and outputsize parameters are ignored • Accepts: `latest` and `next`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key upgraded to the Grow plan or above, which can be obtained here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `2`
start_date end_date	string	• Parameters are optional • Can be used separately and together • Format `2006-01-02` or `2006-01-02 15:04:05`

Response

Key	Description
date	date of earning release
time	can be either of the following values: `Pre Market`, `After Hours`, `Time Not Supplied`
eps_estimate	analyst estimate of the future company earning
eps_actual	actual value of reported earning
difference	delta between `eps_actual` and `eps_estimate`
surprise_prc	surprise in the percentage of the `eps_actual` related to `eps_estimate`

JSON request example

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

Downloadable CSV example

https://api.twelvedata.com/earnings?symbol=AAPL&apikey=demo&format=CSV

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.

HTTP request example

https://api.twelvedata.com/earnings_calendar?apikey=your_api_key

This request will return JSON with the following structure

{
    "earnings":{
        "2020-05-08":[
            {...},
            {
                "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
            },
            {
                "symbol": "LPL",
                "name": "LG Display Co Ltd",
                "currency": "USD",
                "exchange": "NYSE",
                "mic_code": "XNYS",
                "country": "United States",
                "time": "Time Not Supplied",
                "eps_estimate": -0.45,
                "eps_actual": -0.23,
                "difference": 0.22,
                "surprise_prc": 48.22
            },
            {...}
        ],
        "2020-05-07":[
            {...},
            {
                "symbol": "AAON",
                "name": "AAON Inc",
                "currency": "USD",
                "exchange": "NASDAQ",
                "mic_code": "XNAS",
                "country": "United States",
                "time": "Time Not Supplied",
                "eps_estimate": 0.35,
                "eps_actual": 0.41,
                "difference": 0.06,
                "surprise_prc": 17.14
            },
            {
                "symbol": "JOBS",
                "name": "51job Inc",
                "currency": "USD",
                "exchange": "NASDAQ",
                "mic_code": "XNAS",
                "country": "United States",
                "time": "Time Not Supplied",
                "eps_estimate": 2.44,
                "eps_actual": 3.27,
                "difference": 0.83,
                "surprise_prc": 34.02
            },
            {...}
        ],
        {...}
    },
    "status":"ok"
}

HTTP route

/earnings_calendar

API credits

40 per request

API parameters

Key	Type	Description
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key upgraded to the Grow plan or above, which can be obtained here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `2`
start_date end_date	string	• Parameters are optional • Can be used separately and together • Format `2006-01-02` or `2006-01-02 15:04:05`

Response

Key	Description
symbol	instrument symbol (ticker)
name	full name of instrument
currency	currency in which instrument is traded by ISO 4217 standard
exchange	exchange where instrument is traded
mic_code	market identifier code (MIC) under ISO 10383 standard
country	country where exchange is located
time	can be either of the following values: `Pre Market`, `After Hours`, `Time Not Supplied`
eps_estimate	analyst estimate of the future company earning
eps_actual	actual value of reported earning
difference	delta between `eps_actual` and `eps_estimate`
surprise_prc	surprise in percentage of the `eps_actual` related to `eps_estimate`

JSON request example

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

Downloadable CSV example

https://api.twelvedata.com/earnings_calendar?apikey=demo&format=CSV

IPO Calendar

This endpoint returns past, today, or upcoming IPOs.

HTTP request example

https://api.twelvedata.com/ipo_calendar?apikey=your_api_key

This request will return JSON with the following structure

{
  "2021-09-03": [
    {
      "symbol": "DWACU",
      "name": "Digital World Acquisition Corp.",
      "exchange": "NASDAQ",
      "mic_code": "XNAS",
      "price_range_low": 10,
      "price_range_high": 10,
      "offer_price": null,
      "currency": "USD",
      "shares": null
    },
    {
      "symbol": "9869",
      "name": "Helens Intl Hldg Co Ltd",
      "exchange": "HKEX",
      "mic_code": "XHKG",
      "price_range_low": null,
      "price_range_high": null,
      "offer_price": null,
      "currency": "HKD",
      "shares": null
    },
    {
      "symbol": "BMR",
      "name": "Ballymore Resources Ltd",
      "exchange": "ASX",
      "mic_code": "XASX",
      "price_range_low": 0.1548,
      "price_range_high": 0.1548,
      "offer_price": 0.2,
      "currency": "AUD",
      "shares": null
    }
  ]
}

HTTP route

/ipo_calendar

API credits

40 per request

API parameters

Key	Type	Description
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
start_date	string	• Parameter is optional • Format `2006-01-02`
end_date	string	• Parameter is optional • Format `2006-01-02`
apikey	string	• Required parameter • Your API key upgraded to the Grow plan or above, which can be obtained here

Response

Key	Type	Description
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
price_range_low	number	The lower bound of stock price range if available
price_range_high	number	The upper bound of stock price range if available
offer_price	number	Initial offer price if available
currency	string	Currency of the stock
shares	number	Number of shares, if available

JSON request example

https://api.twelvedata.com/ipo_calendar?apikey=your_api_key

StatisticsHigh Demand

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

HTTP request example

https://api.twelvedata.com/statistics?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

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

HTTP route

/statistics

API credits

50 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of instrument • For preffered stocks use dot(.) delimiter E.g. `BRK.A` or `BRK.B` will be correct
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
apikey	string	• Required parameter • Your API key upgraded to the Pro plan or above, which can be obtained here

Response

Key	Type	Description
name	string	Name of the company
market_capitalization	number	Refers to the market value of the company's outstanding shares
enterprise_value	number	Refers to enterprise value (EV) of the company, often used as a more comprehensive alternative to market capitalization
trailing_pe	number	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	number	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	number	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	number	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	number	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	number	The enterprise value-to-revenue multiple (EV/R) is a measure that compares enterprise value to revenue
enterprise_to_ebitda	number	The enterprise value-to-ebitda multiple (EV/EBITDA) is a measure that compares enterprise value to EBITDA
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	number	The portion of a company's revenue left over after direct costs are subtracted
profit_margin	number	Refers to gross profit margin. Calculated by dividing net income by sales revenue
operating_margin	number	Operating margin is calculated by dividing operating income by net sales
return_on_assets_ttm	number	Return on assets (ROA) is calculated by dividing net income by total assets
return_on_equity_ttm	number	Return on equity (ROE) is calculated by dividing net income by average shareholders' equity
revenue_ttm	number	Refers to total revenue over the last 12 months
revenue_per_share_ttm	number	Refers to revenue per share over the last 12 months
quarterly_revenue_growth	number	Refers to quarterly revenue growth year over year
gross_profit_ttm	number	Refers to gross profit over the last 12 months
ebitda	number	Refers to EBITDA (earnings before interest, taxes, depreciation, and amortization) measure; EBITDA is not calculated for banks.
net_income_to_common_ttm	number	Refers to net income applicable to common shares over the last 12 months
diluted_eps_ttm	number	Refers to diluted EPS measure over the last 12 months
quarterly_earnings_growth_yoy	number	Refers to quarterly earnings growth year over year
total_cash_mrq	number	Refers to total cash measure for the most recent quarter
total_cash_per_share_mrq	number	Refers to total cash per share measure for the most recent quarter
total_debt_mrq	number	Refers to total debt measure for the most recent quarter
total_debt_to_equity_mrq	number	Refers to total debt to equity measure for the most recent quarter
current_ratio_mrq	number	Refers to current ratio (total assets / total liabilities) ratio for the most recent quarter
book_value_per_share_mrq	number	Refers to book value per share (BVPS) ratio for the most recent quarter
operating_cash_flow_ttm	number	Refers to operating cash flow measure over the last 12 months
levered_free_cash_flow_ttm	number	Refers to levered free cash flow measure over the last 12 months
shares_outstanding	number	Refers for the shares outstanding currently held by all its shareholders
float_shares	number	Refers to floating stock is the number of public shares a company has available for trading on the open market
avg_10_volume	number	Refers to the average 10 days volume
avg_90_volume	number	Refers to the average 90 days volume
shares_short	number	Refers to the number of shares that have been shorted
short_ratio	number	Refers to short ratio measure
short_percent_of_shares_outstanding	number	Refers to the number of shorted shares divided by the number of shares outstanding
percent_held_by_insiders	number	Refers to the percentage of shares held by the company insiders
percent_held_by_institutions	number	Refers to the percentage of shares held by the institutions
fifty_two_week_low	number	Refers to the lowest price at which stock traded during a year
fifty_two_week_high	number	Refers to the highest price at which stock traded during a year
fifty_two_week_change	number	Refers to the change between lowest and highest prices during a year
beta	number	Refers to beta measure relative to the primary benchmark (index) of the country
day_50_ma	number	Refers to the 50-day simple moving average
day_200_ma	number	Refers to the 200-day simple moving average
forward_annual_dividend_rate	number	Refers to the forward dividend yield estimation in the currency of instrument
forward_annual_dividend_yield	number	Refers to the forward dividend yield percentage relative to stock price
trailing_annual_dividend_rate	number	Refers to the trailing dividend yield rate in the currency of instrument over the last 12 months
trailing_annual_dividend_yield	number	Refers to the trailing dividend yield percentage relative to stock price
5_year_average_dividend_yield	number	Refers to the average 5 years dividend yield
payout_ratio	number	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	number	Refers to the last dividend payout date
ex_dividend_date	number	Refers to the last ex-dividend payout date
last_split_factor	number	Specification of the last split event
last_split_date	number	Refers for the last split date

JSON request example

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

Income StatementHigh Demand

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

HTTP request example

https://api.twelvedata.com/income_statement?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

{
  "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": null
      },
      "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,
      "ebitda": 44632000000,
      "net_income_continuous_operations": null,
      "minority_interests": null,
      "preferred_stock_dividends": null
    }
  ]
}

HTTP route

/income_statement

API credits

100 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of instrument • For preffered stocks use dot(.) delimiter E.g. `BRK.A` or `BRK.B` will be correct
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
period	string	• Parameter is optional • Values should be `annual` or `quarterly`
start_date	string	• Parameter is optional • Format `2006-01-02`
end_date	string	• Parameter is optional • Format `2006-01-02`
outputsize	string	• Parameter is optional • Number of records in response; default `6`
apikey	string	• Required parameter • Your API key upgraded to the Pro plan or above, which can be obtained here

Response

Key	Type	Description
fiscal_date	string	Date of the income statement release
quarter	number	Fiscal quarter. Visible when `&period=quarterly`
year	number	Fiscal year. Visible when `&period=quarterly`
sales	number	Refers to total reported revenue
cost_of_goods	number	Refers to cost of revenue
gross_profit	number	Refers to net gross profit: `sales` - `cost_of_goods`
research_and_development	number	Refers to research & development (R&D) expenses
selling_general_and_administrative	number	Refers to selling, general and administrative (SG&A) expenses
other_operating_expenses	number	Refers to other operating expenses
operating_income	number	Refers to net operating income: `gross_profit` - `research_and_development` - `selling_general_and_administrative`
income	number	Refers to non-operating interest income
expense	number	Refers to non-operating interest expense
other_income_expense	number	Refers to other incomes or expenses
pretax_income	number	Refers to earnings before tax: `operating_income` + `net_non_operating_interest` - `other_income_expense`
income_tax	number	Refers to a tax provision
net_income	number	Refers to net income: `pretax_income` - `income_tax`
eps_basic	number	Refers to earnings per share (EPS)
eps_diluted	number	Refers to diluted earnings per share (EPS)
basic_shares_outstanding	number	Refers for the shares outstanding held by all its shareholders
diluted_shares_outstanding	number	Refers to the total number of shares a company would have if all dilutive securities were exercised and converted into shares
ebitda	number	Refers to EBITDA (earnings before interest, taxes, depreciation, and amortization) measure
net_income_continuous_operations	number	Refers to the after-tax earnings that a business has generated from its operational activities
minority_interests	number	Refers to amount of minority interests paid out
preferred_stock_dividends	number	Refers to dividend that is allocated to and paid on a company's preferred shares

JSON request example

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

Income Statement Consolidated

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

HTTP request example

https://api.twelvedata.com/income_statement/consolidated?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

{
  "income_statement": [
    {
      "fiscal_date": "2023-09-30",
      "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"
}

HTTP route

/income_statement/consolidated

API credits

100 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of instrument • For preffered stocks use dot(.) delimiter E.g. `BRK.A` or `BRK.B` will be correct
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
period	string	• Parameter is optional • Values should be `annual` or `quarterly`
start_date	string	• Parameter is optional • Format `2006-01-02`
end_date	string	• Parameter is optional • Format `2006-01-02`
outputsize	string	• Parameter is optional • Number of records in response; default `6`
apikey	string	• Required parameter • Your API key upgraded to the Pro plan or above, which can be obtained here

Response

Click to expand

Key	Type	Description
fiscal_date	string	Date of the income statement release
total_revenue	number	Total revenue
operating_revenue	number	Operating revenue
gross_profit_value	number	Gross profit value
cost_of_revenue_value	number	Cost of revenue value
excise_taxes	number	Excise taxes
reconciled_cost_of_revenue	number	Reconciled cost of revenue
operating_income_value	number	Operating income value
total_operating_income_as_reported	number	Total operating income as reported
operating_expense	number	Operating expense
other_operating_expenses	number	Other operating expenses
total_expenses	number	Total expenses
net_income_value	number	Net income value
net_income_common_stockholders	number	Net income common stockholders
net_income_including_noncontrolling_interests	number	Net income including noncontrolling interests
net_income_from_tax_loss_carryforward	number	Net income from tax loss carryforward
net_income_extraordinary	number	Net income extraordinary
net_income_discontinuous_operations	number	Net income discontinuous operations
net_income_continuous_operations	number	Net income continuous operations
net_income_from_continuing_operation_net_minority_interest	number	Net income from continuing operation net minority interest
net_income_from_continuing_and_discontinued_operation	number	Net income from continuing and discontinued operation
normalized_income	number	Normalized income
minority_interests	number	Minority interests
diluted_eps	number	Diluted eps
basic_eps	number	Basic eps
continuing_and_discontinued_diluted_eps	number	Continuing and discontinued diluted eps
continuing_and_discontinued_basic_eps	number	Continuing and discontinued basic eps
normalized_diluted_eps	number	Normalized diluted eps
normalized_basic_eps	number	Normalized basic eps
reported_normalized_diluted_eps	number	Reported normalized diluted eps
reported_normalized_basic_eps	number	Reported normalized basic eps
diluted_eps_other_gains_losses	number	Diluted eps other gains losses
tax_loss_carryforward_diluted_eps	number	Tax loss carryforward diluted eps
diluted_accounting_change	number	Diluted accounting change
diluted_extraordinary	number	Diluted extraordinary
diluted_discontinuous_operations	number	Diluted discontinuous operations
diluted_continuous_operations	number	Diluted continuous operations
basic_eps_other_gains_losses	number	Basic eps other gains losses
tax_loss_carryforward_basic_eps	number	Tax loss carryforward basic eps
basic_accounting_change	number	Basic accounting change
basic_extraordinary	number	Basic extraordinary
basic_discontinuous_operations	number	Basic discontinuous operations
basic_continuous_operations	number	Basic continuous operations
diluted_ni_avail_to_common_stockholders	number	Diluted ni avail to common stockholders
average_dilution_earnings	number	Average dilution earnings
total_expenses	number	Total expenses
selling_general_and_administration_expense	number	Selling general and administrative
selling_and_marketing_expense	number	Selling and marketing expense
general_and_administrative_expense	number	General and administrative expense
other_general_and_administrative_expense	number	Other general and administrative expense
depreciation_amortization_depletion_income_statement	number	Depreciation amortization depletion income statement
research_and_development_expense	number	Research and development expense
insurance_and_claims_expense	number	Insurance and claims expense
rent_and_landing_fees	number	Rent and landing fees
salaries_and_wages_expense	number	Salaries and wages expense
rent_expense_supplemental	number	Rent expense supplemental
provision_for_doubtful_accounts	number	Provision for doubtful accounts
interest_income	number	Interest income
interest_expense	number	Interest expense
net_interest_income	number	Net interest income
net_non_operating_interest_income_expense	number	Net non operating interest income expense
interest_expense_non_operating	number	Interest expense non operating
interest_income_non_operating	number	Interest income non operating
other_income_expense	number	Other income expense
other_non_operating_income_expenses	number	Other non operating income expenses
special_income_charges	number	Special income charges
gain_on_sale_of_ppe	number	Gain on sale of ppe
gain_on_sale_of_business	number	Gain on sale of business
gain_on_sale_of_security	number	Gain on sale of security
other_special_charges	number	Other special charges
write_off	number	Write off
impairment_of_capital_assets	number	Impairment of capital assets
restructuring_and_merger_acquisition	number	Restructuring and merger acquisition
securities_amortization	number	Securities amortization
earnings_from_equity_interest	number	Earnings from equity interest
earnings_from_equity_interest_net_of_tax	number	Earnings from equity interest net of tax
total_other_finance_cost	number	Total other finance cost
tax_provision	number	Tax provision
tax_effect_of_unusual_items	number	Tax effect of unusual items
tax_rate_for_calculations	number	Tax rate for calculations
other_taxes	number	Other taxes
depreciation_amortization_depletion	number	Depreciation amortization depletion
amortization_of_intangibles	number	Amortization of intangibles
depreciation	number	Depreciation
amortization	number	Amortization
depletion	number	Depletion
depreciation_and_amortization_in_income_statement	number	Depreciation and amortization in income statement
ebitda_value	number	Ebitda value
normalized_ebitda_value	number	Normalized ebitda value
ebit_value	number	Ebit value
dividend_per_share	number	Dividend per share
diluted_average_shares	number	Diluted average shares
basic_average_shares	number	Basic average shares
preferred_stock_dividends	number	Preferred stock dividends
other_under_preferred_stock_dividend	number	Other under preferred stock dividend
total_unusual_items	number	Total unusual items
total_unusual_items_excluding_goodwill	number	Total unusual items excluding goodwill
reconciled_depreciation	number	Reconciled depreciation
pretax_income_value	number	Pretax income value
special_income_charges_value	number	Special income charges value

JSON request example

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

Balance SheetHigh Demand

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

HTTP request example

https://api.twelvedata.com/balance_sheet?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

{
  "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",
      "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": null,
          "restricted_cash": null,
          "assets_held_for_sale": null,
          "hedging_assets": null,
          "other_current_assets": 14111000000,
          "total_current_assets": 134836000000
        },
        "non_current_assets": {
          "properties": 0,
          "land_and_improvements": 20041000000,
          "machinery_furniture_equipment": 78659000000,
          "construction_in_progress": null,
          "leases": 11023000000,
          "accumulated_depreciation": -70283000000,
          "goodwill": null,
          "investment_properties": null,
          "financial_assets": null,
          "intangible_assets": null,
          "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": null,
          "short_term_debt": 15613000000,
          "deferred_revenue": 7612000000,
          "tax_payable": null,
          "pensions": null,
          "other_current_liabilities": 47493000000,
          "total_current_liabilities": 125481000000
        },
        "non_current_liabilities": {
          "long_term_provisions": null,
          "long_term_debt": 109106000000,
          "provision_for_risks_and_charges": 24689000000,
          "deferred_liabilities": null,
          "derivative_product_liabilities": null,
          "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": null,
        "treasury_stock": null,
        "minority_interest": null
      }
    }
  ]
}

HTTP route

/balance_sheet

API credits

100 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of instrument • For preffered stocks use dot(.) delimiter E.g. `BRK.A` or `BRK.B` will be correct
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
period	string	• Parameter is optional • Values should be `annual` or `quarterly`
start_date	string	• Parameter is optional • Format `2006-01-02`
end_date	string	• Parameter is optional • Format `2006-01-02`
outputsize	string	• Parameter is optional • Number of records in response; default `6`
apikey	string	• Required parameter • Your API key upgraded to the Pro plan or above, which can be obtained here

Response

Key	Type	Description
fiscal_date	string	Date of the balance sheet release
quarter	string	Fiscal quarter. Visible when `&period=quarterly`
cash	number	Cash includes currency, bank accounts, and undeposited checks
cash_equivalents	number	Represents cash equivalents that have high credit quality and are highly liquid
cash_and_cash_equivalents	number	Combined value of cash and cash equivalents when company doesn't report a breakdown
other_short_term_investments	number	Represents other short term investments
accounts_receivable	number	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	number	Represents other receivables
inventory	number	Represents the goods available for sale and raw materials used to produce goods available for sale
prepaid_assets	number	Represents expense that has already been paid for, but which has not yet been consumed
restricted_cash	number	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	number	Represents assets which company plans to sell
hedging_assets	number	Represents money that is spent on hedging assets
other_current_assets	number	Represents other current assets
total_current_assets	number	All current assets values in a total
properties	number	Represents property owned
land_and_improvements	number	Represents land and improvements owned
machinery_furniture_equipment	number	Represents office equipment, furniture, and vehicles owned
construction_in_progress	number	Represents the cost of construction work, which is not yet completed
leases	number	Represents operating and financial leases
accumulated_depreciation	number	Represents the cumulative depreciation of an asset that has been recorded
goodwill	number	Represents the value of a brand name, solid customer base, good customer relations, good employee relations, and proprietary technology
investment_properties	number	Represents real estate property purchased with the intention of earning a return on the investment
financial_assets	number	Represents liquid asset that gets its value from a contractual right or ownership claim
intangible_assets	number	Represents the patents, trademarks, and other intellectual properties
investments_and_advances	number	Represents available for sale financial securities
other_non_current_assets	number	Represents other long-term assets
total_non_current_assets	number	All long-term assets values in total
total_assets	number	The sum of `total_current_assets` + `total_non_current_assets`
accounts_payable	number	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	number	Represents payments that a company is obligated to pay in the future for which goods and services have already been delivered
short_term_debt	number	Represents current debt and capital lease obligations
deferred_revenue	number	Represents advance payments a company receives for products or services that are to be delivered or performed in the future
tax_payable	number	Represents taxes due to the government within one year
pensions	number	Represents to pensions to be paid out
other_current_liabilities	number	Represents other current liabilities
total_current_liabilities	number	Represents total current assets
long_term_provisions	number	Represents money set aside for employee benefits such as gratuity
long_term_debt	number	Represents amount of outstanding debt that has a maturity of 12 months or longer
provision_for_risks_and_charges	number	Represents funds set aside as assets to pay for anticipated future losses
deferred_liabilities	number	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	number
other_non_current_liabilities	number	Represents other non-current liabilities
total_non_current_liabilities	number	Represents total non-current liabilities
total_liabilities	number	The sum of `total_current_liabilities` + `total_non_current_liabilities`
common_stock	number	Represents net worth of investors shares, which is equal to the `total_assets` - `total_liabilities`
retained_earnings	number	Refers to the profits earned minus dividends paid
other_shareholders_equity	number	Represents other not affecting retained earnings gains and looses
total_shareholders_equity	number	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

JSON request example

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

Balance Sheet consolidated

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

HTTP request example

https://api.twelvedata.com/balance_sheet/consolidated?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

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

HTTP route

/balance_sheet/consolidated

API credits

100 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of instrument • For preffered stocks use dot(.) delimiter E.g. `BRK.A` or `BRK.B` will be correct
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
period	string	• Parameter is optional • Values should be `annual` or `quarterly`
start_date	string	• Parameter is optional • Format `2006-01-02`
end_date	string	• Parameter is optional • Format `2006-01-02`
outputsize	string	• Parameter is optional • Number of records in response; default `6`
apikey	string	• Required parameter • Your API key upgraded to the Pro plan or above, which can be obtained here

Response

Click to expand

Key	Type	Description
fiscal_date	string	Date of the balance sheet release
total_assets	number	Total assets
total_current_assets	number	Total current assets
cash_cash_equivalents_and_short_term_investments	number	Cash cash equivalents and short term investments
cash_and_cash_equivalents	number	Cash and cash equivalents
cash_equivalents	number	Cash equivalents
cash_financial	number	Cash financial
other_short_term_investments	number	Other short term investments
restricted_cash	number	Restricted cash
total_receivables	number	Total receivables
accounts_receivable	number	Accounts receivable
gross_accounts_receivable	number	Gross accounts receivable
allowance_for_doubtful_accounts_receivable	number	Allowance for doubtful accounts receivable
receivables_adjustments_allowances	number	Receivables adjustments allowances
other_receivables	number	Other receivables
due_from_related_parties_current	number	Due from related parties current
taxes_receivable	number	Taxes receivable
accrued_interest_receivable	number	Accrued interest receivable
notes_receivable	number	Notes receivable
loans_receivable	number	Loans receivable
total_inventory	number	Total inventory
inventories_adjustments_allowances	number	Inventories adjustments allowances
other_inventories	number	Other inventories
finished_goods	number	Finished goods
work_in_process	number	Work in process
raw_materials	number	Raw materials
prepaid_assets	number	Prepaid assets
current_deferred_assets	number	Current deferred assets
current_deferred_taxes_assets	number	Current deferred taxes assets
assets_held_for_sale_current	number	Assets held for sale current
hedging_assets_current	number	Hedging assets current
other_current_assets	number	Other current assets
total_non_current_assets	number	Total non current assets
financial_assets	number	Financial assets
investments_and_advances	number	Investments and advances
other_investments	number	Other investments
investment_in_financial_assets	number	Investment in financial assets
held_to_maturity_securities	number	Held to maturity securities
available_for_sale_securities	number	Available for sale securities
financial_assets_designated_as_fair_value_through_profit_or_loss_total	number	Financial assets designated as fair value through profit or loss total
trading_securities	number	Trading securities
long_term_equity_investment	number	Long term equity investment
investments_in_joint_ventures_at_cost	number	Investments in joint ventures at cost
investments_in_other_ventures_under_equity_method	number	Investments in other ventures under equity method
investments_in_associates_at_cost	number	Investments in associates at cost
investments_in_subsidiaries_at_cost	number	Investments in subsidiaries at cost
investment_properties	number	Investment properties
goodwill	number	Goodwill
other_intangible_assets	number	Other intangible assets
total_goodwill_and_intangible_assets	number	Total goodwill and intangible assets
net_ppe	number	Net ppe
gross_ppe	number	Gross ppe
accumulated_depreciation	number	Accumulated depreciation
leases	number	Leases
construction_in_progress	number	Construction in progress
other_properties	number	Other properties
machinery_furniture_equipment	number	Machinery furniture equipment
buildings_and_improvements	number	Buildings and improvements
land_and_improvements	number	Land and improvements
properties	number	Properties
non_current_accounts_receivable	number	Non current accounts receivable
non_current_note_receivables	number	Non current note receivables
due_from_related_parties_non_current	number	Due from related parties non current
non_current_prepaid_assets	number	Non current prepaid assets
non_current_deferred_assets	number	Non current deferred assets
non_current_deferred_taxes_assets	number	Non current deferred taxes assets
defined_pension_benefit	number	Defined pension benefit
other_non_current_assets	number	Other non current assets
total_liabilities_net_minority_interest	number	Total liabilities net minority interest
total_current_liabilities	number	Total current liabilities
current_debt_and_capital_lease_obligation	number	Current debt and capital lease obligation
current_debt	number	Current debt
current_capital_lease_obligation	number	Current capital lease obligation
other_current_borrowings	number	Other current borrowings
line_of_credit	number	Line of credit
commercial_paper	number	Commercial paper
current_notes_payable	number	Current notes payable
current_provisions	number	Current provisions
total_payables_and_accrued_expenses	number	Total payables and accrued expenses
accounts_payable	number	Accounts payable
current_accrued_expenses	number	Current accrued expenses
interest_payable	number	Interest payable
payables	number	Payables
other_payable	number	Other payable
due_to_related_parties_current	number	Due to related parties current
dividends_payable	number	Dividends payable
total_tax_payable	number	Total tax payable
income_tax_payable	number	Income tax payable
pension_and_other_post_retirement_benefit_plans_current	number	Pension and other post retirement benefit plans current
employee_benefits	number	Employee benefits
current_deferred_liabilities	number	Current deferred liabilities
current_deferred_revenue	number	Current deferred revenue
current_deferred_taxes_liabilities	number	Current deferred taxes liabilities
other_current_liabilities	number	Other current liabilities
liabilities_held_for_sale_non_current	number	Liabilities held for sale non current
total_non_current_liabilities_net_minority_interest	number	Total non current liabilities net minority interest
total_long_term_debt_and_capital_lease_obligation	number	Total long term debt and capital lease obligation
long_term_debt	number	Long term debt
long_term_capital_lease_obligation	number	Long term capital lease obligation
long_term_provisions	number	Long term provisions
non_current_pension_and_other_postretirement_benefit_plans	number	Non current pension and other postretirement benefit plans
non_current_accrued_expenses	number	Non current accrued expenses
due_to_related_parties_non_current	number	Due to related parties non current
trade_and_other_payables_non_current	number	Trade and other payables non current
non_current_deferred_liabilities	number	Non current deferred liabilities
non_current_deferred_revenue	number	Non current deferred revenue
non_current_deferred_taxes_liabilities	number	Non current deferred taxes liabilities
other_non_current_liabilities	number	Other non current liabilities
preferred_securities_outside_stock_equity	number	Preferred securities outside stock equity
derivative_product_liabilities	number	Derivative product liabilities
capital_lease_obligations	number	Capital lease obligations
restricted_common_stock	number	Restricted common stock
total_equity_gross_minority_interest	number	Total equity gross minority interest
stockholders_equity	number	Stockholders equity
common_stock_equity	number	Common stock equity
preferred_stock_equity	number	Preferred stock equity
other_equity_interest	number	Other equity interest
minority_interest	number	Minority interest
total_capitalization	number	Total capitalization
net_tangible_assets	number	Net tangible assets
tangible_book_value	number	Tangible book value
invested_capital	number	Invested capital
working_capital	number	Working capital
common_stock	number	Common stock
preferred_stock	number	Preferred stock
total_partnership_capital	number	Total partnership capital
general_partnership_capital	number	General partnership capital
limited_partnership_capital	number	Limited partnership capital
capital_stock	number	Capital stock
other_capital_stock	number	Other capital stock
additional_paid_in_capital	number	Additional paid in capital
retained_earnings	number	Retained earnings
treasury_stock	number	Treasury stock
treasury_shares_number	number	Treasury shares number
preferred_shares_number	number	Preferred shares number
ordinary_shares_number	number	Ordinary shares number
share_issued	number	Share issued
gains_losses_not_affecting_retained_earnings	number	Gains losses not affecting retained earnings
other_equity_adjustments	number	Other equity adjustments
fixed_assets_revaluation_reserve	number	Fixed assets revaluation reserve
foreign_currency_translation_adjustments	number	Foreign currency translation adjustments
minimum_pension_liabilities	number	Minimum pension liabilities
unrealized_gain_loss	number	Unrealized gain loss
net_debt	number	Net debt
total_debt	number	Total debt

JSON request example

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

Cash FlowHigh Demand

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

HTTP request example

https://api.twelvedata.com/cash_flow?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

{
  "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,
      "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": null,
        "net_acquisitions": null,
        "purchase_of_investments": -34913000000,
        "sale_of_investments": 21984000000,
        "other_investing_activity": -374000000,
        "investing_cash_flow": -16106000000
      },
      "financing_activities": {
        "long_term_debt_issuance": null,
        "long_term_debt_payments": 0,
        "short_term_debt_issuance": -1000000000,
        "common_stock_issuance": null,
        "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
    }
  ]
}

HTTP route

/cash_flow

API credits

100 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of instrument • For preffered stocks use dot(.) delimiter E.g. `BRK.A` or `BRK.B` will be correct
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
period	string	• Parameter is optional • Values should be `annual` or `quarterly`
start_date	string	• Parameter is optional • Format `2006-01-02`
end_date	string	• Parameter is optional • Format `2006-01-02`
outputsize	string	• Parameter is optional • Number of records in response; default `6`
apikey	string	• Required parameter • Your API key upgraded to the Pro plan or above, which can be obtained here

Response

Key	Type	Description
fiscal_date	string	Date of the cash flow release
quarter	string	Fiscal quarter. Visible when `&period=quarterly`
net_income	number	Returns net income (NI). Calculated as sales minus cost of goods sold
depreciation	number	Represents depreciation and amortization measure
deferred_taxes	number	Stands for taxes that are owed but are not due to be paid until a future date
stock_based_compensation	number	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	number	Represents other non-cash items
accounts_receivable	number	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	number	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	number	Represents cumulative changes in inventory, other current assets, other current liabilities, and other working capital
operating_cash_flow	number	Returns operating cash flow (OCF) measure representing a total amount of cash generated by company's normal business operations
capital_expenditures	number	Capital expenditures (CapEx) are funds used by a company to acquire, upgrade, and maintain physical assets (PPE)
net_intangibles	number	Represents purchase of a not physical asset
net_acquisitions	number	Refers to net amount of business purchase and sale
purchase_of_investments	number	Represents how much money has been used in making investments, including purchases of physical assets, investments in securities
sale_of_investments	number	Represents how much money has been generated from the sale of securities or assets
other_investing_activity	number	Represents other investing activity
investing_cash_flow	number	Returns total amount of cash flow used in investments
long_term_debt_issuance	number	Refers to the issuance of any financial obligations that extend beyond a 12 months period
long_term_debt_payments	number	Refers to the payments of any financial obligations that extend beyond a 12 months period
short_term_debt_issuance	number	Refers to the issuance of any financial obligations that are expected to be paid off within a year
common_stock_issuance	number	Represents a transaction whereby a company issues its own shares to the marketplace
common_stock_repurchase	number	Represents a transaction whereby a company buys back its own shares from the marketplace
common_dividends	number	Returns value of payment doled out by a company to its stockholders in the form of periodic distributions of cash
other_financing_charges	number	Represents other financing charges
financing_cash_flow	number	Returns cash flow from financing activities (CFF), which shows the net flows of cash that are used to fund the company
end_cash_position	number	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	number	Refers to supplemental data about income tax paid
interest_paid	number	Refers to supplemental data about interest paid
free_cash_flow	number	Represents the cash a company generates after accounting for cash outflows to support operations and maintain its capital assets

JSON request example

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

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.

HTTP request example

https://api.twelvedata.com/cash_flow/consolidated?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

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

HTTP route

/cash_flow/consolidated

API credits

100 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of instrument • For preffered stocks use dot(.) delimiter E.g. `BRK.A` or `BRK.B` will be correct
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
period	string	• Parameter is optional • Values should be `annual` or `quarterly`
start_date	string	• Parameter is optional • Format `2006-01-02`
end_date	string	• Parameter is optional • Format `2006-01-02`
outputsize	string	• Parameter is optional • Number of records in response; default `6`
apikey	string	• Required parameter • Your API key upgraded to the Pro plan or above, which can be obtained here

Response

Click to expand

Key	Type	Description
fiscal_date	string	Fiscal date
net_income_from_continuing_operations	number	Net income from continuing operations
operating_cash_flow	number	Operating cash flow
cash_flow_from_continuing_operating_activities	number	Cash flow from continuing operating activities
cash_from_discontinued_operating_activities	number	Cash from discontinued operating activities
cash_flow_from_discontinued_operation	number	Cash flow from discontinued operation
free_cash_flow	number	Free cash flow
cash_flows_from_used_in_operating_activities_direct	number	Cash flows from used in operating activities direct
taxes_refund_paid	number	Taxes refund paid
taxes_refund_paid_direct	number	Taxes refund paid direct
interest_received	number	Interest received
interest_received_direct	number	Interest received direct
interest_paid	number	Interest paid
interest_paid_direct	number	Interest paid direct
dividend_received	number	Dividend received
dividend_received_direct	number	Dividend received direct
dividend_paid	number	Dividend paid
dividend_paid_direct	number	Dividend paid direct
change_in_working_capital	number	Change in working capital
change_in_other_working_capital	number	Change in other working capital
change_in_receivables	number	Change in receivables
changes_in_account_receivables	number	Changes in account receivables
change_in_payables_and_accrued_expense	number	Change in payables and accrued expense
change_in_accrued_expense	number	Change in accrued expense
change_in_payable	number	Change in payable
change_in_dividend_payable	number	Change in dividend payable
change_in_account_payable	number	Change in account payable
change_in_tax_payable	number	Change in tax payable
change_in_income_tax_payable	number	Change in income tax payable
change_in_interest_payable	number	Change in interest payable
change_in_other_current_liabilities	number	Change in other current liabilities
change_in_other_current_assets	number	Change in other current assets
change_in_inventory	number	Change in inventory
change_in_prepaid_assets	number	Change in prepaid assets
other_non_cash_items	number	Other non cash items
excess_tax_benefit_from_stock_based_compensation	number	Excess tax benefit from stock based compensation
stock_based_compensation	number	Stock based compensation
unrealized_gain_loss_on_investment_securities	number	Unrealized gain loss on investment securities
provision_and_write_off_of_assets	number	Provision and write off of assets
asset_impairment_charge	number	Asset impairment charge
amortization_of_securities	number	Amortization of securities
deferred_tax	number	Deferred tax
deferred_income_tax	number	Deferred income tax
depreciation_amortization_depletion	number	Depreciation amortization depletion
depletion	number	Depletion
depreciation_and_amortization	number	Depreciation and amortization
amortization_cash_flow	number	Amortization cash flow
amortization_of_intangibles	number	Amortization of intangibles
depreciation	number	Depreciation
operating_gains_losses	number	Operating gains losses
pension_and_employee_benefit_expense	number	Pension and employee benefit expense
earnings_losses_from_equity_investments	number	Earnings losses from equity investments
gain_loss_on_investment_securities	number	Gain loss on investment securities
net_foreign_currency_exchange_gain_loss	number	Net foreign currency exchange gain loss
gain_loss_on_sale_of_ppe	number	Gain loss on sale of ppe
gain_loss_on_sale_of_business	number	Gain loss on sale of business
investing_cash_flow	number	Investing cash flow
cash_flow_from_continuing_investing_activities	number	Cash flow from continuing investing activities
cash_from_discontinued_investing_activities	number	Cash from discontinued investing activities
net_other_investing_changes	number	Net other investing changes
interest_received_cfi	number	Interest received cfi
dividends_received_cfi	number	Dividends received cfi
net_investment_purchase_and_sale	number	Net investment purchase and sale
sale_of_investment	number	Sale of investment
purchase_of_investment	number	Purchase of investment
net_investment_properties_purchase_and_sale	number	Net investment properties purchase and sale
sale_of_investment_properties	number	Sale of investment properties
purchase_of_investment_properties	number	Purchase of investment properties
net_business_purchase_and_sale	number	Net business purchase and sale
sale_of_business	number	Sale of business
purchase_of_business	number	Purchase of business
net_intangibles_purchase_and_sale	number	Net intangibles purchase and sale
sale_of_intangibles	number	Sale of intangibles
purchase_of_intangibles	number	Purchase of intangibles
net_ppe_purchase_and_sale	number	Net ppe purchase and sale
sale_of_ppe	number	Sale of ppe
purchase_of_ppe	number	Purchase of ppe
capital_expenditure_reported	number	Capital expenditure reported
capital_expenditure	number	Capital expenditure
financing_cash_flow	number	Financing cash flow
cash_flow_from_continuing_financing_activities	number	Cash flow from continuing financing activities
cash_from_discontinued_financing_activities	number	Cash from discontinued financing activities
net_other_financing_charges	number	Net other financing charges
interest_paid_cff	number	Interest paid cff
proceeds_from_stock_option_exercised	number	Proceeds from stock option exercised
cash_dividends_paid	number	Cash dividends paid
preferred_stock_dividend_paid	number	Preferred stock dividend paid
common_stock_dividend_paid	number	Common stock dividend paid
net_preferred_stock_issuance	number	Net preferred stock issuance
preferred_stock_payments	number	Preferred stock payments
preferred_stock_issuance	number	Preferred stock issuance
net_common_stock_issuance	number	Net common stock issuance
common_stock_payments	number	Common stock payments
common_stock_issuance	number	Common stock issuance
repurchase_of_capital_stock	number	Repurchase of capital stock
net_issuance_payments_of_debt	number	Net issuance payments of debt
net_short_term_debt_issuance	number	Net short term debt issuance
short_term_debt_payments	number	Short term debt payments
short_term_debt_issuance	number	Short term debt issuance
net_long_term_debt_issuance	number	Net long term debt issuance
long_term_debt_payments	number	Long term debt payments
long_term_debt_issuance	number	Long term debt issuance
issuance_of_debt	number	Issuance of debt
repayment_of_debt	number	Repayment of debt
issuance_of_capital_stock	number	Issuance of capital stock
interest_paid_supplemental_data	number	Interest paid supplemental data
income_tax_paid_supplemental_data	number	Income tax paid supplemental data
foreign_sales	number	Foreign sales
domestic_sales	number	Domestic sales
adjusted_geography_segment_data	number	Adjusted geography segment data
beginning_cash_position	number	Beginning cash position
end_cash_position	number	End cash position
changes_in_cash	number	Changes in cash
other_cash_adjustment_outside_change_in_cash	number	Other cash adjustment outside change in cash
other_cash_adjustment_inside_change_in_cash	number	Other cash adjustment inside change in cash
effect_of_exchange_rate_changes	number	Effect of exchange rate changes
classes_of_cash_receipts_from_operating_activities	number	Classes of cash receipts from operating activities
other_cash_receipts_from_operating_activities	number	Other cash receipts from operating activities
receipts_from_government_grants	number	Receipts from government grants
receipts_from_customers	number	Receipts from customers
classes_of_cash_payments	number	Classes of cash payments
other_cash_payments_from_operating_activities	number	Other cash payments from operating activities
payments_on_behalf_of_employees	number	Payments on behalf of employees
payments_to_suppliers_for_goods_and_services	number	Payments to suppliers for goods and services

JSON request example

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

Key ExecutivesUseful

Returns individuals at the highest level of management of an organization.

HTTP request example

https://api.twelvedata.com/key_executives?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

{
  "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
    },
    {
      "name": "Mr. Luca  Maestri",
      "title": "CFO & Sr. VP",
      "age": 56,
      "year_born": 1964,
      "pay": 4595583
    },
    {
      "name": "Mr. Jeffrey E. Williams",
      "title": "Chief Operating Officer",
      "age": 56,
      "year_born": 1964,
      "pay": 4594137
    }
  ]
}

HTTP route

/key_executives

API credits

1000 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of instrument • For preffered stocks use dot(.) delimiter E.g. `BRK.A` or `BRK.B` will be correct
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
apikey	string	• Required parameter • Your API key upgraded to the Pro plan or above, which can be obtained here

Response

Key	Type	Description
name	string	Full name of an executive, including first name, middle name, last name, and suffix
title	string	Refers to job title
age	number	Current age of an executive if available
year_born	number	Year of birth of an executive if available
pay	number	Total salary of an executive if available

JSON request example

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

Last changesNew

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

HTTP request example

https://api.twelvedata.com/last_change/:endpoint?apikey=demo&start_date=2023-10-14 10:00:00

This request will return JSON with the following structure

[
    {
        "symbol": "0P0001LCQ3",
        "mic_code": "OTCM",
        "last_change": "2023-10-14 12:22:48"
    },
    {
        "symbol": "AAPL",
        "mic_code": "XNAS",
        "last_change": "2023-10-14 12:22:48"
    }
]

HTTP route

/last_change/:endpoint

API credits

1 per request

API parameters

Parameter	Details
apikey	• Required parameter • Your personal API key, which you can obtain for free here • Type `string`
endpoint	• Required parameter • Endpoint name. Supported values: `price_target`, `recommendations`, `statistics`, `insider_transactions`, `profile`, `mutual_funds_world_summary`, `mutual_funds_world`, `institutional_holders`, `analyst_rating`, `income_statement`, `cash_flow`, `balance_sheet`, `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`
start_date	• Parameter is optional • The starting date and time for data selection, in "2006-01-02 15:04:05" format
symbol	• Parameter is optional • Filter by symbol
exchange	• Parameter is optional • Filter by exchange name or mic code
mic_code	• Parameter is optional • Filter by market identifier code (MIC) under ISO 10383 standard
country	• Parameter is optional • Filter by country name or alpha code
page	• Parameter is optional • Page number; default `1`
outputsize	• Parameter is optional • Number of records in response; default `30`

Response

Key	Type	Description
symbol	string	Ticker of the company
mic_code	string	Market Identifier Code (MIC) under ISO 10383 standard
last_change	string	The date and time of last changes, in "2006-01-02 15:04:05" format.

JSON request example

https://api.twelvedata.com/last_change/profile?start_date=2023-10-14 10:00:00&apikey=demo

Market capitalizationNew

Market capitalization history.

HTTP request example

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

This request will return JSON with the following structure

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

HTTP route

/market_cap

API credits

5 per request

API parameters

Parameter	Details
apikey	• Required parameter • Your personal API key, which you can obtain for free here • Type `string`
symbol	• Parameter is optional • Filter by symbol
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	• Parameter is optional • Filter by exchange name or mic code
mic_code	• Parameter is optional • Filter by market identifier code (MIC) under ISO 10383 standard
country	• Parameter is optional • Filter by country name or alpha code
start_date string	• Format `2006-01-02`
end_date string	• Format `2006-01-02`
page	• Parameter is optional • Page number; default `1`
outputsize	• Parameter is optional • Number of records in response; default `10`

Response

Key	Type	Description
symbol	string	Ticker of the company
name	string	Name of the company
currency	currency in which instrument is traded by ISO 4217 standard
exchange	string	Exchange name where the company is listed
mic_code	string	Market Identifier Code (MIC) under ISO 10383 standard
market_cap	array	Market capitalization values
market_cap.date	string	Market capitalization date
market_cap.value	integer	Market capitalization value

JSON request example

https://api.twelvedata.com/market_cap

Analysis

Earnings EstimateUseful

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

HTTP request example

https://api.twelvedata.com/earnings_estimate?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

{
  "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
    },
    {
      "date": "2022-12-31",
      "period": "next_quarter",
      "number_of_analysts": 23,
      "avg_estimate": 2.12,
      "low_estimate": 2.01,
      "high_estimate": 2.29,
      "year_ago_eps": 2.1
    },
    {
      "date": "2022-09-30",
      "period": "current_year",
      "number_of_analysts": 37,
      "avg_estimate": 6.1,
      "low_estimate": 5.96,
      "high_estimate": 6.4,
      "year_ago_eps": 5.61
    },
    {
      "date": "2023-09-30",
      "period": "next_year",
      "number_of_analysts": 37,
      "avg_estimate": 6.44,
      "low_estimate": 5.79,
      "high_estimate": 7.06,
      "year_ago_eps": 6.1
    }
  ],
  "status": "ok"
}

HTTP route

/earnings_estimate

API credits

20 per symbol

API parameters

Parameter	Details
symbol	• Required parameter • Filter by symbol
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
exchange	• Parameter is optional • Filter by exchange name or mic code
apikey	• Required parameter • Your API key at the Ultra plan or above

Response

Key	Description
period	defines period of estimation, can be `current_quarter`, `next_quarter`, `current_year`, or `next_year`
number_of_analysts	number of analysts that made the estimation
avg_estimate	average estimation across analysts
low_estimate	lowest estimation given by an analyst
high_estimate	highest estimation given by an analyst
year_ago_eps	average estimation of this period’s earnings given a year ago

JSON request example

https://api.twelvedata.com/earnings_estimate?symbol=aapl&apikey=demo

Revenue Estimate

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

HTTP request example

https://api.twelvedata.com/revenue_estimate?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

{
  "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
    },
    {
      "date": "2022-12-31",
      "period": "next_quarter",
      "number_of_analysts": 20,
      "avg_estimate": 127693000000,
      "low_estimate": 122868000000,
      "high_estimate": 132979000000,
      "year_ago_sales": null,
      "sales_growth": null
    },
    {
      "date": "2022-09-30",
      "period": "current_year",
      "number_of_analysts": 36,
      "avg_estimate": 392509000000,
      "low_estimate": 389326000000,
      "high_estimate": 396977000000,
      "year_ago_sales": 365817000000,
      "sales_growth": 0.07
    },
    {
      "date": "2023-09-30",
      "period": "next_year",
      "number_of_analysts": 36,
      "avg_estimate": 411466000000,
      "low_estimate": 387836000000,
      "high_estimate": 441307000000,
      "year_ago_sales": 392509000000,
      "sales_growth": 0.05
    }
  ],
  "status": "ok"
}

HTTP route

/revenue_estimate

API credits

20 per symbol

API parameters

Parameter	Details
symbol	• Required parameter • Filter by symbol
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
exchange	• Parameter is optional • Filter by exchange name or mic code
dp	• Number of decimal places for floating values • Should be in range `[0,11]` inclusive. Default `5`
apikey	• Required parameter • Your API key at the Ultra plan or above

Response

Key	Description
period	defines period of estimation, can be `current_quarter`, `next_quarter`, `current_year`, or `next_year`
number_of_analysts	number of analysts that made the estimation
avg_estimate	average estimation across analysts
low_estimate	lowest estimation given by an analyst
high_estimate	highest estimation given by an analyst
year_ago_sales	total revenue received a year ago relative to period
sales_growth	estimated sales growth of the period in relation to year-ago sales in prc (%)

JSON request example

https://api.twelvedata.com/revenue_estimate?symbol=aapl&apikey=demo

EPS Trend

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

HTTP request example

https://api.twelvedata.com/eps_trend?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

{
  "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
    },
    {
      "date": "2022-12-31",
      "period": "next_quarter",
      "current_estimate": 2.12,
      "7_days_ago": 2.11,
      "30_days_ago": 2.18,
      "60_days_ago": 2.19,
      "90_days_ago": 2.19
    },
    {
      "date": "2022-09-30",
      "period": "current_year",
      "current_estimate": 6.1,
      "7_days_ago": 6.1,
      "30_days_ago": 6.13,
      "60_days_ago": 6.14,
      "90_days_ago": 6.14
    },
    {
      "date": "2023-09-30",
      "period": "next_year",
      "current_estimate": 6.44,
      "7_days_ago": 6.44,
      "30_days_ago": 6.51,
      "60_days_ago": 6.55,
      "90_days_ago": 6.56
    }
  ],
  "status": "ok"
}

HTTP route

/eps_trend

API credits

20 per symbol

API parameters

Parameter	Details
symbol	• Required parameter • Filter by symbol
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
exchange	• Parameter is optional • Filter by exchange name or mic code
apikey	• Required parameter • Your API key at the Ultra plan or above

Response

Key	Description
period	defines period of estimation, can be `current_quarter`, `next_quarter`, `current_year`, or `next_year`
current_estimate	actual EPS estimation for the period
7_days_ago	EPS estimation value 7 days ago
30_days_ago	EPS estimation value 30 days ago
60_days_ago	EPS estimation value 60 days ago
90_days_ago	EPS estimation value 90 days ago

JSON request example

https://api.twelvedata.com/eps_trend?symbol=aapl&apikey=demo

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.

HTTP request example

https://api.twelvedata.com/eps_revisions?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

{
  "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
    },
    {
      "date": "2022-12-31",
      "period": "next_quarter",
      "up_last_week": 1,
      "up_last_month": 5,
      "down_last_week": 0,
      "down_last_month": 0
    },
    {
      "date": "2022-09-30",
      "period": "current_year",
      "up_last_week": 1,
      "up_last_month": 10,
      "down_last_week": 0,
      "down_last_month": 1
    },
    {
      "date": "2023-09-30",
      "period": "next_year",
      "up_last_week": 1,
      "up_last_month": 10,
      "down_last_week": 0,
      "down_last_month": 1
    }
  ],
  "status": "ok"
}

HTTP route

/eps_revisions

API credits

20 per symbol

API parameters

Parameter	Details
symbol	• Required parameter • Filter by symbol
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
exchange	• Parameter is optional • Filter by exchange name or mic code
apikey	• Required parameter • Your API key at the Ultra plan or above

Response

Key	Description
period	defines period of estimation, can be `current_quarter`, `next_quarter`, `current_year`, or `next_year`
up_last_week	number of up revisions over the last 7 days
up_last_month	number of up revisions over the last 30 days
down_last_week	number of down revisions over the last 7 days
down_last_month	number of down revisions over the last 30 days

JSON request example

https://api.twelvedata.com/eps_revisions?symbol=aapl&apikey=demo

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.

HTTP request example

https://api.twelvedata.com/growth_estimates?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

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

HTTP route

/growth_estimates

API credits

20 per symbol

API parameters

Parameter	Details
symbol	• Required parameter • Filter by symbol
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
exchange	• Parameter is optional • Filter by exchange name or mic code
apikey	• Required parameter • Your API key at the Ultra plan or above

Response

Key	Description
current_quarter	projected growth of the current quarter in prc (%)
next_quarter	projected growth of the next quarter in prc (%)
current_year	projected growth of the current year in prc (%)
next_year	projected growth of the next year in prc (%)
next_5_years_pa	projected growth during the next 5 years in prc (%) per annum
past_5_years_pa	actual growth over the last 5 years in prc (%) per annum

JSON request example

https://api.twelvedata.com/growth_estimates?symbol=aapl&apikey=demo

RecommendationsHigh Demand

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.

HTTP request example

https://api.twelvedata.com/recommendations?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

{
  "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": 11,
      "buy": 21,
      "hold": 6,
      "sell": 0,
      "strong_sell": 0
    },
    "previous_month": {
      "strong_buy": 14,
      "buy": 24,
      "hold": 8,
      "sell": 0,
      "strong_sell": 0
    },
    "2_months_ago": {
      "strong_buy": 14,
      "buy": 24,
      "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"
}

HTTP route

/recommendations

API credits

100 per symbol

API parameters

Parameter	Details
symbol	• Required parameter • Filter by symbol
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
exchange	• Parameter is optional • Filter by exchange name or mic code
apikey	• Required parameter • Your API key at the Ultra plan or above

Response

Key	Description
strong_buy	number of analysts that give a strong buy recommendation
buy	number of analysts that give a buy recommendation
hold	number of analysts that give a hold recommendation
sell	number of analysts that give a sell recommendation
strong_sell	number of analysts that give a strong sell recommendation
rating	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.

JSON request example

https://api.twelvedata.com/recommendations?symbol=aapl&apikey=demo

Price TargetHigh Demand

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

HTTP request example

https://api.twelvedata.com/price_target?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

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

HTTP route

/price_target

API credits

75 per symbol

API parameters

Parameter	Details
symbol	• Required parameter • Filter by symbol
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
exchange	• Parameter is optional • Filter by exchange name or mic code
apikey	• Required parameter • Your API key at the Ultra plan or above

Response

Key	Description
high	highest price target given by an analyst
median	median price target given across analysts
low	lowest price target given by an analyst
average	average price target given across analysts
current	current price from of a security

JSON request example

https://api.twelvedata.com/price_target?symbol=aapl&apikey=demo

Analyst Ratings - Light

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

HTTP request example

https://api.twelvedata.com/analyst_ratings/light?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

{
  "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"
    },
    {
      "date": "2022-08-17",
      "firm": "Credit Suisse",
      "rating_change": "Upgrade",
      "rating_current": "Outperform",
      "rating_prior": "Neutral"
    },
    {
      "date": "2022-08-17",
      "firm": "Wedbush",
      "rating_change": "Maintains",
      "rating_current": "Outperform",
      "rating_prior": "Outperform"
    }
  ],
  "status": "ok"
}

HTTP route

/analyst_ratings/light

API credits

75 per symbol

API parameters

Parameter	Details
symbol	• Required parameter • Filter by symbol
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
country	• Parameter is optional • Filter by country name or alpha code
exchange	• Parameter is optional • Filter by exchange name or mic code
rating_change	• Parameter is optional • Filter by rating change action: `Maintains`, `Upgrade`, `Downgrade`, `Initiates` or `Reiterates`
outputsize	• Parameter is optional • Number of records in response; default `30`
apikey	• Required parameter • Your API key at the Ultra plan or above

Response

Key	Description
date	date when the rating was released
firm	firm that issued the ranking
rating_change	defines the action of the firm to ranking, could be `Maintains`, `Upgrade`, `Downgrade`, `Initiates` or `Reiterates`
rating_current	current firm's ranking of the instrument
rating_prior	prior firm's ranking of the instrument

JSON request example

https://api.twelvedata.com/analyst_ratings/light?symbol=aapl&apikey=demo

https://api.twelvedata.com/analyst_ratings/light?symbol=infy&country=india&apikey=demo

Analyst Ratings - US Equities

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

HTTP request example

https://api.twelvedata.com/analyst_ratings/us_equities?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

{
  "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
    },
    {
      "date": "2022-08-17",
      "firm": "Credit Suisse",
      "analyst_name": "Shannon Cross",
      "rating_change": "Upgrade",
      "rating_current": "Outperform",
      "rating_prior": "Neutral",
      "time": "08:14:09",
      "action_price_target": "Announces",
      "price_target_current": 201,
      "price_target_prior": null
    },
    {
      "date": "2022-08-17",
      "firm": "Wedbush",
      "analyst_name": "Daniel Ives",
      "rating_change": "Maintains",
      "rating_current": "Outperform",
      "rating_prior": "Outperform",
      "time": "10:22:55",
      "action_price_target": "Raises",
      "price_target_current": 220,
      "price_target_prior": 200
    }
  ],
  "status": "ok"
}

HTTP route

/analyst_ratings/us_equities

API credits

200 per symbol

API parameters

Parameter	Details
symbol	• Required parameter • Filter by symbol
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	• Parameter is optional • Filter by exchange name or mic code
rating_change	• Parameter is optional • Filter by rating change action: `Maintains`, `Upgrade`, `Downgrade`, `Initiates`, `Reiterates`, `Assumes`, or `Reinstates`
outputsize	• Parameter is optional • Number of records in response; default `30`
apikey	• Required parameter • Your API key at the Ultra plan or above

Response

Key	Description
date	date when the rating was released
firm	firm that issued the ranking
analyst_name	name of an analyst
rating_change	defines the action of the firm to ranking, could be `Maintains`, `Upgrade`, `Downgrade`, `Initiates`, `Reiterates`, `Assumes`, or `Reinstates`
rating_current	current firm's ranking of the instrument
rating_prior	prior firm's ranking of the instrument
time	time when the rating was released or updated
action_price_target	action that firm took towards target price
price_target_current	current firm's price target for the instrument
price_target_prior	prior firm's price target for the instrument

JSON request example

https://api.twelvedata.com/analyst_ratings/us_equities?symbol=aapl&apikey=demo

Regulatory

Tax information

This API endpoint returns tax information for the instrument.

HTTP request example

https://api.twelvedata.com/tax_info?symbol=ALM:BME&apikey=your_api_key

This request will return JSON with the following structure

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

HTTP route

/tax_info

API credits

50 per symbol

API parameters

Parameter	Details
symbol	• Required parameter • Filter by symbol
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	• Parameter is optional • Filter by exchange name or mic code
mic_code	• Parameter is optional • Filter by market identifier code (MIC) under ISO 10383 standard
apikey	• Required parameter • Your API key at the Ultra plan or above

Response

Key	Description
tax_indicator	instrument tax indicator, can be `null`, `us_1446f`, `spanish_ftt`, `uk_stamp_duty`, `hk_stamp_duty`, `french_ftt` or `italian_ftt`

JSON request example

https://api.twelvedata.com/tax_info?symbol=ALM:BME&apikey=demo

Edgar filings archiveNew

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

HTTP request example

https://api.twelvedata.com/edgar_filings/archive?apikey=your_api_key

This request will return JSON with the following structure

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

HTTP route

/edgar_filings/archive

API credits

50 per request

API parameters

Parameter	Details
apikey	• Required parameter • Your personal API key, which you can obtain for free here • Type `string`
symbol	• Parameter is optional • Filter by symbol
figi	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	• Parameter is optional • Filter by exchange name or mic code
mic_code	• Parameter is optional • Filter by market identifier code (MIC) under ISO 10383 standard
country	• Parameter is optional • Filter by country name or alpha code
form_type	• Parameter is optional • Filter by form types, example `8-K`, `EX-1.1`
filled_from	• Parameter is optional • Filter by filled time from, example `2024-01-01`
filled_to	• Parameter is optional • Filter by filled time to, example `2024-01-01`
page	• Parameter is optional • Page number; default `1`
page_size	• Parameter is optional • Number of records in response; default `10`

Response

Key	Type	Description
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
cik	integer	CIK code
filled_at	integer	Filing date in UNIX timestamp
form_type	string	Filing form type
files	array	Filing files
files.name	string	File name
files.size	integer	File size
files.type	string	File type
files.url	string	File full url
filing_url	string	Full URL of the filing
ticker	array	List of tickers

JSON request example

https://api.twelvedata.com/edgar_filings/archive

Insider Transactions

Returns trading information performed by insiders.

HTTP request example

https://api.twelvedata.com/insider_transactions?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

{
  "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."
    },
    {
      "full_name": "MAESTRI LUCA",
      "position": "Chief Financial Officer",
      "date_reported": "2021-05-03",
      "is_direct": true,
      "shares": 121072,
      "value": 16079338,
      "description": "Sale at price 132.58 - 133.93 per share."
    },
    {
      "full_name": "O'BRIEN DEIRDRE",
      "position": "Officer",
      "date_reported": "2021-04-16",
      "is_direct": true,
      "shares": 18216,
      "value": 2441126,
      "description": "Sale at price 134.01 per share."
    },
    {
      "full_name": "KONDO CHRISTOPHER",
      "position": "Officer",
      "date_reported": "2021-04-15",
      "is_direct": true,
      "shares": 17603,
      "value": 0,
      "description": ""
    }
  ]
}

HTTP route

/insider_transactions

API credits

200 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of instrument • For preffered stocks use dot(.) delimiter E.g. `BRK.A` or `BRK.B` will be correct
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
apikey	string	• Required parameter • Your API key upgraded to the Pro plan or above, which can be obtained here

Response

Key	Type	Description
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	bool	`true` if direct, `false` if indirect
shares	number	As per report the number of shares acquired or disposed of the transaction
value	number	Represents the value of transaction, calculated as price multiplied by the volume
description	string	Exact price or price range of the transaction if available

JSON request example

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

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

HTTP request example

https://api.twelvedata.com/institutional_holders?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

{
  "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
    },
    {
      "entity_name": "Blackrock Inc.",
      "date_reported": "2021-06-30",
      "shares": 1028698316,
      "value": 140890521359,
      "percent_held": 0.0622
    },
    {
      "entity_name": "Berkshire Hathaway, Inc",
      "date_reported": "2021-06-30",
      "shares": 887135554,
      "value": 121502085475,
      "percent_held": 0.0537
    }
  ]
}

HTTP route

/institutional_holders

API credits

1500 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of instrument • For preffered stocks use dot(.) delimiter E.g. `BRK.A` or `BRK.B` will be correct
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
apikey	string	• Required parameter • Your API key upgraded to the Pro plan or above, which can be obtained here

Response

Key	Type	Description
entity_name	string	Refers to the legal name of the institution
date_reported	string	Refers to date reported
shares	number	Refers to the number of shares owned
value	number	Total value of shares owned, calculated by multiplying `shares` by the current price
percent_held	number	Represents the percentage of shares outstanding that are owned by the financial institution

JSON request example

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

Fund Holders

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

HTTP request example

https://api.twelvedata.com/fund_holders?symbol=AAPL&apikey=your_api_key

This request will return JSON with the following structure

{
  "meta": {
    "symbol": "AAPL",
    "name": "Apple Inc",
    "currency": "USD",
    "exchange": "NASDAQ",
    "mic_code": "XNAS",
    "exchange_timezone": "America/New_York"
  },
  "fund_holders": [
    {
      "entity_name": "Vanguard Total Stock Market Index Fund",
      "date_reported": "2021-06-30",
      "shares": 447734657,
      "value": 61321738622,
      "percent_held": 0.0271
    },
    {
      "entity_name": "Vanguard 500 Index Fund",
      "date_reported": "2021-06-30",
      "shares": 325785979,
      "value": 44619647683,
      "percent_held": 0.0197
    },
    {
      "entity_name": "SPDR S&P 500 ETF Trust",
      "date_reported": "2021-06-30",
      "shares": 161505783,
      "value": 22119832039,
      "percent_held": 0.0098
    }
  ]
}

HTTP route

/fund_holders

API credits

1500 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of instrument • For preffered stocks use dot(.) delimiter E.g. `BRK.A` or `BRK.B` will be correct
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
apikey	string	• Required parameter • Your API key upgraded to the Pro plan or above, which can be obtained here

Response

Key	Type	Description
entity_name	string	Refers to the legal name of the fund
date_reported	string	Refers to date reported
shares	number	Refers to the number of shares owned
value	number	Total value of shares owned, calculated by multiplying `shares` by the current price
percent_held	number	Represents the percentage of shares outstanding that are owned by the fund

JSON request example

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

Direct HoldersNew

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

HTTP request example

https://api.twelvedata.com/direct_holders?symbol=4261&apikey=your_api_key

This request will return JSON with the following structure

{
  "meta": {
    "symbol": "4261",
    "name": "Theeb Rent A Car Company",
    "currency": "SAR",
    "exchange": "Tadawul",
    "mic_code": "XSAU",
    "exchange_timezone": "Asia/Riyadh"
  },
  "direct_holders": [
    {
      "entity_name": "Growth Opportunities Co. For Trading",
      "date_reported": "2022-04-17",
      "shares": 2145700,
      "value": 154490400,
      "percent_held": null
    },
    {
      "entity_name": "Dhabib Nayef Mohammed Ahmed Al",
      "date_reported": "2022-04-17",
      "shares": 210700,
      "value": 15170400,
      "percent_held": null
    },
    {
      "entity_name": "Dhabib Mohammed Ahmed Abdullah Al",
      "date_reported": "2022-04-17",
      "shares": 10461900,
      "value": 753256800,
      "percent_held": null
    },
    {
      "entity_name": "Dhabib Mohammed Mahmoud Abdullah Al",
      "date_reported": "2022-04-17",
      "shares": 849981,
      "value": 61198632,
      "percent_held": null
    },
    {
      "entity_name": "Dhabib Hamood Abdullah Ibrahim Al",
      "date_reported": "2022-04-17",
      "shares": 5813600,
      "value": 418579200,
      "percent_held": null
    }
  ]
}

HTTP route

/direct_holders

API credits

1500 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of instrument • For preffered stocks use dot(.) delimiter E.g. `BRK.A` or `BRK.B` will be correct
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
apikey	string	• Required parameter • Your API key upgraded to the Pro plan or above, which can be obtained here

Response

Key	Type	Description
entity_name	string	Refers to the legal name of the fund
date_reported	string	Refers to date reported
shares	number	Refers to the number of shares owned
value	number	Total value of shares owned, calculated by multiplying `shares` by the current price
percent_held	number	Represents the percentage of shares outstanding that are owned by the fund

JSON request example

https://api.twelvedata.com/direct_holders?symbol=4261&apikey=demo

Sanctioned entities

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

HTTP request example

https://api.twelvedata.com/sanctions/ofac?apikey=your_api_key

This request will return JSON with the following structure

{
  "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"
          }
        ]
      }
    },
    {
      "symbol": "GALXBRG",
      "name": "Galaxy Bearings Ltd.",
      "mic_code": "BSE",
      "country": "India",
      "sanction": {
        "source": "ofac",
        "program": "RUSSIA-EO14024",
        "notes": "Block",
        "lists": [
          {
            "name": "SDN List",
            "published_at": "2024-10-30"
          }
        ]
      }
    }
  ],
  "count": 163,
  "status": "ok"
}

HTTP route

/sanctions/{ofac,eu,uk,au}

API credits

50 per request

API parameters

Parameter	Details
apikey	• Required parameter • Your API key at the Ultra plan or above

Response

Key	Description
symbol	The instrument symbol ticker
name	The instrument name
mic_code	Market Identifier Code (MIC) under ISO 10383 standard
country	Country name
sanction.source	The sanction source
sanction.program	The sanction program
sanction.notes	Notes for the sanction
lists.name	The sanction list name
lists.published_at	The sanction published date in the current sanctions list

JSON request example

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

WebSocket

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

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.

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

Real-time priceUseful

This method allows you to get real-time price streaming from the exchange. Equities also have day volume information.

Subscribe to stream

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

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

Response

Success subscription response:

{
  "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; only precious metals:

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

Route

/quotes/price

WebSocket credits

1 per symbol, API credits are not used

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.

Advanced

BatchesUseful

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

HTTP request example

curl --location 'https://api.twelvedata.com/batch' \
--header 'Content-Type: application/json' \
--data '{
  "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"
  }
}
'

This request will return JSON with the following structure

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

POST route

/batch

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.

Complex Data

This section covers a method that will be deprecated soon. Please use the /batch endpoint as the recommended alternative.

With this endpoint, you may construct a complex request across multiple instruments, intervals, and data methods at the same time. Only JSON POST requests are accepted. The number of simultaneous requests is only limited according to your plan.

The content structure consists of 2 main parts. The first one are the general parameters that apply to all listed methods by default. The second one are the methods objects.

Common parameters are intervals, outputsize, etc.
General parameters are: symbols(required), apikey(optional), common parameters, and methods array (required).
Method could be either a string with the name of endpoint (as with a single API call) or an object. The object takes name(required) and optional common parameters. Take note that method parameters are given higher priority, over general ones in the case of overlapping.

HTTP request example

https://api.twelvedata.com/complex_data?apikey=your_api_key
--header "Content-Type: application/json" \
--request POST \
--data '{
    "symbols": ["AAPL", "MSFT", "GOOG"],
    "intervals": ["5min", "1day"],
    "outputsize": 25,
    "methods": [
        "time_series",
        {
            "name": "ema",
            "time_period": 12
        },
        "quote",
        {
            "name": "adx",
            "order": "ASC"
        }
    ]
}'

This request will return JSON with the following structure

{
  "data": [
    {"meta": {"symbol" : "AAPL", "interval": "5min", ...}, "values": [...], "status": "ok"},
    {"meta": {"symbol" : "AAPL", "interval": "1day", ...}, "values": [...], "status": "ok"},
    {"meta": {"symbol" : "MSFT", "interval": "5min", ...}, "values": [...], "status": "ok"},
    {"meta": {"symbol" : "MSFT", "interval": "1day", ...}, "values": [...], "status": "ok"},
    {"meta": {"symbol" : "GOOG", "interval": "5min", ...}, "values": [...], "status": "ok"},
    ...
    {"meta": {"symbol" : "GOOG", "interval": "1day", ...}, "values": [...], "status": "ok"}
  ],
  "status": "ok"
}

Example of error in the one of the responses

{
  "data": [
    {"code": 400, "message": "**symbol** not found...", "meta":  {"symbol" : "...", "interval": "..", "exchange": "..."}, "status": "error"},
    ...
    {"meta": {"symbol" : "...", "interval": "...", ...}, "values": [...], "status": "ok"}
  ],
  "status": "ok"
}

POST route

/complex_data

API credits

1 per returned symbol object

Common Parameters

Parameter	Details
intervals array	• Array of intervals: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
outputsize int	• Number of data points to retrieve • Default `30`
start_date string	• Format `2006-01-02` or `2006-01-02 15:04:05` • If timezone is given then, start_date will be used in the specified location
end_date string	• Format `2006-01-02` or `2006-01-02 15:04:05` • If timezone is given then, end_date will be used in the specified location
dp int	• Number of decimal places for floating values • Should be in range [0,11] inclusive. Default `5`
order string	• Sorting order of the output series • Supports: `ASC`, `DESC`; Default `DESC`
timezone string	• Timezone at which output datetime will be displayed • Supports: `Exchange`, `UTC` or timezone according to IANA Time Zone Database

General Parameters

Parameter	Details
symbols array	• Array of symbols • Format: `symbol:exchange:country`, where `exchange` and `country` are optional • Batch listing is not supported
apikey string	• Required parameter • Your personal API key, which you can obtain for free here • Type `string`
methods string or object	• Accepts: `time_series`, `quote`, `price` or any of the technical indicators. • Could be either a string with method name, then default parameters are taken. Alternatively, with object you might specify custom parameters.
common parameters	• Any of the parameters listed above

Method Parameters

Parameter	Details
name string or object	• Name of endpoint
common parameters	• Any of the parameters listed above

Response

The successful response body contains data array and status=ok. The array has the same format as the single API call, except when the error occurs where the additional meta-object is included.

API Usage

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

HTTP request example

https://api.twelvedata.com/api_usage?apikey=your_api_key

This request will return JSON with the following structure

{
  "timestamp": "2020-03-16 09:05:16",
  "current_usage": 4003,
  "plan_limit": 4181
}

HTTP route

/api_usage

API credits

1 per request

API parameters

Parameter	Details
apikey	• Required parameter • Your personal API key, which you can obtain for free here • Type `string`
format	• Parameter is optional • Value can be `CSV` or `JSON`; Default `JSON`
delimiter	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`

Response

Key	Description
timestamp	current timestamp in UTC timezone
current_usage	number of requests made in last minute
plan_limit	your personal API limit (requests/minute) depending on the plan

JSON request example

https://api.twelvedata.com/api_usage?apikey=your_api_key

Downloadable CSV example

https://api.twelvedata.com/api_usage?apikey=your_api_key&format=CSV

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.

Chaikin A/D Line(AD) calculates the Advance/Decline of an asset. This indicator belongs to the group of Volume Indicators.

This API call returns "meta" and "time_series" values of AD. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "AD - Chaikin A/D Line"
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "ad":"2262629.83773"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "ad":"2271951.53983"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "ad":"2344317.27255"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "ad":"2288433.82567"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "ad":"2467325.82567"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/ad

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of instrument • For preffered stocks use dot(.) delimiter E.g. `BRK.A` or `BRK.B` will be correct
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened
ad	ad value

JSON request example

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

https://api.twelvedata.com/ad?symbol=INFY&exchange=BSE&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/ad?symbol=AAPL&interval=30min&format=CSV&apikey=demo

ADD

Composite of values of two specified time series.

This API call returns "meta" and "time_series" values of ADD. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "add":"401.97"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "add":"401.98001"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "add":"402.2934"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "add":"402.83"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/add

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

interval string • Required parameter
• Interval between two consecutive points in time series
• Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 1day, 1week, 1month

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type_1

string

• Parameter is optional
• Price type used as the first part of technical indicator
• Default open
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

series_type_2

string

• Parameter is optional
• Price type used as the second part of technical indicator
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

type string • Parameter is optional
• 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, and Warrant

outputsize number • Parameter is optional
• 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

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

timezone string • Parameter is optional
• Timezone at which output datetime will be displayed
• Supports:
◦ Exchange for local exchange time
◦ UTC for datetime at universal UTC standard
◦ 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
• Type string; Default Exchange

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• 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:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	add value

JSON request example

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

https://api.twelvedata.com/add?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/add?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

ADOSC

Chaikin A/D Oscillator(ADOSC) is an indicator, which finds the relationship between increasing and decreasing volume with price fluctuations. The Chaikin Oscillator measures the momentum of the Accumulation/Distribution Line(ADL) using two Exponential Moving Averages of varying length to the line(MACD).

This API call returns "meta" and "time_series" values of ADOSC. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "adosc":"-214691.54601"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "adosc":"-188747.38536"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "adosc":"-160255.93296"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "adosc":"-115869.53282"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/adosc

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of instrument • For preffered stocks use dot(.) delimiter E.g. `BRK.A` or `BRK.B` will be correct
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
fast_period	number	• Parameter is optional • Number of periods for fast moving average. Takes values in the range from 1 to 800 • Default `12`
slow_period	number	• Parameter is optional • Number of periods for slow moving average. Takes values in the range from 1 to 800 • Default `26`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	adosc value

JSON request example

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

https://api.twelvedata.com/adosc?symbol=INFY&exchange=BSE&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/adosc?symbol=AAPL&interval=30min&format=CSV&apikey=demo

ADXHigh Demand

Average Directional Index(ADX) is used to decide if the price trend is strong.

This API call returns "meta" and "time_series" values of ADX. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "ADX - Average Directional Index",
         "time_period": 14
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "adx":"49.22897"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "adx":"47.73058"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "adx":"44.90916"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "adx":"41.9312"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "adx":"38.83754"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/adx

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
time_period	number	• Parameter is optional • Number of periods to average over. Takes values in the range from 1 to 800 • Default `14`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	adx value

JSON request example

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

https://api.twelvedata.com/adx?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/adx?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

ADXR

Average Directional Movement Index Rating(ADXR) is a smoothed version of the ADX indicator. ADXR quantifies momentum change in the ADX.

This API call returns "meta" and "time_series" values of ADXR. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "adxr":"36.83599"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "adxr":"35.58524"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "adxr":"34.41498"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "adxr":"33.21139"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/adxr

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
time_period	number	• Parameter is optional • Number of periods to average over. Takes values in the range from 1 to 800 • Default `14`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	adxr value

JSON request example

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

https://api.twelvedata.com/adxr?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/adxr?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

APO

Absolute Price Oscillator(APO) calculates the difference between two price moving averages.

This API call returns "meta" and "time_series" values of APO. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "APO - Absolute Price Oscillator",
         "fast_period": 12,
         "ma_type": "SMA",
         "series_type": "close",
         "slow_period": 26
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "apo":"-0.54508"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "apo":"-0.47169"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "apo":"-0.39004"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "apo":"-0.3087"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "apo":"-0.23315"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/apo

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

fast_period number • Parameter is optional
• Number of periods for fast moving average. Takes values in the range from 1 to 800
• Default 12

ma_type

string

• Parameter is optional
• Type of Moving Average to be used
• Default SMA
▸ Supports either code or name, according to the mapping:

Code	Name
0	SMA
1	EMA
2	WMA
3	DEMA
4	TEMA
5	TRIMA
6	KAMA
7	MAMA
8	T3MA

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

slow_period number • Parameter is optional
• Number of periods for slow moving average. Takes values in the range from 1 to 800
• Default 26

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	apo value

JSON request example

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

https://api.twelvedata.com/apo?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/apo?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

AROON

Aroon Indicator(AROON) is used to identify if the price is trending. It can also spot the beginning of a new trend and its strength.

This API call returns "meta" and "time_series" values of AROON. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "aroon_down":"100.0",
         "aroon_up":"7.14286"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "aroon_down":"100.0",
         "aroon_up":"0.0"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "aroon_down":"100.0",
         "aroon_up":"0.0"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "aroon_down":"100.0",
         "aroon_up":"7.14286"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/aroon

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
time_period	number	• Parameter is optional • Number of periods to average over. Takes values in the range from 1 to 800 • Default `14`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	aroon_down value
aroon_up	aroon_up value

JSON request example

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

https://api.twelvedata.com/aroon?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/aroon?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

AROONOSC

Aroon Oscillator(AROONOSC) uses classic Aroon(Aroon Up and Aroon down) to measure the strength of persisting trends and whether they will continue.

This API call returns "meta" and "time_series" values of AROONOSC. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "AROONOSC - Aroon Oscillator",
         "time_period": 14
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "aroonosc":"-92.85714"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "aroonosc":"-92.85714"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "aroonosc":"-100.0"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "aroonosc":"-100.0"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "aroonosc":"-92.85714"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/aroonosc

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
time_period	number	• Parameter is optional • Number of periods to average over. Takes values in the range from 1 to 800 • Default `14`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	aroonosc value

JSON request example

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

https://api.twelvedata.com/aroonosc?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/aroonosc?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

ATR

Average True Range(ATR) is used to measure market volatility by decomposing all asset prices over a specified time period.

This API call returns "meta" and "time_series" values of ATR. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "ATR - Average True Range",
         "time_period": 14
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "atr":"0.19828"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "atr":"0.18246"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "atr":"0.17419"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "atr":"0.17528"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "atr":"0.17133"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/atr

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
time_period	number	• Parameter is optional • Number of periods to average over. Takes values in the range from 1 to 800 • Default `14`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	atr value

JSON request example

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

https://api.twelvedata.com/atr?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/atr?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

AVG

Average(AVG) calculates the average value of series in a given time period. Widely used to calculate the 9-day average volume.

This API call returns "meta" and "time_series" values of AVG. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "AVG - Average",
         "series_type": "close",
         "time_period": 9
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "avg":"201.53871"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "avg":"201.69205"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "avg":"201.85111"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "avg":"202.03185"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "avg":"202.20237"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/avg

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	avg value

JSON request example

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

https://api.twelvedata.com/avg?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/avg?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

AVGPRICE

Average Price(AVGPRICE) uses the formula: (open + high + low + close) / 4.

This API call returns "meta" and "time_series" values of AVGPRICE. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "AVGPRICE - Average Price"
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "avgprice":"201.02449"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "avgprice":"200.98375"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "avgprice":"201.005"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "avgprice":"201.1117"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "avgprice":"201.43"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/avgprice

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	avgprice value

JSON request example

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

https://api.twelvedata.com/avgprice?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/avgprice?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

BBANDSHigh Demand

Bollinger Bands®(BBANDS) are volatility bands located above and below a moving average. The volatility size parameter depends on standard deviation.

This API call returns "meta" and "time_series" values of BBANDS. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "BBANDS - Bollinger Bands®",
         "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "upper_band":"203.39936",
         "middle_band":"202.13499",
         "lower_band":"200.87061"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "upper_band":"203.38227",
         "middle_band":"202.22324",
         "lower_band":"201.0642"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "upper_band":"203.32938",
         "middle_band":"202.30173",
         "lower_band":"201.27409"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "upper_band":"203.23305",
         "middle_band":"202.38007",
         "lower_band":"201.52709"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/bbands

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

ma_type

string

• Parameter is optional
• Type of Moving Average to be used
• Default SMA
▸ Supports either code or name, according to the mapping:

Code	Name
0	SMA
1	EMA
2	WMA
3	DEMA
4	TEMA
5	TRIMA
6	KAMA
7	MAMA
8	T3MA

sd number • Parameter is optional
• Number of standard deviations. Must be at least 1
• Default 2

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 20

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened
lower_band	lower_band value
middle_band	middle_band value
upper_band	upper_band value

JSON request example

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

https://api.twelvedata.com/bbands?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/bbands?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

BETA

Statistic Beta function.

This API call returns "meta" and "time_series" values of BETA. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "beta":"-0.31826"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "beta":"-0.60342"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "beta":"-0.4949"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "beta":"-0.24952"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/beta

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type_1

string

• Parameter is optional
• Price type used as the first part of technical indicator
• Default open
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

series_type_2

string

• Parameter is optional
• Price type used as the second part of technical indicator
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	beta value

JSON request example

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

https://api.twelvedata.com/beta?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/beta?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

BOP

Balance of Power(BOP) measures the relative strength between buyers and sellers by assessing the ability of move price to an extreme level.

This API call returns "meta" and "time_series" values of BOP. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "BOP - Balance of Power"
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "bop":"0.27231"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "bop":"-0.32758"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "bop":"0.0"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "bop":"-0.38215"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "bop":"-0.91305"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/bop

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	bop value

JSON request example

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

https://api.twelvedata.com/bop?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/bop?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

CCI

Commodity Channel Index(CCI) is a universal indicator that can help to identify new trends and assess current critical conditions.

This API call returns "meta" and "time_series" values of CCI. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "CCI - Commodity Channel Index",
         "time_period": 20
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "cci":"-122.30794"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "cci":"-152.88827"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "cci":"-180.08234"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "cci":"-206.65411"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "cci":"-225.40021"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/cci

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
time_period	number	• Parameter is optional • Number of periods to average over. Takes values in the range from 1 to 800 • Default `20`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	cci value

JSON request example

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

https://api.twelvedata.com/cci?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/cci?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

CEIL

Vector CEIL(CEIL) transforms input data with the mathematical ceil function.

This API call returns "meta" and "time_series" values of CEIL. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "CEIL - Vector CEIL",
         "series_type": "close"
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "ceil":"202.0"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "ceil":"201.0"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "ceil":"202.0"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "ceil":"202.0"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "ceil":"202.0"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/ceil

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	ceil value

JSON request example

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

https://api.twelvedata.com/ceil?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/ceil?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

CMO

Chande Momentum Oscillator(CMO) is used to show overbought and oversold conditions.

This API call returns "meta" and "time_series" values of CMO. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "cmo":"-91.96597"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "cmo":"-91.27229"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "cmo":"-91.16542"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "cmo":"-90.41306"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/cmo

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	cmo value

JSON request example

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

https://api.twelvedata.com/cmo?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/cmo?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

COPPOCK

Coppock Curve(COPPOCK) is usually used to detect long-term trend changes, typically on monthly charts.

This API call returns "meta" and "time_series" values of COPPOCK. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "COPPOCK - Coppock Curve",
         "long_roc_period": 14,
         "series_type": "close",
         "short_roc_period": 11,
         "wma_period": 10
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "coppock":"-1.37253"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "coppock":"-1.28978"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "coppock":"-1.14204"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "coppock":"-0.97805"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "coppock":"-0.78209"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/coppock

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

long_roc_period number • Parameter is optional
• Number of periods for long term rate of change. Takes values in the range from 1 to 800
• Default 14

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

short_roc_period number • Parameter is optional
• Number of periods for short term rate of change. Takes values in the range from 1 to 800
• Default 11

wma_period number • Parameter is optional
• Number of periods for weighted moving average. Takes values in the range from 1 to 800
• Default 10

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	coppock value

JSON request example

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

https://api.twelvedata.com/coppock?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/coppock?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

CORREL

Measures linear correlation between two time series. Takes values in the range from -1 to 1, where -1 is total negative correlation, 0 is no correlation, and 1 is total positive correlation.

This API call returns "meta" and "time_series" values of CORREL. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "correl":"0.94333"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "correl":"0.94225"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "correl":"0.9415"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "correl":"0.93658"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/correl

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type_1

string

• Parameter is optional
• Price type used as the first part of technical indicator
• Default open
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

series_type_2

string

• Parameter is optional
• Price type used as the second part of technical indicator
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	correl value

JSON request example

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

https://api.twelvedata.com/correl?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/correl?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

CRSI

ConnorsRSI(CRSI) is used to show the oversold and overbought levels of the RSI values.

This API call returns "meta" and "time_series" values of CRSI. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "CRSI - ConnorsRSI",
         "percent_rank_period": 100,
         "rsi_period": 3,
         "series_type": "close",
         "up_down_length": 2
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "crsi":"74.76102"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "crsi":"16.46438"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "crsi":"25.13687"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "crsi":"14.47102"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "crsi":"11.14242"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/crsi

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

percent_rank_period number • Parameter is optional
• Number of periods used to calculate PercentRank. Takes values in the range from 1 to 800
• Default 100

rsi_period number • Parameter is optional
• Number of periods for RSI used to calculate price momentum. Takes values in the range from 1 to 800
• Default 3

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

up_down_length number • Parameter is optional
• Number of periods for RSI used to calculate up/down trend. Takes values in the range from 1 to 800
• Default 2

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	crsi value

JSON request example

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

https://api.twelvedata.com/crsi?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/crsi?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

DEMA

Double Exponential Moving Average(DEMA) is used to eliminate lag. It does this by taking two Exponential Moving Averages(EMA).

This API call returns "meta" and "time_series" values of DEMA. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "dema":"200.98742"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "dema":"201.13274"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "dema":"201.30494"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "dema":"201.5495"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/dema

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	dema value

JSON request example

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

https://api.twelvedata.com/dema?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/dema?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

DIV

Division of values of two specified time series.

This API call returns "meta" and "time_series" values of DIV. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "div":"1.00144"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "div":"1.0008"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "div":"1.00113"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "div":"1.00343"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/div

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type_1

string

• Parameter is optional
• Price type used as the first part of technical indicator
• Default open
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

series_type_2

string

• Parameter is optional
• Price type used as the second part of technical indicator
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	div value

JSON request example

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

https://api.twelvedata.com/div?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/div?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

DPO

Detrended Price Oscillator(DPO) is used to separate price from the trend, in order to more clearly identify the length of cycles.

This API call returns "meta" and "time_series" values of DPO. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "DPO - Detrended Price Oscillator",
         "centered": false,
         "series_type": "close",
         "time_period": 21
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "dpo":"0.36828"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "dpo":"0.49811"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "dpo":"0.424"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "dpo":"0.35406"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "dpo":"0.25089"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/dpo

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

centered boolean • Parameter is optional
• Specifies if there should be a shift to match the current price
• Default false

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 21

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	dpo value

JSON request example

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

https://api.twelvedata.com/dpo?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/dpo?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

DX

Directional Movement Index(DX) identifies which direction the price is moving.

This API call returns "meta" and "time_series" values of DX. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "DX - Directional Movement Index",
         "time_period": 14
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "dx":"68.70803"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "dx":"84.40905"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "dx":"83.62259"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "dx":"82.14874"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "dx":"81.69497"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/dx

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
time_period	number	• Parameter is optional • Number of periods to average over. Takes values in the range from 1 to 800 • Default `14`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened
dx	dx value

JSON request example

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

https://api.twelvedata.com/dx?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/dx?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

EMAHigh Demand

Exponential Moving Average(EMA) places greater importance on recent data points than the normal Moving Average(MA).

This API call returns "meta" and "time_series" values of EMA. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "ema":"201.46387"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "ema":"201.59608"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "ema":"201.7401"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "ema":"201.91678"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/ema

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	ema value

JSON request example

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

https://api.twelvedata.com/ema?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/ema?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

EXP

Exponential(EXP) transforms input data with the mathematical exponent function.

This API call returns "meta" and "time_series" values of EXP. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "EXP - Exponential",
         "series_type": "close"
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "exp":"2.0649375034375067e+87"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "exp":"1.8406052690732023e+87"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "exp":"2.003911823447668e+87"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "exp":"2.030939306863562e+87"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "exp":"2.2369241889576382e+87"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/exp

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	exp value

JSON request example

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

https://api.twelvedata.com/exp?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/exp?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

FLOOR

Vector FLOOR(FLOOR) transforms input data with the mathematical floor function.

This API call returns "meta" and "time_series" values of FLOOR. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "FLOOR - Vector FLOOR",
         "series_type": "close"
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "floor":"201.0"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "floor":"200.0"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "floor":"201.0"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "floor":"201.0"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "floor":"201.0"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/floor

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	floor value

JSON request example

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

https://api.twelvedata.com/floor?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/floor?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

HEIKINASHICANDLES

Heikin-Ashi Candles(HEIKINASHICANDLES) translated from Japanese means "average bar". It can be used to detect market trends and predict future price fluctuations.

This API call returns "meta" and "time_series" values of HEIKINASHICANDLES. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "heikinhighs":"201.13",
         "heikinopens":"201.02",
         "heikincloses":"200.98375",
         "heikinlows":"200.84"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "heikinhighs":"201.07001",
         "heikinopens":"201.0767",
         "heikincloses":"201.005",
         "heikinlows":"200.91"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "heikinhighs":"201.25999",
         "heikinopens":"201.445",
         "heikincloses":"201.1117",
         "heikinlows":"201.0334"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "heikinhighs":"201.75999",
         "heikinopens":"201.77",
         "heikincloses":"201.43",
         "heikinlows":"201.07001"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/heikinashicandles

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened
heikincloses	heikincloses value
heikinhighs	heikinhighs value
heikinlows	heikinlows value
heikinopens	heikinopens value

JSON request example

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

https://api.twelvedata.com/heikinashicandles?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/heikinashicandles?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

HLC3

High, Low, Close Average Values(HLC3) give alternative candlesticks patter. Every element is defined as follows: (high + low + close) / 3.

This API call returns "meta" and "time_series" values of HLC3. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "HLC3 - High, Low, Close Average Values"
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "hlc3":"201.05266"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "hlc3":"200.96833"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "hlc3":"201.00001"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "hlc3":"201.10893"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "hlc3":"201.32"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/hlc3

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	hlc3 value

JSON request example

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

https://api.twelvedata.com/hlc3?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/hlc3?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

HT_DCPERIOD

Hilbert Transform Dominant Cycle Period(HT_DCPERIOD) is part of Hilbert Transforms concepts. You can read more about it in the Rocket Science for Traders book by John F. Ehlers.

This API call returns "meta" and "time_series" values of HT_DCPERIOD. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "ht_dcperiod":"27.7569"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "ht_dcperiod":"27.72609"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "ht_dcperiod":"27.26459"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "ht_dcperiod":"27.00303"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/ht_dcperiod

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	ht_dcperiod value

JSON request example

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

https://api.twelvedata.com/ht_dcperiod?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/ht_dcperiod?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

HT_DCPHASE

Hilbert Transform Dominant Cycle Phase(HT_DCPHASE) is part of Hilbert Transforms concepts. You can read more about it in the Rocket Science for Traders book by John F. Ehlers.

This API call returns "meta" and "time_series" values of HT_DCPHASE. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "ht_dcphase":"-44.28698"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "ht_dcphase":"310.07743"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "ht_dcphase":"306.54431"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "ht_dcphase":"299.8704"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/ht_dcphase

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	ht_dcphase value

JSON request example

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

https://api.twelvedata.com/ht_dcphase?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/ht_dcphase?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

HT_PHASOR

Hilbert Transform Phasor Components(HT_PHASOR) is part of Hilbert Transforms concepts. You can read more about it in the Rocket Science for Traders book by John F. Ehlers.

This API call returns "meta" and "time_series" values of HT_PHASOR. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "in_phase":"-0.61937",
         "quadrature":"-0.09941"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "in_phase":"-0.60477",
         "quadrature":"-0.16807"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "in_phase":"-0.57758",
         "quadrature":"-0.19125"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "in_phase":"-0.52678",
         "quadrature":"-0.33813"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/ht_phasor

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	in_phase value
quadrature	quadrature value

JSON request example

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

https://api.twelvedata.com/ht_phasor?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/ht_phasor?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

HT_SINE

Hilbert Transform SineWave(HT_SINE) is part of Hilbert Transforms concepts. You can read more about it in the Rocket Science for Traders book by John F. Ehlers.

This API call returns "meta" and "time_series" values of HT_SINE. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "ht_sine":"-0.69825",
         "ht_leadsine":"0.01244"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "ht_sine":"-0.76518",
         "ht_leadsine":"-0.08581"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "ht_sine":"-0.8034",
         "ht_leadsine":"-0.14704"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "ht_sine":"-0.86715",
         "ht_leadsine":"-0.261"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/ht_sine

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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_leadsine	ht_leadsine value
ht_sine	ht_sine value

JSON request example

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

https://api.twelvedata.com/ht_sine?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/ht_sine?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

HT_TRENDLINE

Hilbert Transform Instantaneous Trendline(HT_TRENDLINE) comes from the concept of Digital Signal Processing (DSP). It creates complex signals from the simple chart data. You can read more about it in the Rocket Science for Traders book by John F. Ehlers.

This API call returns "meta" and "time_series" values of HT_TRENDLINE. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "ht_trendline":"202.31889"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "ht_trendline":"202.37263"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "ht_trendline":"202.42115"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "ht_trendline":"202.4659"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/ht_trendline

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	ht_trendline value

JSON request example

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

https://api.twelvedata.com/ht_trendline?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/ht_trendline?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

HT_TRENDMODE

Hilbert Transform Trend vs. Cycle Mode(HT_TRENDMODE) is part of Hilbert Transforms concepts. You can read more about it in the Rocket Science for Traders book by John F. Ehlers.

This API call returns "meta" and "time_series" values of HT_TRENDMODE. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "ht_trendmode":"0"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "ht_trendmode":"0"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "ht_trendmode":"0"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "ht_trendmode":"0"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/ht_trendmode

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	ht_trendmode value

JSON request example

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

https://api.twelvedata.com/ht_trendmode?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/ht_trendmode?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

ICHIMOKU

Ichimoku Kinkō Hyō(ICHIMOKU) is a group of technical indicators that shows trend direction, momentum, and support & resistance levels. Overall it tends to improve the accuracy of forecasts.

This API call returns "meta" and "time_series" values of ICHIMOKU. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "ICHIMOKU - Ichimoku Kinkō Hyō",
         "base_line_period": 26,
         "conversion_line_period": 9,
         "include_ahead_span_period": true,
         "lagging_span_period": 26,
         "leading_span_b_period": 52
      }
   },
   "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "tenkan_sen":"200.64",
         "kijun_sen":"201.6175",
         "senkou_span_a":"201.4925",
         "senkou_span_b":"200.395",
         "chikou_span":"199.95499"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "tenkan_sen":"200.16",
         "kijun_sen":"201.25",
         "senkou_span_a":"201.5175",
         "senkou_span_b":"200.445",
         "chikou_span":"199.95499"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "tenkan_sen":"200.16",
         "kijun_sen":"201.6175",
         "senkou_span_a":"201.6025",
         "senkou_span_b":"200.41",
         "chikou_span":"199.95499"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "tenkan_sen":"200.64",
         "kijun_sen":"201.6175",
         "senkou_span_a":"201.25",
         "senkou_span_b":"200.445",
         "chikou_span":"199.95499"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/ichimoku

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
base_line_period	number	• Parameter is optional • Takes values in the range from 1 to 800 • Default `26`
conversion_line_period	number	• Parameter is optional • Takes values in the range from 1 to 800 • Default `9`
include_ahead_span_period	boolean	• Parameter is optional • Specifies if the span values ahead the current moment should be returned • Default `true`
lagging_span_period	number	• Parameter is optional • Takes values in the range from 1 to 800 • Default `26`
leading_span_b_period	number	• Parameter is optional • Takes values in the range from 1 to 800 • Default `52`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened
chikou_span	chikou_span value
kijun_sen	kijun_sen value
senkou_span_a	senkou_span_a value
senkou_span_b	senkou_span_b value
tenkan_sen	tenkan_sen value

JSON request example

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

https://api.twelvedata.com/ichimoku?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/ichimoku?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

KAMA

Kaufman's Adaptive Moving Average(KAMA) is a type of Moving Average(MA) that incorporates market noise and volatility.

This API call returns "meta" and "time_series" values of KAMA. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "kama":"201.07559"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "kama":"201.18807"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "kama":"201.32251"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "kama":"201.5538"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/kama

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	kama value

JSON request example

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

https://api.twelvedata.com/kama?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/kama?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

KELTNER

Keltner Channels(KELTNER) is a volatility indicator used to spot trend changes and accelerations.

This API call returns "meta" and "time_series" values of KELTNER. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "KELTNER - Keltner Channels",
         "atr_time_period": 10,
         "ma_type": "SMA",
         "multiplier": 2,
         "series_type": "close",
         "time_period": 20
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "upper_line":"202.25298",
         "middle_line":"201.80985",
         "lower_line":"201.36672"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "upper_line":"202.29242",
         "middle_line":"201.88983",
         "lower_line":"201.48724"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "upper_line":"202.37322",
         "middle_line":"201.99034",
         "lower_line":"201.60746"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "upper_line":"202.48234",
         "middle_line":"202.09248",
         "lower_line":"201.70262"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "upper_line":"202.58679",
         "middle_line":"202.20396",
         "lower_line":"201.82114"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/keltner

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

atr_time_period number • Parameter is optional
• Takes values in the range from 1 to 800
• Default 10

ma_type

string

• Parameter is optional
• Type of Moving Average to be used
• Default SMA
▸ Supports either code or name, according to the mapping:

Code	Name
0	SMA
1	EMA
2	WMA
3	DEMA
4	TEMA
5	TRIMA
6	KAMA
7	MAMA
8	T3MA

multiplier number • Parameter is optional
• Multiplier is the number by which the range is shifted
• Default 2

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 20

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened
lower_line	lower_line value
middle_line	middle_line value
upper_line	upper_line value

JSON request example

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

https://api.twelvedata.com/keltner?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/keltner?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

KST

Know Sure Thing(KST) calculates price momentum for four distinct price cycles(ROC).

This API call returns "meta" and "time_series" values of KST. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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,
         "signal_period": 9,
         "sma_period_1": 10,
         "sma_period_2": 10,
         "sma_period_3": 10,
         "sma_period_4": 15
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "kst":"-4.58644",
         "kst_signal":"-2.05236"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "kst":"-3.99247",
         "kst_signal":"-1.50883"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "kst":"-3.30038",
         "kst_signal":"-1.00471"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "kst":"-2.5665",
         "kst_signal":"-0.55332"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "kst":"-1.83607",
         "kst_signal":"-0.16218"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/kst

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
roc_period_1	number	• Parameter is optional • Takes values in the range from 1 to 800 • Default `10`
roc_period_2	number	• Parameter is optional • Takes values in the range from 1 to 800 • Default `15`
roc_period_3	number	• Parameter is optional • Takes values in the range from 1 to 800 • Default `20`
roc_period_4	number	• Parameter is optional • Takes values in the range from 1 to 800 • Default `30`
signal_period	number	• Parameter is optional • Takes values in the range from 1 to 800 • Default `9`
sma_period_1	number	• Parameter is optional • Takes values in the range from 1 to 800 • Default `10`
sma_period_2	number	• Parameter is optional • Takes values in the range from 1 to 800 • Default `10`
sma_period_3	number	• Parameter is optional • Takes values in the range from 1 to 800 • Default `10`
sma_period_4	number	• Parameter is optional • Takes values in the range from 1 to 800 • Default `15`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	kst value
kst_signal	kst_signal value

JSON request example

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

https://api.twelvedata.com/kst?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/kst?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

LINEARREG

Linear Regression(LINEARREG) is used to determine trend direction by a straight line.

This API call returns "meta" and "time_series" values of LINEARREG. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "linearreg":"200.83317"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "linearreg":"200.98073"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "linearreg":"201.16126"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "linearreg":"201.39886"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/linearreg

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	linearreg value

JSON request example

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

https://api.twelvedata.com/linearreg?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/linearreg?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

LINEARREGANGLE

Linear Regression Angle(LINEARREGANGLE) calculates the angle of the linear regression trendline.

This API call returns "meta" and "time_series" values of LINEARREGANGLE. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "linearregangle":"-10.00332"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "linearregangle":"-10.08348"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "linearregangle":"-9.78514"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "linearregangle":"-8.99228"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/linearregangle

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	linearregangle value

JSON request example

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

https://api.twelvedata.com/linearregangle?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/linearregangle?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

LINEARREGINTERCEPT

Linear Regression Intercept(LINEARREGINTERCEPT) calculates the intercept for the linear regression trendline for each data point.

This API call returns "meta" and "time_series" values of LINEARREGINTERCEPT. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "LINEARREGINTERCEPT - Linear Regression Intercept",
         "series_type": "close",
         "time_period": 9
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "linearregintercept":"202.03082"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "linearregintercept":"202.24426"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "linearregintercept":"202.40337"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "linearregintercept":"202.54097"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "linearregintercept":"202.66483"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/linearregintercept

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	linearregintercept value

JSON request example

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

https://api.twelvedata.com/linearregintercept?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/linearregintercept?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

LINEARREGSLOPE

Linear Regression Slope(LINEARREGSLOPE) calculates the slope for the linear regression trendline for each data point.

This API call returns "meta" and "time_series" values of LINEARREGSLOPE. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "linearregslope":"-0.17639"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "linearregslope":"-0.17783"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "linearregslope":"-0.17246"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "linearregslope":"-0.15825"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/linearregslope

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	linearregslope value

JSON request example

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

https://api.twelvedata.com/linearregslope?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/linearregslope?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

LN

Natural Logarithm to the base of constant e(LN) transforms all data points with natural logarithm.

This API call returns "meta" and "time_series" values of LN. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "ln":"5.30298"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "ln":"5.3034"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "ln":"5.30347"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "ln":"5.30395"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/ln

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened
ln	ln value

JSON request example

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

https://api.twelvedata.com/ln?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/ln?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

LOG10

Logarithm to base 10(LOG10) transforms all data points with logarithm to base 10.

This API call returns "meta" and "time_series" values of LOG10. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "LOG10 - Logarithm to base 10",
         "series_type": "close"
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "log10":"2.3033"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "log10":"2.30306"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "log10":"2.30324"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "log10":"2.30327"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "log10":"2.30348"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/log10

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	log10 value

JSON request example

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

https://api.twelvedata.com/log10?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/log10?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

MA

Moving Average(MA) is used to smooth out price fluctuations and get rid of market noise.

This API call returns "meta" and "time_series" values of MA. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "MA - Moving Average",
         "ma_type": "SMA",
         "series_type": "close",
         "time_period": 9
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "ma":"201.41205"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "ma":"201.53871"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "ma":"201.69205"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "ma":"201.85111"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "ma":"202.03185"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/ma

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

ma_type

string

• Parameter is optional
• Type of Moving Average to be used
• Default SMA
▸ Supports either code or name, according to the mapping:

Code	Name
0	SMA
1	EMA
2	WMA
3	DEMA
4	TEMA
5	TRIMA
6	KAMA
7	MAMA
8	T3MA

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened
ma	ma value

JSON request example

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

https://api.twelvedata.com/ma?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/ma?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

MACDHigh Demand

Moving Average Convergence Divergence(MACD) is a trend following momentum indicator, which works by subtracting the longer moving average from the shorter one. MACD has an unstable period ~ 100.

This API call returns "meta" and "time_series" values of MACD. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "MACD - Moving Average Convergence Divergence",
         "fast_period": 12,
         "series_type": "close",
         "signal_period": 9,
         "slow_period": 26
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "macd":"-0.3998",
         "macd_signal":"-0.25279",
         "macd_hist":"-0.147"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "macd":"-0.38253",
         "macd_signal":"-0.21604",
         "macd_hist":"-0.16649"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "macd":"-0.34322",
         "macd_signal":"-0.17442",
         "macd_hist":"-0.1688"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "macd":"-0.29671",
         "macd_signal":"-0.13222",
         "macd_hist":"-0.16449"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "macd":"-0.23439",
         "macd_signal":"-0.0911",
         "macd_hist":"-0.14329"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/macd

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

fast_period number • Parameter is optional
• Number of periods for fast moving average. Takes values in the range from 1 to 800
• Default 12

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

signal_period number • Parameter is optional
• Takes values in the range from 1 to 800
• Default 9

slow_period number • Parameter is optional
• Number of periods for slow moving average. Takes values in the range from 1 to 800
• Default 26

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	macd value
macd_hist	macd_hist value
macd_signal	macd_signal value

JSON request example

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

https://api.twelvedata.com/macd?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/macd?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

MACD SLOPEPro+

Moving Average Convergence Divergence Regression Slope(MACD_SLOPE) shows slopes of macd line, signal line, and histogram. A negative and rising slope shows improvement within a downtrend. A positive and falling slope shows deterioration within an uptrend. MACD has an unstable period of ~ 100.

This API call returns "meta" and "time_series" values of MACD SLOPE. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NASDAQ",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "macd_slope":"0.03856",
         "macd_signal_slope":"0.03341",
         "macd_hist_slope":"0.00515"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "macd_slope":"0.14684",
         "macd_signal_slope":"0.03213",
         "macd_hist_slope":"0.11472"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "macd_slope":"0.13934",
         "macd_signal_slope":"0.00345",
         "macd_hist_slope":"0.13590"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "macd_slope":"0.08193",
         "macd_signal_slope":"-0.03053",
         "macd_hist_slope":"0.11246"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/macd_slope

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

fast_period number • Parameter is optional
• Number of periods for fast moving average. Takes values in the range from 1 to 800
• Default 12

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

signal_period number • Parameter is optional
• Takes values in the range from 1 to 800
• Default 9

slow_period number • Parameter is optional
• Number of periods for slow moving average. Takes values in the range from 1 to 800
• Default 26

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 10

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	macd slope value
macd_signal_slope	macd signal slope value
macd_hist_slope	macd hist slope value

JSON request example

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

https://api.twelvedata.com/macd_slope?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/macd_slope?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

MACDEXT

Moving Average Convergence Divergence Extended(MACDEXT) gives greater control over MACD input parameters. MACDEXT has an unstable period ~ 100.

This API call returns "meta" and "time_series" values of MACDEXT. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "MACDEXT - Moving Average Convergence Divergence Extended",
         "fast_ma_type": "SMA",
         "fast_period": 12,
         "series_type": "close",
         "signal_ma_type": "SMA",
         "signal_period": 9,
         "slow_ma_type": "SMA",
         "slow_period": 26
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "macd":"-0.54508",
         "macd_signal":"-0.25615",
         "macd_hist":"-0.28894"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "macd":"-0.47169",
         "macd_signal":"-0.19324",
         "macd_hist":"-0.27845"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "macd":"-0.39004",
         "macd_signal":"-0.13498",
         "macd_hist":"-0.25506"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "macd":"-0.3087",
         "macd_signal":"-0.08378",
         "macd_hist":"-0.22492"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "macd":"-0.23315",
         "macd_signal":"-0.03994",
         "macd_hist":"-0.1932"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/macdext

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

fast_ma_type

string

• Parameter is optional
• Type of Moving Average to be used on Fast Period
• Default SMA
▸ Supports either code or name, according to the mapping:

Code	Name
0	SMA
1	EMA
2	WMA
3	DEMA
4	TEMA
5	TRIMA
6	KAMA
7	MAMA
8	T3MA

fast_period number • Parameter is optional
• Number of periods for fast moving average. Takes values in the range from 1 to 800
• Default 12

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

signal_ma_type

string

• Parameter is optional
• Type of Moving Average to be used on Signal Period
• Default SMA
▸ Supports either code or name, according to the mapping:

Code	Name
0	SMA
1	EMA
2	WMA
3	DEMA
4	TEMA
5	TRIMA
6	KAMA
7	MAMA
8	T3MA

signal_period number • Parameter is optional
• Takes values in the range from 1 to 800
• Default 9

slow_ma_type

string

• Parameter is optional
• Type of Moving Average to be used on Slow Period
• Default SMA
▸ Supports either code or name, according to the mapping:

Code	Name
0	SMA
1	EMA
2	WMA
3	DEMA
4	TEMA
5	TRIMA
6	KAMA
7	MAMA
8	T3MA

slow_period number • Parameter is optional
• Number of periods for slow moving average. Takes values in the range from 1 to 800
• Default 26

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	macd value
macd_hist	macd_hist value
macd_signal	macd_signal value

JSON request example

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

https://api.twelvedata.com/macdext?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/macdext?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

MAMA

MESA Adaptive Moving Average(MAMA) adapts to price fluctuations based on the rate of change of the Hilbert Transform Discriminator. More about MAMA can be read here.

This API call returns "meta" and "time_series" values of MAMA. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "MAMA - MESA Adaptive Moving Average",
         "fast_limit": 0.5,
         "series_type": "close",
         "slow_limit": 0.05
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "mama":"201.38887",
         "fama":"202.05517"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "mama":"201.72774",
         "fama":"202.27727"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "mama":"201.79478",
         "fama":"202.29956"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "mama":"201.96391",
         "fama":"202.34923"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "mama":"202.01288",
         "fama":"202.35911"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/mama

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

fast_limit number • Parameter is optional
• Default 0.5

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

slow_limit number • Parameter is optional
• Default 0.05

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened
fama	fama value
mama	mama value

JSON request example

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

https://api.twelvedata.com/mama?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/mama?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

MAX

Highest value over period(MAX).

This API call returns "meta" and "time_series" values of MAX. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "max":"202.19"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "max":"202.315"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "max":"202.4516"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "max":"202.66"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/max

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	max value

JSON request example

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

https://api.twelvedata.com/max?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/max?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

MAXINDEX

Index of highest value over period(MAXINDEX).

This API call returns "meta" and "time_series" values of MAXINDEX. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "maxidx":"490"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "maxidx":"489"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "maxidx":"488"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "maxidx":"487"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/maxindex

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	maxidx value

JSON request example

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

https://api.twelvedata.com/maxindex?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/maxindex?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

MCGINLEY_DYNAMIC

McGinley Dynamic(MCGINLEY_DYNAMIC) keeps all the benefits from the moving averages but adds an adjustment to market speed.

This API call returns "meta" and "time_series" values of MCGINLEY_DYNAMIC. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "MCGINLEY_DYNAMIC - McGinley Dynamic",
         "time_period": 14
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "mcginley_dynamic":"201.93983"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "mcginley_dynamic":"202.00969"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "mcginley_dynamic":"202.09444"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "mcginley_dynamic":"202.17916"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "mcginley_dynamic":"202.26966"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/mcginley_dynamic

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
time_period	number	• Parameter is optional • Number of periods to average over. Takes values in the range from 1 to 800 • Default `14`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	mcginley_dynamic value

JSON request example

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

https://api.twelvedata.com/mcginley_dynamic?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/mcginley_dynamic?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

MEDPRICE

Median Price(MEDPRICE).

This API call returns "meta" and "time_series" values of MEDPRICE. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "MEDPRICE - Median Price"
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "medprice":"201.05399"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "medprice":"200.985"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "medprice":"200.99001"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "medprice":"201.1467"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "medprice":"201.415"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/medprice

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	medprice value

JSON request example

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

https://api.twelvedata.com/medprice?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/medprice?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

MFI

Money Flow Index(MFI) is used to identify overbought and oversold levels in an asset. In some cases, it can be used to detect divergences, which might be a sign of upcoming trend changes.

This API call returns "meta" and "time_series" values of MFI. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "MFI - Money Flow Index",
         "time_period": 14
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "mfi":"22.68525"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "mfi":"6.39625"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "mfi":"7.00498"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "mfi":"7.36599"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "mfi":"7.91187"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/mfi

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of instrument • For preffered stocks use dot(.) delimiter E.g. `BRK.A` or `BRK.B` will be correct
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
time_period	number	• Parameter is optional • Number of periods to average over. Takes values in the range from 1 to 800 • Default `14`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	mfi value

JSON request example

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

https://api.twelvedata.com/mfi?symbol=INFY&exchange=BSE&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/mfi?symbol=AAPL&interval=30min&format=CSV&apikey=demo

MIDPOINT

MidPoint over period(MIDPOINT) is calculated as (highest value + lowest value) / 2.

This API call returns "meta" and "time_series" values of MIDPOINT. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "midpoint":"201.5625"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "midpoint":"201.6675"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "midpoint":"201.7425"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "midpoint":"201.895"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/midpoint

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	midpoint value

JSON request example

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

https://api.twelvedata.com/midpoint?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/midpoint?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

MIDPRICE

Midpoint Price over period(MIDPRICE) is calculated as (highest high + lowest low) / 2.

This API call returns "meta" and "time_series" values of MIDPRICE. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "MIDPRICE - Midpoint Price over period",
         "time_period": 9
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "midprice":"201.535"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "midprice":"201.595"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "midprice":"201.68501"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "midprice":"201.8417"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "midprice":"201.88"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/midprice

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
time_period	number	• Parameter is optional • Number of periods to average over. Takes values in the range from 1 to 800 • Default `9`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	midprice value

JSON request example

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

https://api.twelvedata.com/midprice?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/midprice?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

MIN

Lowest value over period(MIN).

This API call returns "meta" and "time_series" values of MIN. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "min":"200.935"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "min":"201.02"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "min":"201.0334"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "min":"201.13"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/min

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	min value

JSON request example

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

https://api.twelvedata.com/min?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/min?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

MININDEX

Index of lowest value over period(MININDEX).

This API call returns "meta" and "time_series" values of MININDEX. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "minidx":"498"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "minidx":"497"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "minidx":"496"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "minidx":"495"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/minindex

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	minidx value

JSON request example

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

https://api.twelvedata.com/minindex?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/minindex?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

MINMAX

Lowest and highest values over period(MINMAX).

This API call returns "meta" and "time_series" values of MINMAX. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "min":"200.935",
         "max":"202.19"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "min":"201.02",
         "max":"202.315"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "min":"201.0334",
         "max":"202.4516"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "min":"201.13",
         "max":"202.66"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/minmax

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	max value
min	min value

JSON request example

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

https://api.twelvedata.com/minmax?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/minmax?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

MINMAXINDEX

Indexes of lowest and highest values over period(MINMAXINDEX).

This API call returns "meta" and "time_series" values of MINMAXINDEX. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "minidx":"498",
         "maxidx":"490"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "minidx":"497",
         "maxidx":"489"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "minidx":"496",
         "maxidx":"488"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "minidx":"495",
         "maxidx":"487"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/minmaxindex

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	maxidx value
minidx	minidx value

JSON request example

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

https://api.twelvedata.com/minmaxindex?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/minmaxindex?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

MINUS_DI

Minus Directional Indicator(MINUS_DI) is a component of the Average Directional Index(ADX), and it measures the existence of downtrend.

This API call returns "meta" and "time_series" values of MINUS_DI. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "minus_di":"57.93427"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "minus_di":"64.13795"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "minus_di":"62.85341"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "minus_di":"69.49652"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/minus_di

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
time_period	number	• Parameter is optional • Number of periods to average over. Takes values in the range from 1 to 800 • Default `9`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	minus_di value

JSON request example

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

https://api.twelvedata.com/minus_di?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/minus_di?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

MINUS_DM

Minus Directional Movement(MINUS_DM) is calculated as Previous Low - Low.

This API call returns "meta" and "time_series" values of MINUS_DM. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "minus_dm":"1.08327"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "minus_dm":"1.13992"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "minus_dm":"1.14359"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "minus_dm":"1.24536"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/minus_dm

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
time_period	number	• Parameter is optional • Number of periods to average over. Takes values in the range from 1 to 800 • Default `9`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	minus_dm value

JSON request example

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

https://api.twelvedata.com/minus_dm?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/minus_dm?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

MOM

Momentum(MOM) compares the current price with the previous price N timeperiods ago.

This API call returns "meta" and "time_series" values of MOM. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "MOM - Momentum",
         "series_type": "close",
         "time_period": 9
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "mom":"-1.14"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "mom":"-1.38"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "mom":"-1.43159"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "mom":"-1.6266"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "mom":"-1.5347"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/mom

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	mom value

JSON request example

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

https://api.twelvedata.com/mom?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/mom?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

MULT

Multiplication of values of two specified time series.

This API call returns "meta" and "time_series" values of MULT. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "mult":"40394.94944"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "mult":"40396.97591"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "mult":"40459.98128"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "mult":"40567.88357"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/mult

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type_1

string

• Parameter is optional
• Price type used as the first part of technical indicator
• Default open
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

series_type_2

string

• Parameter is optional
• Price type used as the second part of technical indicator
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	mult value

JSON request example

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

https://api.twelvedata.com/mult?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/mult?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

NATR

Normalized Average True Range(NATR) is used to compare and analyze across different price levels due to its normalized quality, which might be more effective than the original ATR.

This API call returns "meta" and "time_series" values of NATR. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "NATR - Normalized Average True Range",
         "time_period": 14
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "natr":"0.09862"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "natr":"0.0908"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "natr":"0.08665"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "natr":"0.08719"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "natr":"0.08518"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/natr

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
time_period	number	• Parameter is optional • Number of periods to average over. Takes values in the range from 1 to 800 • Default `14`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	natr value

JSON request example

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

https://api.twelvedata.com/natr?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/natr?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

OBV

On Balance Volume(OBV) is a momentum indicator, which uses volume flow to forecast upcoming price changes.

This API call returns "meta" and "time_series" values of OBV. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "OBV - On Balance Volume",
         "series_type": "close"
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "obv":"540374.0"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "obv":"68087.0"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "obv":"277941.0"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "obv":"426973.0"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "obv":"605865.0"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/obv

API credits

1 per symbol

API parameters

Key Type Description

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

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	obv value

JSON request example

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

https://api.twelvedata.com/obv?symbol=INFY&exchange=BSE&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/obv?symbol=AAPL&interval=30min&format=CSV&apikey=demo

PERCENT_BHigh Demand

%B Indicator(PERCENT_B) measures the position of an asset price relative to upper and lower Bollinger Bands.

This API call returns "meta" and "time_series" values of PERCENT_B. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "PERCENT_B - %B Indicator",
         "ma_type": "SMA",
         "sd": 2,
         "series_type": "close",
         "time_period": 20
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "percent_b":"0.11981"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "percent_b":"0.02546"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "percent_b":"-0.01907"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "percent_b":"-0.11711"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "percent_b":"-0.23276"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/percent_b

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

ma_type

string

• Parameter is optional
• Type of Moving Average to be used
• Default SMA
▸ Supports either code or name, according to the mapping:

Code	Name
0	SMA
1	EMA
2	WMA
3	DEMA
4	TEMA
5	TRIMA
6	KAMA
7	MAMA
8	T3MA

sd number • Parameter is optional
• Number of standard deviations. Must be at least 1
• Default 2

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 20

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	percent_b value

JSON request example

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

https://api.twelvedata.com/percent_b?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/percent_b?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

PIVOT_POINTS_HLPro+

Pivot Points (High/Low) (PIVOT_POINTS_HL) are typically used to foresee potential price reversals.

This API call returns "meta" and "time_series" values of PIVOT_POINTS_HL. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NASDAQ",
      "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":0,
         "pivot_point_l":0
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "pivot_point_h":0,
         "pivot_point_l":1
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "pivot_point_h":0,
         "pivot_point_l":0
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "pivot_point_h":0,
         "pivot_point_l":0
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "pivot_point_h":1,
         "pivot_point_l":0
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/pivot_points_hl

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
time_period	number	• Parameter is optional • Number of periods to average over. Takes values in the range from 1 to 800 • Default `10`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	1 if it is a high pivot point, otherwise 0
pivot_point_l	1 if it is a low pivot point, otherwise 0

JSON request example

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

https://api.twelvedata.com/pivot_points_hl?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/pivot_points_hl?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

PLUS_DI

Plus Directional Indicator(PLUS_DI) is a component of the Average Directional Index(ADX), and it measures the existence of uptrend.

This API call returns "meta" and "time_series" values of PLUS_DI. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "plus_di":"1.98638"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "plus_di":"2.35103"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "plus_di":"2.58362"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "plus_di":"2.95115"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/plus_di

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
time_period	number	• Parameter is optional • Number of periods to average over. Takes values in the range from 1 to 800 • Default `9`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	plus_di value

JSON request example

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

https://api.twelvedata.com/plus_di?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/plus_di?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

PLUS_DM

Plus Directional Movement(PLUS_DM) is calculated as High - Previous High.

This API call returns "meta" and "time_series" values of PLUS_DM. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "plus_dm":"0.03714"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "plus_dm":"0.04178"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "plus_dm":"0.04701"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "plus_dm":"0.05288"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/plus_dm

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
time_period	number	• Parameter is optional • Number of periods to average over. Takes values in the range from 1 to 800 • Default `9`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	plus_dm value

JSON request example

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

https://api.twelvedata.com/plus_dm?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/plus_dm?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

PPO

Percentage Price Oscillator(PPO) shows the relationship between two Moving Averages(MA) as a percentage.

This API call returns "meta" and "time_series" values of PPO. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "PPO - Percentage Price Oscillator",
         "fast_period": 12,
         "ma_type": "SMA",
         "series_type": "close",
         "slow_period": 26
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "ppo":"-0.2696"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "ppo":"-0.23323"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "ppo":"-0.1928"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "ppo":"-0.15255"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "ppo":"-0.11518"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/ppo

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

fast_period number • Parameter is optional
• Number of periods for fast moving average. Takes values in the range from 1 to 800
• Default 12

ma_type

string

• Parameter is optional
• Type of Moving Average to be used
• Default SMA
▸ Supports either code or name, according to the mapping:

Code	Name
0	SMA
1	EMA
2	WMA
3	DEMA
4	TEMA
5	TRIMA
6	KAMA
7	MAMA
8	T3MA

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

slow_period number • Parameter is optional
• Number of periods for slow moving average. Takes values in the range from 1 to 800
• Default 26

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	ppo value

JSON request example

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

https://api.twelvedata.com/ppo?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/ppo?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

ROC

Rate of change(ROC) calculates the rate of change between the current price and price n timeperiods ago. Formula: ((price / prevPrice) - 1) * 100.

This API call returns "meta" and "time_series" values of ROC. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "roc":"-0.68211"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "roc":"-0.70713"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "roc":"-0.80263"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "roc":"-0.75726"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/roc

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	roc value

JSON request example

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

https://api.twelvedata.com/roc?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/roc?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

ROCP

Rate of change percentage(ROCP) calculates the rate of change in % between the current price and price n timeperiods ago. Formula: (price - prevPrice) / prevPrice.

This API call returns "meta" and "time_series" values of ROCP. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "rocp":"-0.00682"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "rocp":"-0.00707"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "rocp":"-0.00803"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "rocp":"-0.00757"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/rocp

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	rocp value

JSON request example

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

https://api.twelvedata.com/rocp?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/rocp?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

ROCR

Rate of change ratio(ROCR) calculates the ratio between the current price and price n timeperiods ago. Formula: (price / prevPrice).

This API call returns "meta" and "time_series" values of ROCR. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "ROCR - Rate of change ratio",
         "series_type": "close",
         "time_period": 9
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "rocr":"0.99436"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "rocr":"0.99318"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "rocr":"0.99293"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "rocr":"0.99197"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "rocr":"0.99243"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/rocr

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	rocr value

JSON request example

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

https://api.twelvedata.com/rocr?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/rocr?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

ROCR100

Rate of change ratio 100 scale(ROCR100) calculates the ratio with 100 scale between the current price and price n timeperiods ago. Formula: (price / prevPrice) * 100.

This API call returns "meta" and "time_series" values of ROCR100. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "rocr100":"99.31789"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "rocr100":"99.29287"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "rocr100":"99.19737"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "rocr100":"99.24274"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/rocr100

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	rocr100 value

JSON request example

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

https://api.twelvedata.com/rocr100?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/rocr100?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

RSIHigh Demand

Relative Strength Index(RSI) is a momentum indicator, which calculates the magnitude of a price change to assess the overbought and oversold conditions in the price of an asset.

This API call returns "meta" and "time_series" values of RSI. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "rsi":"9.38865"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "rsi":"9.97899"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "rsi":"10.07167"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "rsi":"10.7395"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/rsi

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 14

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	rsi value

JSON request example

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

https://api.twelvedata.com/rsi?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/rsi?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

RVOLGrow+

Relative Volume Indicator(RVOL) shows how the current trading volume is compared to past volume over a given period.

This API call returns "meta" and "time_series" values of RVOL. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "RVOL - Relative Volume Indicator",
         "time_period": 14
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "rvol":"2.9054"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "rvol":"1.56424"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "rvol":"1.21729"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "rvol":"1.5373"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "rvol":"3.44403"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/rvol

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
time_period	number	• Parameter is optional • Number of periods to average over. Takes values in the range from 1 to 800 • Default `14`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	rvol value

JSON request example

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

https://api.twelvedata.com/rvol?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/rvol?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

SAR

Parabolic SAR(SAR) is used to identify and spot upcoming asset momentum.

This API call returns "meta" and "time_series" values of SAR. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "sar":"201.71956"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "sar":"201.92195"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "sar":"202.117"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "sar":"202.31643"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/sar

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
acceleration	string
maximum	number	• Parameter is optional • Default `0.2`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	sar value

JSON request example

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

https://api.twelvedata.com/sar?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/sar?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

SAREXT

Parabolic SAR Extended(SAREXT) inherits the idea of classic SAR indicator but adds more flexibility in setting parameters.

This API call returns "meta" and "time_series" values of SAREXT. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "SAREXT - Parabolic SAR Extended",
         "acceleration_limit_long": 0.02,
         "acceleration_limit_short": 0.02,
         "acceleration_long": 0.02,
         "acceleration_max_long": 0.2,
         "acceleration_max_short": 0.2,
         "acceleration_short": 0.02,
         "offset_on_reverse": 0,
         "start_value": 0
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "sarext":"-201.54365"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "sarext":"-201.71956"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "sarext":"-201.92195"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "sarext":"-202.117"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "sarext":"-202.31643"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/sarext

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
acceleration_limit_long	number	• Required parameter • Default `0.02`
acceleration_limit_short	number	• Required parameter • Default `0.02`
acceleration_long	number	• Required parameter • Default `0.02`
acceleration_max_long	number	• Required parameter • Default `0.2`
acceleration_max_short	number	• Required parameter • Default `0.2`
acceleration_short	number	• Required parameter • Default `0.02`
offset_on_reverse	number	• Required parameter • Default `0`
start_value	number	• Required parameter • Default `0`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	sarext value

JSON request example

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

https://api.twelvedata.com/sarext?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/sarext?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

SMAHigh Demand

Simple Moving Average(SMA) is an arithmetic moving average calculated by adding the latest closing prices and then dividing them by the number of time periods.

This API call returns "meta" and "time_series" values of SMA. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "sma":"201.53871"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "sma":"201.69205"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "sma":"201.85111"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "sma":"202.03185"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/sma

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	sma value

JSON request example

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

https://api.twelvedata.com/sma?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/sma?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

SQRT

Square Root(SQRT) transforms input data with square root.

This API call returns "meta" and "time_series" values of SQRT. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "SQRT - Square Root",
         "series_type": "close"
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "sqrt":"14.17921"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "sqrt":"14.17515"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "sqrt":"14.17815"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "sqrt":"14.17862"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "sqrt":"14.18203"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/sqrt

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	sqrt value

JSON request example

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

https://api.twelvedata.com/sqrt?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/sqrt?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

STDDEV

Standard Deviation(STDDEV) is used to measure volatility. This might be important when assessing risks.

This API call returns "meta" and "time_series" values of STDDEV. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "STDDEV - Standard Deviation",
         "sd": 2,
         "series_type": "close",
         "time_period": 9
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "stddev":"0.86613"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "stddev":"0.94696"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "stddev":"0.95317"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "stddev":"0.92898"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "stddev":"0.85204"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/stddev

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

sd number • Parameter is optional
• Number of standard deviations. Must be at least 1
• Default 2

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	stddev value

JSON request example

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

https://api.twelvedata.com/stddev?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/stddev?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

STOCHHigh Demand

Stochastic Oscillator(STOCH) is used to decide if the price trend is strong.

This API call returns "meta" and "time_series" values of STOCH. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "STOCH - Stochastic Oscillator",
         "fast_k_period": 14,
         "slow_d_period": 3,
         "slow_dma_type": "SMA",
         "slow_k_period": 1,
         "slow_kma_type": "SMA"
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "slow_k":"11.35168",
         "slow_d":"7.5293"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "slow_k":"5.10019",
         "slow_d":"3.74541"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "slow_k":"6.13605",
         "slow_d":"3.24291"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "slow_k":"0.0",
         "slow_d":"2.35854"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "slow_k":"3.59267",
         "slow_d":"3.49697"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/stoch

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

fast_k_period number • Parameter is optional
• Takes values in the range from 1 to 800
• Default 14

slow_d_period number • Parameter is optional
• Takes values in the range from 1 to 800
• Default 3

slow_dma_type

string

• Parameter is optional
• Type of Moving Average to be used on Slow DMA Period
• Default SMA
▸ Supports either code or name, according to the mapping:

Code	Name
0	SMA
1	EMA
2	WMA
3	DEMA
4	TEMA
5	TRIMA
6	KAMA
7	MAMA
8	T3MA

slow_k_period number • Parameter is optional
• Takes values in the range from 1 to 800
• Default 1

slow_kma_type

string

• Parameter is optional
• Type of Moving Average to be used on Slow KMA Period
• Default SMA
▸ Supports either code or name, according to the mapping:

Code	Name
0	SMA
1	EMA
2	WMA
3	DEMA
4	TEMA
5	TRIMA
6	KAMA
7	MAMA
8	T3MA

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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_d	slow_d value
slow_k	slow_k value

JSON request example

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

https://api.twelvedata.com/stoch?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/stoch?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

STOCHF

Stochastic Fast(STOCHF) is more sensitive to price changes; therefore, it changes direction more quickly.

This API call returns "meta" and "time_series" values of STOCHF. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "STOCHF - Stochastic Fast",
         "fast_d_period": 3,
         "fast_dma_type": "SMA",
         "fast_k_period": 14
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "fast_k":"11.35168",
         "fast_d":"7.5293"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "fast_k":"5.10019",
         "fast_d":"3.74541"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "fast_k":"6.13605",
         "fast_d":"3.24291"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "fast_k":"0.0",
         "fast_d":"2.35854"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "fast_k":"3.59267",
         "fast_d":"3.49697"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/stochf

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

fast_d_period number • Parameter is optional
• Takes values in the range from 1 to 800
• Default 3

fast_dma_type

string

• Parameter is optional
• Type of Moving Average to be used on Fast DMA Period
• Default SMA
▸ Supports either code or name, according to the mapping:

Code	Name
0	SMA
1	EMA
2	WMA
3	DEMA
4	TEMA
5	TRIMA
6	KAMA
7	MAMA
8	T3MA

fast_k_period number • Parameter is optional
• Takes values in the range from 1 to 800
• Default 14

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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_d	fast_d value
fast_k	fast_k value

JSON request example

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

https://api.twelvedata.com/stochf?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/stochf?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

STOCHRSI

Stochastic RSI(STOCHRSI) as an independent indicator takes advantage of the STOCH and RSI indicators. It is used to determine overbought and oversold levels, as well as current market trends for an asset.

This API call returns "meta" and "time_series" values of STOCHRSI. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "k":"0.0",
         "d":"-0.0"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "k":"0.0",
         "d":"-0.0"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "k":"0.0",
         "d":"0.0"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "k":"0.0",
         "d":"0.0"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/stochrsi

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

stoch_length number

k_period number

d_period number

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

rsi_length number

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened
d	d value
k	k value

JSON request example

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

https://api.twelvedata.com/stochrsi?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/stochrsi?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

SUB

Subtraction of values of two specified time series.

This API call returns "meta" and "time_series" values of SUB. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "sub":"0.29001"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "sub":"0.16"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "sub":"0.22659"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "sub":"0.68999"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/sub

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type_1

string

• Parameter is optional
• Price type used as the first part of technical indicator
• Default open
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

series_type_2

string

• Parameter is optional
• Price type used as the second part of technical indicator
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	sub value

JSON request example

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

https://api.twelvedata.com/sub?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/sub?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

SUM

Summation of values of two specified time series.

This API call returns "meta" and "time_series" values of SUM. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "sum":"1813.84842"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "sum":"1815.22842"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "sum":"1816.66002"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "sum":"1818.28662"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/sum

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	sum value

JSON request example

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

https://api.twelvedata.com/sum?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/sum?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

SUPERTREND

SuperTrend Indicator(SUPERTREND) is mostly used on intraday timeframes to detect the price upward or downward direction in the trending market.

This API call returns "meta" and "time_series" values of SUPERTREND. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "SUPERTREND - SuperTrend Indicator",
         "multiplier": 3,
         "period": 10
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "supertrend":"201.56432"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "supertrend":"201.56432"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "supertrend":"201.56432"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "supertrend":"201.73149"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "supertrend":"201.98924"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/supertrend

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
multiplier	number	• Parameter is optional • Multiplier is the number by which the range is multiplied • Default `3`
period	number	• Parameter is optional • Period of the ATR indicator. Takes values in the range from 1 to 800 • Default `10`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	supertrend value

JSON request example

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

https://api.twelvedata.com/supertrend?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/supertrend?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

SUPERTREND_HEIKINASHICANDLESGrow+

SuperTrendHeikinAshiCandles Indicator(SUPERTREND_HEIKINASHICANDLES) is mostly used on intraday timeframes to detect the price upward or downward direction in the trending market and is built on top of the Heikin-Ashi Candles values.

This API call returns "meta" and "time_series" values of SUPERTREND_HEIKINASHICANDLES. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "supertrend":"201.66713",
         "heikinopens":"201.02",
         "heikinhighs":"201.13",
         "heikinlows":"200.84",
         "heikincloses":"200.98375"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "supertrend":"201.66713",
         "heikinopens":"201.0767",
         "heikinhighs":"201.07001",
         "heikinlows":"200.91",
         "heikincloses":"201.005"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "supertrend":"201.83183",
         "heikinopens":"201.445",
         "heikinhighs":"201.25999",
         "heikinlows":"201.0334",
         "heikincloses":"201.1117"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "supertrend":"202.04405",
         "heikinopens":"201.77",
         "heikinhighs":"201.75999",
         "heikinlows":"201.07001",
         "heikincloses":"201.43"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/supertrend_heikinashicandles

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
multiplier	number	• Parameter is optional • Multiplier is the number by which the range is multiplied • Default `3`
period	number	• Parameter is optional • Period of the ATR indicator. Takes values in the range from 1 to 800 • Default `10`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened
heikincloses	heikincloses value
heikinhighs	heikinhighs value
heikinlows	heikinlows value
heikinopens	heikinopens value
supertrend	supertrend value

JSON request example

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

https://api.twelvedata.com/supertrend_heikinashicandles?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/supertrend_heikinashicandles?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

T3MA

Triple Exponential Moving Average(T3MA) makes better smoothing of moving average than the classical TEMA indicator by extending the lookback period and applying other enhanced parameters.

This API call returns "meta" and "time_series" values of T3MA. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "t3ma":"201.72906"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "t3ma":"201.89968"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "t3ma":"202.06176"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "t3ma":"202.20727"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/t3ma

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

v_factor number • Parameter is optional
• Volume factor between 0 and 1 to determine how the moving averages responds
• Default 0.7

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	t3ma value

JSON request example

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

https://api.twelvedata.com/t3ma?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/t3ma?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

TEMA

Triple Exponential Moving Average(TEMA) smooths out price fluctuations, making it more trend detection and more transparent without the lag.

This API call returns "meta" and "time_series" values of TEMA. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "tema":"200.8304"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "tema":"200.94958"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "tema":"201.10417"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "tema":"201.36643"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/tema

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	tema value

JSON request example

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

https://api.twelvedata.com/tema?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/tema?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

TRANGE

True Range(TRANGE) is usually used as the base when calculating other indicators. TRANGE determines the normal trading range of an asset.

This API call returns "meta" and "time_series" values of TRANGE. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "TRANGE - True Range"
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "trange":"0.404"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "trange":"0.29001"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "trange":"0.16"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "trange":"0.22659"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "trange":"0.7"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/trange

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	trange value

JSON request example

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

https://api.twelvedata.com/trange?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/trange?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

TRIMA

Triangular Moving Average(TRIMA) smooths out price fluctuations, but places more weight on the prices in middle of the time period.

This API call returns "meta" and "time_series" values of TRIMA. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "trima":"201.54661"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "trima":"201.72207"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "trima":"201.8914"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "trima":"202.05193"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/trima

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	trima value

JSON request example

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

https://api.twelvedata.com/trima?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/trima?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

TSF

Time Series Forecast(TSF) calculates trend based on the last points of multiple regression trendlines.

This API call returns "meta" and "time_series" values of TSF. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "tsf":"200.65678"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "tsf":"200.8029"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "tsf":"200.9888"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "tsf":"201.24061"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/tsf

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	tsf value

JSON request example

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

https://api.twelvedata.com/tsf?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/tsf?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

TYPPRICE

Typical Price(TYPPRICE).

This API call returns "meta" and "time_series" values of TYPPRICE. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "TYPPRICE - Typical Price"
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "typprice":"201.05266"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "typprice":"200.96833"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "typprice":"201.00001"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "typprice":"201.10893"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "typprice":"201.32"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/typprice

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	typprice value

JSON request example

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

https://api.twelvedata.com/typprice?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/typprice?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

ULTOSC

Ultimate Oscillator(ULTOSC) takes into account three different time periods to enhance the quality of overbought and oversold signals.

This API call returns "meta" and "time_series" values of ULTOSC. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "ultosc":"20.38183"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "ultosc":"17.95325"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "ultosc":"14.54172"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "ultosc":"16.21497"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/ultosc

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
time_period_1	number	• Parameter is optional • Number of periods to average over. Takes values in the range from 1 to 800 • Default `7`
time_period_2	number	• Parameter is optional • Number of periods to average over. Takes values in the range from 1 to 800 • Default `14`
time_period_3	number	• Parameter is optional • Number of periods to average over. Takes values in the range from 1 to 800 • Default `28`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	ultosc value

JSON request example

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

https://api.twelvedata.com/ultosc?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/ultosc?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

VAR

Variance(VAR) calculates the spread between data points to determine how far they from the mean.

This API call returns "meta" and "time_series" values of VAR. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "VAR - Variance",
         "series_type": "close",
         "time_period": 9
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "var":"0.18755"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "var":"0.22418"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "var":"0.22713"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "var":"0.21575"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "var":"0.18149"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/var

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	var value

JSON request example

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

https://api.twelvedata.com/var?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/var?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

VWAP

Volume Weighted Average Price(VWAP) is commonly used as a trading benchmark that gives an average price at which the instrument has been trading during the day.

This API call returns "meta" and "time_series" values of VWAP. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "VWAP - Volume Weighted Average Price"
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "vwap":"201.05266"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "vwap":"200.96833"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "vwap":"201.00001"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "vwap":"201.10893"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "vwap":"201.32"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/vwap

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of instrument • For preffered stocks use dot(.) delimiter E.g. `BRK.A` or `BRK.B` will be correct
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
sd	number	• Parameter is optional • Number of standard deviations to form the upper and lower bound of the VWAP. Must be greater than 0 to be added • Recommended `2`
sd_time_period	number	• Parameter is optional • Number of periods for standard deviation. Must be greater than 0 to be added • Recommended `9`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	vwap value

JSON request example

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

https://api.twelvedata.com/vwap?symbol=INFY&exchange=BSE&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/vwap?symbol=AAPL&interval=30min&format=CSV&apikey=demo

WCLPRICE

Weighted Close Price(WCLPRICE) is usually used as the base for other indicators for smoothness. Formula: (high + low + close * 2) / 4.

This API call returns "meta" and "time_series" values of WCLPRICE. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "WCLPRICE - Weighted Close Price"
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "wclprice":"201.052"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "wclprice":"200.96"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "wclprice":"201.005"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "wclprice":"201.09005"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "wclprice":"201.2725"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/wclprice

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	wclprice value

JSON request example

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

https://api.twelvedata.com/wclprice?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/wclprice?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

WILLR

Williams %R(WILLR) calculates overbought and oversold levels. It can also be used to find entry and exit signals.

This API call returns "meta" and "time_series" values of WILLR. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "type": "Common Stock",
      "indicator": {
         "name": "WILLR - Williams %R",
         "time_period": 9
      }
   },
   "values":[
      {
         "datetime":"2019-08-09 15:59:00",
         "willr":"-84.8916"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "willr":"-93.70857"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "willr":"-92.9032"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "willr":"-100.0"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "willr":"-96.29644"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/willr

API credits

1 per symbol

API parameters

Key	Type	Description
symbol	string	• Required parameter • Symbol ticker of the instrument E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
figi	string	• Parameter is optional • Filter by financial instrument global identifier (FIGI)
isin	string	• Parameter is optional • Filter by international securities identification number (ISIN)
interval	string	• Required parameter • Interval between two consecutive points in time series • Supports: `1min`, `5min`, `15min`, `30min`, `45min`, `1h`, `2h`, `4h`, `1day`, `1week`, `1month`
exchange	string	• Parameter is optional • Exchange where instrument is traded
mic_code	string	• Parameter is optional • Market Identifier Code (MIC) under ISO 10383 standard
country	string	• Parameter is optional • Country where instrument is traded
time_period	number	• Parameter is optional • Number of periods to average over. Takes values in the range from 1 to 800 • Default `9`
type	string	• Parameter is optional • 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`, and `Warrant`
outputsize	number	• Parameter is optional • 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
format	string	• Parameter is optional • Value can be `JSON` or `CSV` • Default `JSON`
delimiter	string	• Parameter is optional • Specify the delimiter used when downloading the `CSV` file • Default semicolon `;`
apikey	string	• Required parameter • Your API key, which you can obtain for free here
		Advanced parameters
dp	string	• Parameter is optional • Specifies the number of decimal places for floating values • Should be in range [0,11] inclusive • Type `int`; Default `5`
order	string	• Parameter is optional • Sorting order of the output • Supports `ASC`, `DESC`; Default `DESC`
include_ohlc	string	• Parameter is optional • Specify if OHLC values should be added in the output • Type `bool`; Default `false`
timezone	string	• Parameter is optional • Timezone at which output datetime will be displayed • Supports: ◦ `Exchange` for local exchange time ◦ `UTC` for datetime at universal UTC standard ◦ 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 • Type `string`; Default `Exchange`
start_date end_date	string	• Parameters are optional • Can be used separately and together • 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: `&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 `&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 `&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

Response

Key	Description
meta	json object with request general information
datetime	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	willr value

JSON request example

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

https://api.twelvedata.com/willr?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/willr?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo

WMA

Weighted Moving Average(WMA) smooths out price fluctuations, and puts more weight on recent data points and less on past.

This API call returns "meta" and "time_series" values of WMA. "meta" object consist of general information about the requested technical indicator. "time_series" is the array of objects ordered by time descending updated in real-time.

HTTP request example

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

This request will return JSON with the following structure

{
   "meta":{
      "symbol": "AAPL",
      "interval": "1min",
      "currency": "USD",
      "exchange_timezone": "America/New_York",
      "exchange": "NYSE",
      "mic_code": "XNYS",
      "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"
      },
      {
         "datetime":"2019-08-09 15:58:00",
         "wma":"201.30353"
      },
      {
         "datetime":"2019-08-09 15:57:00",
         "wma":"201.45494"
      },
      {
         "datetime":"2019-08-09 15:56:00",
         "wma":"201.62116"
      },
      {
         "datetime":"2019-08-09 15:55:00",
         "wma":"201.82085"
      },
      {...}
   ],
   "status":"ok"
}

HTTP route

/wma

API credits

1 per symbol

API parameters

Key Type Description

symbol string • Required parameter
• Symbol ticker of the instrument
E.g. AAPL, EUR/USD, ETH/BTC, ...

figi string • Parameter is optional
• Filter by financial instrument global identifier (FIGI)

isin string • Parameter is optional
• Filter by international securities identification number (ISIN)

exchange string • Parameter is optional
• Exchange where instrument is traded

mic_code string • Parameter is optional
• Market Identifier Code (MIC) under ISO 10383 standard

country string • Parameter is optional
• Country where instrument is traded

series_type

string

• Parameter is optional
• Price type on which technical indicator is calculated
• Default close
▸ Supports either code or name, according to the mapping:

Code	Name
0	close
1	open
2	high
3	low
4	volume

time_period number • Parameter is optional
• Number of periods to average over. Takes values in the range from 1 to 800
• Default 9

format string • Parameter is optional
• Value can be JSON or CSV
• Default JSON

delimiter string • Parameter is optional
• Specify the delimiter used when downloading the CSV file
• Default semicolon ;

apikey string • Required parameter
• Your API key, which you can obtain for free here

Advanced parameters

dp string • Parameter is optional
• Specifies the number of decimal places for floating values
• Should be in range [0,11] inclusive
• Type int; Default 5

order string • Parameter is optional
• Sorting order of the output
• Supports ASC, DESC; Default DESC

include_ohlc string • Parameter is optional
• Specify if OHLC values should be added in the output
• Type bool; Default false

start_date
end_date

string

• Parameters are optional
• Can be used separately and together
• Format 2006-01-02 or 2006-01-02 15:04:05

Examples:

&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
&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
&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

Response

Key	Description
meta	json object with request general information
datetime	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	wma value

JSON request example

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

https://api.twelvedata.com/wma?symbol=ETH/BTC&exchange=Huobi&interval=1day&outputsize=24&apikey=demo

Downloadable CSV example

https://api.twelvedata.com/wma?symbol=EUR/USD&interval=30min&format=CSV&apikey=demo