Statistic functions

Compute fundamental statistical metrics on price series—dispersion, regression, correlation, and forecasting components—for standalone analysis or as inputs to other models (e.g. STDDEV, VAR, LINEARREG, CORREL, TSF, BETA).

Beta indicator

The Beta Indicator endpoint provides data on a security's sensitivity to market movements by comparing its price changes to a benchmark index. It returns the beta value, which quantifies the systematic risk of the security relative to the market. This information is useful for evaluating how much a security's price is expected to move in relation to market changes.

Route

/beta

API credits cost

1 per symbol

Parameters Response

✱ One of these parameters is required

symbol

string

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

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.

Example: BBG000B9Y5X2

isin

string

Look up an instrument by its International Securities Identification Number (ISIN). Available on all plans. Returning ISIN values in responses requires the ISIN Data add-on.

Example: US0378331005

cusip

string

Look up an instrument by its Committee on Uniform Securities Identification Procedures (CUSIP) number. Available on all plans. Returning CUSIP values in responses requires the CUSIP Data add-on.

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

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

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

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

Example: United States

series_type_1

string

Price type used as the first part of technical indicator

Supports: close, open, high, low, volume

Default: open

series_type_2

string

Price type used as the second part of technical indicator

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

type

string

The asset class to which the instrument belongs

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

Example: Common Stock

outputsize

integer

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

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

Default: false

integer

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

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

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

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

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

Example: 2021-10-27

start_date

string

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

Default location:

Forex and Cryptocurrencies - UTC
Stocks - where exchange is located (e.g. for AAPL it will be America/New_York)

Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

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

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

end_date

string

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

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

previous_close

boolean

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

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

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

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

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

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type_1

string

Price type used as the first part of technical indicator

series_type_2

string

Price type used as the second part of technical indicator

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

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

beta

string

Beta value

open

string

Price at the opening of current bar. Returned when include_ohlc is true.

high

string

Highest price which occurred during the current bar. Returned when include_ohlc is true.

low

string

Lowest price which occurred during the current bar. Returned when include_ohlc is true.

string

Close price at the end of the bar. Returned when include_ohlc is true.

volume

string

Trading volume which occurred during the current bar. Returned when include_ohlc is true.

status

string

Response status

Copy for LLM

View as Markdown

Request example

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

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "BETA - Beta",
            "series_type_1": "open",
            "series_type_2": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "beta": "-0.05742",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Correlation

The Correlation (CORREL) endpoint calculates the statistical relationship between two securities over a specified time period, returning a correlation coefficient. This coefficient ranges from -1 to 1, indicating the strength and direction of their linear relationship. A value close to 1 suggests a strong positive correlation, while a value near -1 indicates a strong negative correlation. This data is useful for identifying securities that move together or in opposite directions, aiding in strategies like diversification or pairs trading.

Route

/correl

API credits cost

1 per symbol

Parameters Response

✱ One of these parameters is required

symbol

string

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

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.

Example: BBG000B9Y5X2

isin

string

Look up an instrument by its International Securities Identification Number (ISIN). Available on all plans. Returning ISIN values in responses requires the ISIN Data add-on.

Example: US0378331005

cusip

string

Look up an instrument by its Committee on Uniform Securities Identification Procedures (CUSIP) number. Available on all plans. Returning CUSIP values in responses requires the CUSIP Data add-on.

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

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

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

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

Example: United States

series_type_1

string

Price type used as the first part of technical indicator

Supports: close, open, high, low, volume

Default: open

series_type_2

string

Price type used as the second part of technical indicator

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

type

string

The asset class to which the instrument belongs

Example: Common Stock

outputsize

integer

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

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

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

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

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

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

Example: 2021-10-27

start_date

string

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

Default location:

Forex and Cryptocurrencies - UTC
Stocks - where exchange is located (e.g. for AAPL it will be America/New_York)

Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

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

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

end_date

string

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

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

previous_close

boolean

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

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

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

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

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

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type_1

string

Price type used as the first part of technical indicator

series_type_2

string

Price type used as the second part of technical indicator

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

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

correl

string

Correl value

open

string

