Now Live: Cboe Europe real-time data for all major European stocks.

Cycle indicators

Detect and follow recurring periodic patterns in price action using Hilbert Transform–based measures of cycle period and phase (e.g. HT_SINE, HT_DCPERIOD, HT_DCPHASE, HT_PHASOR, HT_TRENDMODE).

Hilbert transform dominant cycle period

The Hilbert Transform Dominant Cycle Period (HT_DCPERIOD) endpoint calculates the dominant cycle length of a financial instrument's price data. It returns a numerical value representing the cycle period, which traders can use to identify prevailing market cycles and adjust their trading strategies accordingly.

Route

/ht_dcperiod

API credits cost

1 per symbol

Parameters Response
Sign in to query
✱ 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

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

dp

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

string

Price type on which technical indicator is calculated

values

array of object

Array of time series data points

Attributes

datetime

string

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

ht_dcperiod

string

ht_dcperiod value

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.

close

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/ht_dcperiod?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": "HT_DCPERIOD - Hilbert Transform Dominant Cycle Period",
            "series_type": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "ht_dcperiod": "28.12565",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Hilbert transform dominant cycle phase

The Hilbert Transform Dominant Cycle Phase (HT_DCPHASE) endpoint provides the current phase of the dominant market cycle for a given financial instrument. It returns numerical data indicating the phase angle, which can be used by traders to identify potential market entry and exit points based on cyclical patterns.

Route

/ht_dcphase

API credits cost

1 per symbol

Parameters Response
Sign in to query
✱ 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

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

dp

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

string

Price type on which technical indicator is calculated

values

array of object

Array of time series data points

Attributes

datetime

string

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

ht_dcphase

string

HT_DCPHASE value

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.

close

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/ht_dcphase?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": "HT_DCPHASE - Hilbert Transform Dominant Cycle Phase",
            "series_type": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "ht_dcphase": "-38.50975",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Hilbert transform phasor components

The Hilbert Transform Phasor Components (HT_PHASOR) endpoint analyzes a price series to return two key components: in-phase and quadrature. These components help identify cyclical patterns and the direction of trends in the data. Use this endpoint to gain precise insights into the timing and strength of market cycles, enhancing your ability to track and predict price movements.

Route

/ht_phasor

API credits cost

1 per symbol

Parameters Response
Sign in to query
✱ 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

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

dp

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

string

Price type on which technical indicator is calculated

values

array of object

Array of time series data points

Attributes

datetime

string

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

in_phase

string

In_phase value

quadrature

string

Quadrature value

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.

close

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/ht_phasor?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": "HT_PHASOR - Hilbert Transform Phasor Components",
            "series_type": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "in_phase": "-0.56826",
            "quadrature": "-0.43318",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Hilbert transform sine wave

The Hilbert Transform Sine Wave (HT_SINE) endpoint provides sine and cosine wave components derived from the dominant market cycle. This data helps traders pinpoint potential market turning points and assess trend directions by analyzing cyclical patterns.

Route

/ht_sine

API credits cost

1 per symbol

Parameters Response
Sign in to query
✱ 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

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

dp

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

string

Price type on which technical indicator is calculated

values

array of object

Array of time series data points

Attributes

datetime

string

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

ht_sine

string

ht_sine value

ht_leadsine

string

ht_leadsine value

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.

close

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/ht_sine?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": "HT_SINE - Hilbert Transform SineWave",
            "series_type": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "ht_sine": "-0.62265",
            "ht_leadsine": "0.11303",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Hilbert transform trend vs cycle mode

The Hilbert Transform Trend vs Cycle Mode (HT_TRENDMODE) endpoint identifies whether a market is in a trending or cyclical phase. It returns data indicating the current market phase, allowing users to adjust their trading strategies based on the prevailing conditions.

Route

/ht_trendmode

API credits cost

1 per symbol

Parameters Response
Sign in to query
✱ 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

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

dp

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

string

Price type on which technical indicator is calculated

values

array of object

Array of time series data points

Attributes

datetime

string

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

ht_trendmode

string

ht_trendmode value

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.

close

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/ht_trendmode?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": "HT_TRENDMODE - Hilbert Transform Trend vs Cycle Mode",
            "series_type": "close"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "ht_trendmode": "0",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}