OHLCV candles
get_ohlcvRead-onlyIdempotent
OHLCV candles for a DeepBook pool (oldest first). Intervals: 1m, 5m, 15m, 30m, 1h, 4h, 1d, 1w. Volume is in the base asset. Education/information only; not financial advice. Read-only public data, may be delayed or wrong. Free: 100 calls/day per client, then 0.002 USDC per call on Sui mainnet, prepaid in batches of about 0.01 USDC (the payment-required response gives an exact amount and a payment_token).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pool | Yes | DeepBook pool name BASE_QUOTE, e.g. SUI_USDC (case-insensitive; '/' or '-' also accepted) | |
| limit | No | Number of candles (1-500, default 24) | |
| end_time | No | Unix timestamp in SECONDS | |
| interval | No | 1h | |
| payment_tx | No | Only after the free tier: Sui transaction digest of your exact USDC payment for payment_token (see the payment-required response) | |
| start_time | No | Unix timestamp in SECONDS | |
| payment_token | No | Only after the free tier: the private payment_token from the payment-required response; it holds your prepaid calls |