Price at the opening of current bar. Returned when include_ohlc is true.

high

string

Highest price which occurred during the current bar. Returned when include_ohlc is true.

low

string

Lowest price which occurred during the current bar. Returned when include_ohlc is true.

string

Close price at the end of the bar. Returned when include_ohlc is true.

volume

string

Trading volume which occurred during the current bar. Returned when include_ohlc is true.

status

string

Response status

Copy for LLM

View as Markdown

Request example

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

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "CORREL - Pearson's Correlation Coefficient",
            "series_type_1": "open",
            "series_type_2": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "correl": "0.93282",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Linear regression

The Linear Regression endpoint (LINEARREG) calculates the best-fit straight line through a series of financial data points. It returns the slope and intercept values of this line, allowing users to determine the overall direction of a market trend and identify potential support or resistance levels.

Route

/linearreg

API credits cost

1 per symbol

Parameters Response

✱ One of these parameters is required

symbol

string

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

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.

Example: BBG000B9Y5X2

isin

string

Look up an instrument by its International Securities Identification Number (ISIN). Available on all plans. Returning ISIN values in responses requires the ISIN Data add-on.

Example: US0378331005

cusip

string

Look up an instrument by its Committee on Uniform Securities Identification Procedures (CUSIP) number. Available on all plans. Returning CUSIP values in responses requires the CUSIP Data add-on.

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

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

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

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

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

type

string

The asset class to which the instrument belongs

Example: Common Stock

outputsize

integer

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

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

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

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

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

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

Example: 2021-10-27

start_date

string

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

Default location:

Forex and Cryptocurrencies - UTC
Stocks - where exchange is located (e.g. for AAPL it will be America/New_York)

Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

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

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

end_date

string

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

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

previous_close

boolean

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

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

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

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

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

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

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

linearreg

string

linearreg value

open

string

Price at the opening of current bar. Returned when include_ohlc is true.

high

string

Highest price which occurred during the current bar. Returned when include_ohlc is true.

low

string

Lowest price which occurred during the current bar. Returned when include_ohlc is true.

string

Close price at the end of the bar. Returned when include_ohlc is true.

volume

string

Trading volume which occurred during the current bar. Returned when include_ohlc is true.

status

string

Response status

Copy for LLM

View as Markdown

Request example

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

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "LINEARREG - Linear Regression",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "linearreg": "200.79327",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Linear regression angle

The Linear Regression Angle endpoint (LINEARREGANGLE) calculates the angle of the linear regression line for a given time series of stock prices. It returns the slope of the trend line, expressed in degrees, which helps users identify the direction and steepness of a trend over a specified period. This data is useful for detecting upward or downward trends in asset prices.

Route

/linearregangle

API credits cost

1 per symbol

Parameters Response

✱ One of these parameters is required

symbol

string

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

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.

Example: BBG000B9Y5X2

isin

string

Look up an instrument by its International Securities Identification Number (ISIN). Available on all plans. Returning ISIN values in responses requires the ISIN Data add-on.

Example: US0378331005

cusip

string

Look up an instrument by its Committee on Uniform Securities Identification Procedures (CUSIP) number. Available on all plans. Returning CUSIP values in responses requires the CUSIP Data add-on.

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

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

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

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

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

type

string

The asset class to which the instrument belongs

Example: Common Stock

outputsize

integer

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

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

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

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

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

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

Example: 2021-10-27

start_date

string

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

Default location:

Forex and Cryptocurrencies - UTC
Stocks - where exchange is located (e.g. for AAPL it will be America/New_York)

Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

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

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

end_date

string

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

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

previous_close

boolean

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

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

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

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

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

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

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

linearregangle

string

Linear regression angle value

open

string

Price at the opening of current bar. Returned when include_ohlc is true.

high

string

Highest price which occurred during the current bar. Returned when include_ohlc is true.

low

string

Lowest price which occurred during the current bar. Returned when include_ohlc is true.

string

Close price at the end of the bar. Returned when include_ohlc is true.

volume

string

Trading volume which occurred during the current bar. Returned when include_ohlc is true.

status

string

Response status

Copy for LLM

View as Markdown

