Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

A Lean API key, sent as Authorization: Bearer <key>. A test key (lean_sk_test_...) simulates orders and fills with no money; a live key (lean_sk_live_...) trades for real within the key's limits. Every successful response says which mode answered in data.livemode.

Path Parameters

id
string
required

A market id from GET /markets, or a venue symbol that names one market: a Polymarket token id, a Hyperliquid book coin (#…, written %23… in a path), or a leg ticker (pm:…, hl:…, pmus:… or a Kalshi market ticker) that lists only this outcome. A symbol that names more than one market, such as a Polymarket condition id, is refused with 400; use the token id or the market id instead.

Required string length: 1 - 512
Example:

"mkt_bmZsOjIwMjYtMTAtMTE6REVOLUxBQwpzcHJlYWQ6Z2FtZTpERU46LTMuNQpERU4"

Query Parameters

interval
enum<string>
default:1m

Length of each candle.

Available options:
1s,
1m,
5m,
15m,
1h,
2h
start
string<date-time>

First candle at or after this time, rounded down to the interval. Defaults to 100 intervals before end.

end
string<date-time>

Candles that open before this time. Defaults to now.

venue
enum<string>

Only this venue leg.

Available options:
kalshi,
polymarket,
polymarket_us,
hyperliquid

Response

Candles for each venue leg, oldest first

success
enum<boolean>
required
Available options:
true
data
object
required
meta
object
required