Klines (OHLCV)

Candlestick data. interval = 1m,5m,15m,30m,1h,4h,6h,12h,1d,1w. start is optional (defaults to a sane window).

GET /v3/perps/klines/{instrument}

Klines (OHLCV)

cURL

curl --request GET \
  --url https://api.polynode.dev/v3/perps/klines/{instrument} \
  --header 'x-api-key: <api-key>'

200

{
  "data": [
    [
      1783735200000,
      "63976",
      "64120",
      "63960",
      "64117",
      "2.91545",
      514
    ],
    [
      1783738800000,
      "64123",
      "64123",
      "64089",
      "64112",
      "1.4199599999999999",
      274
    ]
  ],
  "instrument_id": 6,
  "more": false,
  "symbol": "BTC-USD"
}

Candles are [open_time, open, high, low, close, volume, trade_count], oldest first, wrapped as {"instrument_id", "symbol", "data", "more"}.

Query parameters

Parameter	Description
interval	1m, 5m, 15m, 30m, 1h, 4h, 6h, 12h, 1d, 1w (default 1h)
start	Window start (Unix ms). Optional — defaults to limit candles ending now
end	Window end (Unix ms)
limit	Number of candles (default 100)

1m and 1h candles stream live on perps_klines:<instrument>:<interval> — the current candle is pushed whenever it changes, and a candle is final once one with a later open_time arrives.

Authorizations

x-api-key · string · header · required

Path Parameters

instrument · string · required

Instrument id (e.g. 6), symbol (BTC-USD), or bare asset (btc).

Query Parameters

interval · string

Candle interval (default 1h).

start · integer

Window start, Unix ms (optional).

end · integer

Window end, Unix ms.

limit · integer

Max rows to return.

Response

200 - application/json

Success