Request example

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

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "LINEARREGANGLE - Linear Regression Angle",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "linearregangle": "-8.79357",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Linear regression intercept

The Linear Regression Intercept endpoint (LINEARREGINTERCEPT) calculates the y-intercept of a linear regression line for a given dataset. It returns the value where the regression line crosses the y-axis, providing a numerical reference point for understanding the starting position of a trend over a specified period. This can be useful for users needing to establish baseline values in their data analysis.

Route

/linearregintercept

API credits cost

1 per symbol

Parameters Response

✱ One of these parameters is required

symbol

string

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

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.

Example: BBG000B9Y5X2

isin

string

Look up an instrument by its International Securities Identification Number (ISIN). Available on all plans. Returning ISIN values in responses requires the ISIN Data add-on.

Example: US0378331005

cusip

string

Look up an instrument by its Committee on Uniform Securities Identification Procedures (CUSIP) number. Available on all plans. Returning CUSIP values in responses requires the CUSIP Data add-on.

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

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

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

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

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

type

string

The asset class to which the instrument belongs

Example: Common Stock

outputsize

integer

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

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

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

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

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

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

Example: 2021-10-27

start_date

string

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

Default location:

Forex and Cryptocurrencies - UTC
Stocks - where exchange is located (e.g. for AAPL it will be America/New_York)

Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

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

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

end_date

string

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

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

previous_close

boolean

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

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

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

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

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

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

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

linearregintercept

string

Linear Regression Intercept value

open

string

Price at the opening of current bar. Returned when include_ohlc is true.

high

string

Highest price which occurred during the current bar. Returned when include_ohlc is true.

low

string

Lowest price which occurred during the current bar. Returned when include_ohlc is true.

string

Close price at the end of the bar. Returned when include_ohlc is true.

volume

string

Trading volume which occurred during the current bar. Returned when include_ohlc is true.

status

string

Response status

Copy for LLM

View as Markdown

Request example

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

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "LINEARREGINTERCEPT - Linear Regression Intercept",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "linearregintercept": "202.03082",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Linear regression slope

The Linear Regression Slope endpoint (LINEARREGSLOPE) calculates the slope of a linear regression line for a given dataset, reflecting the rate of change in the data trend over a specified period. It returns a numerical value representing this slope, which can be used to assess the direction and strength of the trend in the dataset.

Route

/linearregslope

API credits cost

1 per symbol

Parameters Response

✱ One of these parameters is required

symbol

string

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

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.

Example: BBG000B9Y5X2

isin

string

Look up an instrument by its International Securities Identification Number (ISIN). Available on all plans. Returning ISIN values in responses requires the ISIN Data add-on.

Example: US0378331005

cusip

string

Look up an instrument by its Committee on Uniform Securities Identification Procedures (CUSIP) number. Available on all plans. Returning CUSIP values in responses requires the CUSIP Data add-on.

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

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

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

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

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

type

string

The asset class to which the instrument belongs

Example: Common Stock

outputsize

integer

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

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

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

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

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

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

Example: 2021-10-27

start_date

string

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

Default location:

Forex and Cryptocurrencies - UTC
Stocks - where exchange is located (e.g. for AAPL it will be America/New_York)

Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

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

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

end_date

string

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

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

previous_close

boolean

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

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

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

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

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

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

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

linearregslope

string

linearregslope value

open

string

Price at the opening of current bar. Returned when include_ohlc is true.

high

string

Highest price which occurred during the current bar. Returned when include_ohlc is true.

low

string

Lowest price which occurred during the current bar. Returned when include_ohlc is true.

string

Close price at the end of the bar. Returned when include_ohlc is true.

volume

string

Trading volume which occurred during the current bar. Returned when include_ohlc is true.

status

string

Response status

Copy for LLM

View as Markdown

Request example

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

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "LINEARREGSLOPE - Linear Regression Slope",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "linearregslope": "-0.15469",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Maximum

The Maximum (MAX) endpoint calculates and returns the highest value within a specified data series over a given period. This endpoint is useful for identifying potential resistance levels or detecting extreme price movements in financial data.

Route

/max

API credits cost

1 per symbol

