Skip to main content
GET
Python (SDK)

Authorizations

x-api-key
string
header
required

Your Compass API Key. Get your key here.

Query Parameters

symbol
string
default:AAPL
required

Asset ticker (e.g. AAPL, GOLD, EUR). The xyz: HIP-3 DEX prefix is added server-side if not already present.

Required string length: 1 - 64
interval
enum<string>
default:1h
required

Candle interval: 1m, 5m, 15m, 1h, 4h, 1d, 1w

Available options:
1m,
5m,
15m,
1h,
4h,
1d,
1w
limit
integer
default:200

Number of candles to return (max 5000, capped by Hyperliquid).

Required range: 1 <= x <= 5000
start_time
integer | null

Optional start of the candle window in unix milliseconds. If omitted, computed as end_time - limit * interval.

end_time
integer | null

Optional end of the candle window in unix milliseconds. Defaults to now.

Response

Successful Response

OHLCV candle series for a single asset/interval.

symbol
string
required

Asset ticker the candles are for (without DEX prefix)

interval
string
required

Candle interval that was requested

candles
Candle · object[]
required

Candles ordered oldest → newest