Skip to main content
GET
List historical candles

Authorizations

x-api-key
string
header
required

Query Parameters

exchange
string
required

TakeProfit exchange code as returned by /api/v1/marketdata/exchanges.

Example:

"BATS"

symbol
string
required

Public security symbol returned by /api/v1/marketdata/exchanges/{exchange}/securities. TakeProfit security symbol as returned by /api/v1/marketdata/exchanges/{exchange}/securities. In a path segment a slash must be percent-encoded (BTC/USDT is requested as BTC%2FUSDT).

Example:

"AAPL"

timeframe
string
required

Timeframe id returned by /api/v1/marketdata/timeframes. Canonical suffixes include M for months and Q for quarters.

Example:

"1h"

from
string

Range start as Unix seconds or RFC3339 timestamp. Without it the window is measured backwards from to. Unix seconds (for example 1790000000) or RFC3339 timestamp.

to
string

Range end as Unix seconds or RFC3339 timestamp, greater than from. Defaults to now when from is omitted. Not supported for tick timeframes. Unix seconds (for example 1790000000) or RFC3339 timestamp.

period
integer

Range duration in seconds, counted forward from from or backwards from to. Not supported for tick timeframes.

Required range: x >= 1
limit
integer

Candle count to return, counted forward from from or backwards from to. Defaults to 1000.

Required range: 1 <= x <= 10000
sessionType
enum<string>[]

Optional session filter. Repeat this parameter or pass comma-separated values.

Available options:
MAINSESSION,
PRE_MARKET,
POST_MARKET

Response

Candles response.

meta
object
required
candles
object[]
required