Parameters Response

✱ One of these parameters is required

symbol

string

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

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.

Example: BBG000B9Y5X2

isin

string

Look up an instrument by its International Securities Identification Number (ISIN). Available on all plans. Returning ISIN values in responses requires the ISIN Data add-on.

Example: US0378331005

cusip

string

Look up an instrument by its Committee on Uniform Securities Identification Procedures (CUSIP) number. Available on all plans. Returning CUSIP values in responses requires the CUSIP Data add-on.

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

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

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

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

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

type

string

The asset class to which the instrument belongs

Example: Common Stock

outputsize

integer

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

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

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

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

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

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

Example: 2021-10-27

start_date

string

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

Default location:

Forex and Cryptocurrencies - UTC
Stocks - where exchange is located (e.g. for AAPL it will be America/New_York)

Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

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

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

end_date

string

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

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

previous_close

boolean

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

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

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

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

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

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

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

max

string

Max value

open

string

Price at the opening of current bar. Returned when include_ohlc is true.

high

string

Highest price which occurred during the current bar. Returned when include_ohlc is true.

low

string

Lowest price which occurred during the current bar. Returned when include_ohlc is true.

string

Close price at the end of the bar. Returned when include_ohlc is true.

volume

string

Trading volume which occurred during the current bar. Returned when include_ohlc is true.

status

string

Response status

Copy for LLM

View as Markdown

Request example

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

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MAX - Highest value over period",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "max": "202.05",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Maximum Index

The Maximum Index (MAXINDEX) endpoint identifies the position of the highest value within a specified data series over a given time frame. It returns the index where the peak value occurs, allowing users to pinpoint when the maximum price or value was reached in the series. This is useful for tracking the timing of significant peaks in financial data.

Route

/maxindex

API credits cost

1 per symbol

Parameters Response

✱ One of these parameters is required

symbol

string

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

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.

Example: BBG000B9Y5X2

isin

string

Look up an instrument by its International Securities Identification Number (ISIN). Available on all plans. Returning ISIN values in responses requires the ISIN Data add-on.

Example: US0378331005

cusip

string

Look up an instrument by its Committee on Uniform Securities Identification Procedures (CUSIP) number. Available on all plans. Returning CUSIP values in responses requires the CUSIP Data add-on.

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

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

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

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

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

type

string

The asset class to which the instrument belongs

Example: Common Stock

outputsize

integer

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

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

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

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

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

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

Example: 2021-10-27

start_date

string

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

Default location:

Forex and Cryptocurrencies - UTC
Stocks - where exchange is located (e.g. for AAPL it will be America/New_York)

Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

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

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

end_date

string

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

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

previous_close

boolean

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

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

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

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

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

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

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

maxidx

string

maxidx value

open

string

Price at the opening of current bar. Returned when include_ohlc is true.

high

string

Highest price which occurred during the current bar. Returned when include_ohlc is true.

low

string

Lowest price which occurred during the current bar. Returned when include_ohlc is true.

string

Close price at the end of the bar. Returned when include_ohlc is true.

volume

string

Trading volume which occurred during the current bar. Returned when include_ohlc is true.

status

string

Response status

Copy for LLM

View as Markdown

Request example

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

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MAXINDEX - Index of highest value over period",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "maxidx": "491",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Minimum

The Minimum (MIN) Indicator endpoint provides the lowest value of a specified data series over a chosen time period. This endpoint is useful for identifying potential support levels or detecting extreme price movements in financial data.

Route

/min

API credits cost

1 per symbol

Parameters Response

✱ One of these parameters is required

symbol

string

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

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.

Example: BBG000B9Y5X2

isin

string

Look up an instrument by its International Securities Identification Number (ISIN). Available on all plans. Returning ISIN values in responses requires the ISIN Data add-on.

Example: US0378331005

cusip

string

Look up an instrument by its Committee on Uniform Securities Identification Procedures (CUSIP) number. Available on all plans. Returning CUSIP values in responses requires the CUSIP Data add-on.

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

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

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

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

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

type

string

The asset class to which the instrument belongs

Example: Common Stock

outputsize

integer

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

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

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

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

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

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

