Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
symbol
string
required
contractSymbol
string
source
enum<string>
default:auto
Available options:
auto,
alpaca,
dukascopy,
kalshi_perps
price_side
enum<string>
default:bid
Available options:
bid,
ask
page_mode
boolean

Dukascopy: retrieve bounded candle file pages; follow next_cursor using the same settings.

cursor
string
start
string<date-time>
end
string<date-time>
timeframe
enum<string>
Available options:
1min,
5min,
15min,
30min,
1h,
4h,
1D,
1W-MON,
1MS,
1Min,
5Min,
15Min,
30Min,
1Hour,
4Hour,
1Day,
1Week,
1Month,
1m,
5m,
15m,
30m,
1w
limit
integer

Kalshi perpetuals: 1–5000; stocks/Dukascopy: 500, 1000, 1500, 2000, 50000 (default 2000).

Required range: 1 <= x <= 50000
adjustment
enum<string>
Available options:
raw,
split,
all
session
enum<string>
Available options:
regular,
extended
format
enum<string>
Available options:
json,
csv
mode
enum<string>
default:normalized

canvas returns item_id, timestamp (UTC), and numeric target columns for SageMaker Canvas. Candle close is the target; economic series retain their selected value. Raw provider fields are available only for event contracts. Missing observations are not filled.

Available options:
normalized,
raw,
canvas
frequency
enum<string>

Alias for timeframe. Perpetuals support the same completed-bar frequencies.

Available options:
1min,
5min,
15min,
30min,
1h,
4h,
1D,
1W-MON,
1MS,
1Min,
5Min,
15Min,
30Min,
1Hour,
4Hour,
1Day,
1Week,
1Month,
1m,
5m,
15m,
30m,
1w

Response

Successful response (illustrative example)

The response is of type object.