Subscriptions (WebSockets) require a Growth or Enterprise plan. Learn more.
Returns
Arguments
The token contract address. Required unless you are on an enterprise plan including PriceFeed features.
Example Response
Usage Guidelines
- Provide
address(token contract address) andnetworkIdto subscribe to price updates for a specific token priceUsdreturns the current USD price of the token, updated with every on-chain swap- Optionally specify
sourcePairAddressto get pricing from a specific liquidity pool instead of the default top pair - Use
blockNumberto track which block the price update originated from - This subscription is ideal for simple price feeds — use
onBarsUpdatedif you need OHLCV candlestick data
Troubleshooting Tips
How is the price determined?
How is the price determined?
By default, the price is derived from the token’s top liquidity pair. You can override this by passing a
sourcePairAddress to use a specific pool for pricing.How often are updates sent?
How often are updates sent?
Updates are sent in real-time with every swap that affects the token’s price. High-volume tokens will produce more frequent updates.
When should I use onPriceUpdated vs onBarsUpdated?
When should I use onPriceUpdated vs onBarsUpdated?
Use
onPriceUpdated for a simple, real-time price feed (e.g., displaying a live price ticker). Use onBarsUpdated when you need OHLCV candlestick data, volume breakdowns, or multiple time resolutions for charting.What about the poolAddress and confidence fields?
What about the poolAddress and confidence fields?
These fields are deprecated. Pricing is no longer based on specific pools, so these values are no longer meaningful. Use
blockNumber instead to track the source of price updates.