Example: 2021-10-27

start_date

string

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

Default location:

Forex and Cryptocurrencies - UTC
Stocks - where exchange is located (e.g. for AAPL it will be America/New_York)

Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

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

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

end_date

string

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

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

previous_close

boolean

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

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

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

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

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

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

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

min

string

Min value

open

string

Price at the opening of current bar. Returned when include_ohlc is true.

high

string

Highest price which occurred during the current bar. Returned when include_ohlc is true.

low

string

Lowest price which occurred during the current bar. Returned when include_ohlc is true.

string

Close price at the end of the bar. Returned when include_ohlc is true.

volume

string

Trading volume which occurred during the current bar. Returned when include_ohlc is true.

status

string

Response status

Copy for LLM

View as Markdown

Request example

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

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MIN - Lowest value over period",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "min": "200.935",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Minimum index

The Minimum Index (MININDEX) endpoint identifies the position of the lowest value within a specified data series over a given time frame. It returns the index number corresponding to the earliest occurrence of this minimum value. This is useful for pinpointing when the lowest price or value occurred in a dataset, aiding in time-based analysis of data trends.

Route

/minindex

API credits cost

1 per symbol

Parameters Response

✱ One of these parameters is required

symbol

string

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

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.

Example: BBG000B9Y5X2

isin

string

Look up an instrument by its International Securities Identification Number (ISIN). Available on all plans. Returning ISIN values in responses requires the ISIN Data add-on.

Example: US0378331005

cusip

string

Look up an instrument by its Committee on Uniform Securities Identification Procedures (CUSIP) number. Available on all plans. Returning CUSIP values in responses requires the CUSIP Data add-on.

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

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

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

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

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

type

string

The asset class to which the instrument belongs

Example: Common Stock

outputsize

integer

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

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

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

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

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

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

Example: 2021-10-27

start_date

string

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

Default location:

Forex and Cryptocurrencies - UTC
Stocks - where exchange is located (e.g. for AAPL it will be America/New_York)

Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

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

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

end_date

string

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

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

previous_close

boolean

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

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

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

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

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

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

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

minidx

string

Index of lowest value over period

open

string

Price at the opening of current bar. Returned when include_ohlc is true.

high

string

Highest price which occurred during the current bar. Returned when include_ohlc is true.

low

string

Lowest price which occurred during the current bar. Returned when include_ohlc is true.

string

Close price at the end of the bar. Returned when include_ohlc is true.

volume

string

Trading volume which occurred during the current bar. Returned when include_ohlc is true.

status

string

Response status

Copy for LLM

View as Markdown

Request example

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

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MININDEX - Index of lowest value over period",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "minidx": "498",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Minimum and maximum

The Minimum and Maximum (MINMAX) endpoint identifies the lowest and highest values within a specified time frame for a given data series. It returns these extreme values, which can be used to detect potential support and resistance levels or significant price fluctuations in the data.

Route

/minmax

API credits cost

1 per symbol

Parameters Response

✱ One of these parameters is required

symbol

string

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

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.

Example: BBG000B9Y5X2

isin

string

Look up an instrument by its International Securities Identification Number (ISIN). Available on all plans. Returning ISIN values in responses requires the ISIN Data add-on.

Example: US0378331005

cusip

string

Look up an instrument by its Committee on Uniform Securities Identification Procedures (CUSIP) number. Available on all plans. Returning CUSIP values in responses requires the CUSIP Data add-on.

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

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

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

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

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

type

string

The asset class to which the instrument belongs

Example: Common Stock

outputsize

integer

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

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

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

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

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

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

Example: 2021-10-27

start_date

string

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

Default location:

Forex and Cryptocurrencies - UTC
Stocks - where exchange is located (e.g. for AAPL it will be America/New_York)

Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

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

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

end_date

string

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

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

previous_close

boolean

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

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

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

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

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

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

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

min

string

Min value

max

string

Max value

open

string

Price at the opening of current bar. Returned when include_ohlc is true.

high

string

Highest price which occurred during the current bar. Returned when include_ohlc is true.

low

string

Lowest price which occurred during the current bar. Returned when include_ohlc is true.

