API Reference

Retrieve Coin OHLCV

Retrieve candlestick data in OHLCV format of a specified token.

📘

Supported on Sui Mainnet.

🚧

The Indexing API on Sui is currently exclusively available to Pro Members. Non-Pro members can also enjoy a trial period with an allocation of 30 free calls. If you're interested, please register directly through here. Please note that the API Key can also be used for your RPC endpoint.

📘

Data retention for new intervals

30s, 1m : Up to 4 hours

5m: Up to 24 hours

15m: Up to 7 days

1h, 4h: Up to 30 days

Parameter

  • token, string – the full type tag of the target token to retrieve OHLCV data for (e.g., 0xdeeb7a4662eec9f2f3def03fb937a663dddaa2e215b8078a284d026b7946c270::deep::DEEP).
  • interval, string – the time interval of each candlestick. Optional values: 30s, 1m, 5m, 15m, 1h, 4h, 1d, 1w, 1M.
  • start, integer – start time of the K-line chart in Unix timestamp milliseconds.

Response

  • ohlcs, array – List of candlestick (OHLCV) data points.
    • timestamp, integer – Start time of the candlestick in Unix timestamp (seconds).
    • open, number – Opening price of the token at the beginning of the interval.
    • high, number – Highest price during the interval.
    • low, number – Lowest price during the interval.
    • close, number – Closing price at the end of the interval.
    • buyVolume, number – Total trading volume (in token units) of buy trades during the interval.
    • sellVolume, number – Total trading volume (in token units) of sell trades during the interval.
    • volume, number – Total trading volume (buy + sell) during the interval.
    • price, number – price for the interval.
Language
Credentials
Header
Click Try It! to start a request and see the response here!