List historical candles
Provide exchange, symbol, and timeframe. Nothing else is required: the
window defaults to the last 1000 candles.
- With
fromthe window starts there and runs forward, ending atto, afterperiodseconds, or afterlimitcandles (1000 by default). - Without
fromthe window ends atto(now by default) and runs backwards overlimitcandles (1000 by default) orperiodseconds. periodandlimitcannot be used together, and neither can be added to an explicitfrom+towindow.- Tick timeframes accept
fromandlimitonly. - A request is limited to at most 10000 estimated candles.
Cost: 1 credit per returned candle, at least 1000 credits per request.
Authorizations
Query Parameters
TakeProfit exchange code as returned by /api/v1/marketdata/exchanges.
"BATS"
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).
"AAPL"
Timeframe id returned by /api/v1/marketdata/timeframes. Canonical suffixes include M for months and Q for quarters.
"1h"
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.
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.
Range duration in seconds, counted forward from from or backwards from to. Not supported for tick timeframes.
x >= 1Candle count to return, counted forward from from or backwards from to. Defaults to 1000.
1 <= x <= 10000Optional session filter. Repeat this parameter or pass comma-separated values.
MAINSESSION, PRE_MARKET, POST_MARKET