string

Close price at the end of the bar. Returned when include_ohlc is true.

volume

string

Trading volume which occurred during the current bar. Returned when include_ohlc is true.

status

string

Response status

Copy for LLM

View as Markdown

Request example

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

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MINMAX - Lowest and highest values over period",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "min": "200.935",
            "max": "202.05",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Minimum and maximum index

The Minimum and Maximum Index (MINMAXINDEX) endpoint identifies the positions of the lowest and highest values within a specified data series period. It returns indices that indicate when these extreme values occur, allowing users to pinpoint significant price changes over time.

Route

/minmaxindex

API credits cost

1 per symbol

Parameters Response

✱ One of these parameters is required

symbol

string

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

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.

Example: BBG000B9Y5X2

isin

string

Look up an instrument by its International Securities Identification Number (ISIN). Available on all plans. Returning ISIN values in responses requires the ISIN Data add-on.

Example: US0378331005

cusip

string

Look up an instrument by its Committee on Uniform Securities Identification Procedures (CUSIP) number. Available on all plans. Returning CUSIP values in responses requires the CUSIP Data add-on.

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

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

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

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

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

type

string

The asset class to which the instrument belongs

Example: Common Stock

outputsize

integer

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

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

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

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

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

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

Example: 2021-10-27

start_date

string

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

Default location:

Forex and Cryptocurrencies - UTC
Stocks - where exchange is located (e.g. for AAPL it will be America/New_York)

Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

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

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

end_date

string

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

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

previous_close

boolean

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

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

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

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

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

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

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

minidx

string

Index of the lowest value over the specified period

maxidx

string

Index of the highest value over the specified period

open

string

Price at the opening of current bar. Returned when include_ohlc is true.

high

string

Highest price which occurred during the current bar. Returned when include_ohlc is true.

low

string

Lowest price which occurred during the current bar. Returned when include_ohlc is true.

string

Close price at the end of the bar. Returned when include_ohlc is true.

volume

string

Trading volume which occurred during the current bar. Returned when include_ohlc is true.

status

string

Response status

Copy for LLM

View as Markdown

Request example

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

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "MINMAXINDEX - Indexes of lowest and highest values over period",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "minidx": "498",
            "maxidx": "491",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Standard deviation

The Standard Deviation (STDDEV) endpoint calculates the dispersion of a financial instrument's price data from its average value. It returns a numerical value representing the volatility of the asset over a specified period. This endpoint is useful for traders and analysts to assess price variability and identify periods of high or low volatility in the market.

Route

/stddev

API credits cost

1 per symbol

Parameters Response

✱ One of these parameters is required

symbol

string

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

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.

Example: BBG000B9Y5X2

isin

string

Look up an instrument by its International Securities Identification Number (ISIN). Available on all plans. Returning ISIN values in responses requires the ISIN Data add-on.

Example: US0378331005

cusip

string

Look up an instrument by its Committee on Uniform Securities Identification Procedures (CUSIP) number. Available on all plans. Returning CUSIP values in responses requires the CUSIP Data add-on.

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

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

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

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

Example: United States

double

The standard deviation applied in the calculation.

Default: 2

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

type

string

The asset class to which the instrument belongs

Example: Common Stock

outputsize

integer

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

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

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

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

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

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

Example: 2021-10-27

start_date

string

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

Default location:

Forex and Cryptocurrencies - UTC
Stocks - where exchange is located (e.g. for AAPL it will be America/New_York)

Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

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

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

end_date

string

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

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

previous_close

boolean

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

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

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

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

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

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

The time period used for calculation in the indicator

double

The standard deviation applied in the calculation

values

array of object

Array of time series data points

Attributes

datetime

string

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

stddev

string

Standard Deviation value

open

string

Price at the opening of current bar. Returned when include_ohlc is true.

high

string

Highest price which occurred during the current bar. Returned when include_ohlc is true.

low

string

Lowest price which occurred during the current bar. Returned when include_ohlc is true.

string

Close price at the end of the bar. Returned when include_ohlc is true.

volume

string

Trading volume which occurred during the current bar. Returned when include_ohlc is true.

status

