Available Streams
OHLCV Pairs Stream
The OHLCV Pairs stream provides real-time updates on the Open, High, Low, Close prices and Volume of one or many token pairs at configurable intervals. This documentation follows our standard streaming API structure.
Credit Cost
TBD
Supported Chains
- Base Mainnet
- BSC Mainnet
- Ethereum Mainnet
Supported DEXes
- Uniswap V2, V3
- PancakeSwap
This stream is currently in Beta. It is stable for testing and evaluation but may undergo changes in schema or behavior as we continue to improve it. No API credits are currently charged.
We welcome your feedback so please reach out to us directly to report issues or request features.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
chain_name | enum | Yes | Chain name to filter events (e.g. BASE_MAINNET , ETH_MAINNET , BSC_MAINNET ) |
pair_addresses | array<string> | Yes | Array of pair addresses on supported DEXes and chains to track |
interval | enum | Yes | Frequency of OHLCV data updates, ranging from sub-second to one day |
timeframe | enum | Yes | Historical lookback period for OHLCV data, ranging from one minute to one month |
limit | int | No | Maximum number of items returned per stream message to control payload size |
Subscription
You can subscribe to the ohlcvCandlesForPair
endpoint to receive the pricing events.
Basic Subscription Query
Complete Subscription Query
Response Format
Here’s an example of the response data structure:
Field Descriptions
Field | Type | Description |
---|---|---|
chain_name | string | The blockchain network where the pair exists |
pair_address | string | The address of the DEX pair |
interval | enum | The candle interval |
timeframe | enum | The requested timeframe |
timestamp | string | ISO timestamp for the candle |
open | float | Opening price for the interval |
high | float | Highest price during the interval |
low | float | Lowest price during the interval |
close | float | Closing price for the interval |
volume | float | Trading volume during the interval |
volume_usd | float | Trading volume in USD |
quote_rate | float | Exchange rate between base and quote tokens |
quote_rate_usd | float | USD value of the quote rate |
base_token | object | Information about the base token in the pair |
quote_token | object | Information about the quote token in the pair |