Parameters
- typestringREQUIRED
The method type to call
- reqobjectREQUIRED
Request parameters for candle snapshot
- coinstringREQUIRED
Trading pair symbol to retrieve candlestick data for, using standard symbols (e.g., 'BTC', 'ETH', 'SOL') for perpetuals or @index notation for spot markets. For HIP-3 assets, prefix the coin with the dex name, e.g. 'xyz:XYZ100'
- intervalstringREQUIRED
Candlestick time interval specifying the duration of each candle. Supported intervals: '1m', '3m', '5m', '15m', '30m', '1h', '2h', '4h', '8h', '12h', '1d', '3d', '1w', '1M'
- startTimeintegerREQUIRED
Query start time as Unix timestamp in milliseconds (inclusive). Candles at or after this time will be returned. Use Date.now() in JavaScript or time.time()*1000 in Python to generate timestamps
- endTimeintegerREQUIRED
Query end time as Unix timestamp in milliseconds (inclusive). Candles at or before this time will be returned. Defines the upper bound of the historical data range
Returns
- arrayarray
Array of candlestick data
- tinteger
Candle open timestamp in milliseconds (Unix epoch time). Marks the beginning of this candlestick period. Use for x-axis plotting in charts and time-series analysis
- Tinteger
Candle close timestamp in milliseconds (Unix epoch time). Marks the end of this candlestick period. The time range [t, T] defines the complete candle duration
- sstring
Trading pair symbol for this candle, matching the requested coin parameter (e.g., 'BTC', 'ETH'). Useful when processing multiple symbols simultaneously
- istring
Candlestick interval matching the requested interval parameter (e.g., '1m', '5m', '1h', '1d'). Confirms the time granularity of this candle data
- ostring
Opening price - the first trade price when the candle period began. Returned as string to preserve full decimal precision for accurate charting and analysis
- cstring
Closing price - the last trade price when the candle period ended. Critical for price trend analysis and technical indicators. String format maintains decimal precision
- hstring
Highest price reached during this candle period. Represents the peak price within the time interval. Returned as string for precise decimal values
- lstring
Lowest price reached during this candle period. Represents the minimum price within the time interval. String format preserves decimal precision
- vstring
Total trading volume during this candle period, measured in the base asset quantity. Indicates market activity and liquidity. Returned as string to maintain precision for large volume numbers
- ninteger
Total number of individual trades that occurred during this candle period. Higher trade counts indicate more active market participation and can signal increased interest or volatility