string

Response status

Copy for LLM

View as Markdown

Request example

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

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "STDDEV - Standard Deviation",
            "series_type": "close",
            "time_period": 9,
            "sd": 2
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "stddev": "0.86613",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Time series forecast

The Time Series Forecast (TSF) endpoint provides projected future price levels using linear regression analysis. It returns data that helps users identify potential support and resistance levels, as well as trend direction in a financial market. This endpoint is useful for traders seeking to anticipate price movements and adjust their strategies accordingly.

Route

/tsf

API credits cost

1 per symbol

Parameters Response

✱ One of these parameters is required

symbol

string

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

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.

Example: BBG000B9Y5X2

isin

string

Look up an instrument by its International Securities Identification Number (ISIN). Available on all plans. Returning ISIN values in responses requires the ISIN Data add-on.

Example: US0378331005

cusip

string

Look up an instrument by its Committee on Uniform Securities Identification Procedures (CUSIP) number. Available on all plans. Returning CUSIP values in responses requires the CUSIP Data add-on.

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

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

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

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

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

type

string

The asset class to which the instrument belongs

Example: Common Stock

outputsize

integer

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

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

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

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

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

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

Example: 2021-10-27

start_date

string

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

Default location:

Forex and Cryptocurrencies - UTC
Stocks - where exchange is located (e.g. for AAPL it will be America/New_York)

Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

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

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

end_date

string

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

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

previous_close

boolean

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

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

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

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

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

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

The time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

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

tsf

string

TSF value

open

string

Price at the opening of current bar. Returned when include_ohlc is true.

high

string

Highest price which occurred during the current bar. Returned when include_ohlc is true.

low

string

Lowest price which occurred during the current bar. Returned when include_ohlc is true.

string

Close price at the end of the bar. Returned when include_ohlc is true.

volume

string

Trading volume which occurred during the current bar. Returned when include_ohlc is true.

status

string

Response status

Copy for LLM

View as Markdown

Request example

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

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "TSF - Time Series Forecast",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "tsf": "200.63858",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Variance

The Variance (VAR) endpoint calculates the statistical variance of a financial data series, providing a measure of how much the data points deviate from the average value. It returns a numerical value representing this dispersion, which can be used to assess the volatility of a security over a specified period. This information is crucial for traders and analysts who need to evaluate the risk associated with price fluctuations in the market.

Route

/var

API credits cost

1 per symbol

Parameters Response

✱ One of these parameters is required

symbol

string

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

Example: AAPL

figi

string

The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.

Example: BBG000B9Y5X2

isin

string

Look up an instrument by its International Securities Identification Number (ISIN). Available on all plans. Returning ISIN values in responses requires the ISIN Data add-on.

Example: US0378331005

cusip

string

Look up an instrument by its Committee on Uniform Securities Identification Procedures (CUSIP) number. Available on all plans. Returning CUSIP values in responses requires the CUSIP Data add-on.

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

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

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

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

Example: United States

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

type

string

The asset class to which the instrument belongs

Example: Common Stock

outputsize

integer

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

Default: false

integer

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

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

Timezone at which output datetime will be displayed. Supports:

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

Take note that the IANA Timezone name is case-sensitive

Default: Exchange

date

string

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

Example: 2021-10-27

start_date

string

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

Default location:

Forex and Cryptocurrencies - UTC
Stocks - where exchange is located (e.g. for AAPL it will be America/New_York)

Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

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

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

end_date

string

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

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

previous_close

boolean

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

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

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

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

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

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

series_type

string

Price type on which technical indicator is calculated

time_period

integer

The time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

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

var

string

VAR value

open

string

Price at the opening of current bar. Returned when include_ohlc is true.

high

string

Highest price which occurred during the current bar. Returned when include_ohlc is true.

low

string

Lowest price which occurred during the current bar. Returned when include_ohlc is true.

string

Close price at the end of the bar. Returned when include_ohlc is true.

volume

string

Trading volume which occurred during the current bar. Returned when include_ohlc is true.

status

string

Response status

Copy for LLM

View as Markdown

Request example

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

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "VAR - Variance",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "var": "0.18755",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}