marketoverview.v1.MarketOverviewService
ListMarketOverview
Request
curl --request POST \ \
--url 'https://api.testnet.polyester.com/marketoverview.v1.MarketOverviewService/ListMarketOverview' \
--header 'Content-Type: application/json' \
--header 'Connect-Protocol-Version: 1' \
--data '{
"includeSparklines": false,
"limit": 100,
"orderBy": "ORDER_BY_CHANGE_24H_BPS",
"pageToken": "eyJvZmZzZXQiOjEwMH0",
"sort": "SORT_ASC",
"sparklineIntervals": [
"SPARKLINE_1H"
],
"symbolId": [
1
]
}'Responses
{
"markets": [
{
"bestAskQtyScaled": "100000",
"bestAskTicks": "1",
"bestBidQtyScaled": "100000",
"bestBidTicks": "1",
"change24hBps": 123,
"high24hTicks": "1",
"indexPriceTicks": "61000250000000",
"lastPriceTicks": "61000250000000",
"lastTradeTsNs": "1735689600000000000",
"listedTsNs": "1735689600000000000",
"low24hTicks": "1",
"sparklines": [
{
"closeTicks": [
"1"
],
"interval": "SPARKLINE_1H"
}
],
"symbolId": 1,
"volume24hBaseScaled": "123456",
"volume24hQuoteScaled": "123456",
"volume24hUsdScaled": "123456"
}
],
"nextPageToken": "eyJvZmZzZXQiOjIwMH0"
}marketoverview.v1.ListMarketOverviewRequestmarketoverview.v1.ListMarketOverviewResponseFilter by stable numeric pair IDs from GetSpotConfig. When empty, returns all enabled markets.
Maximum number of markets to return. Defaults to 50 when omitted; maximum is 2000.
Opaque keyset cursor from a previous response. The cursor is exclusive and bound to symbol IDs, sort key, and sort direction. Sparkline options affect only response enrichment and may change between pages.
Sort key. When unset/UNSPECIFIED, defaults to descending 24h USD volume.
Sort direction (DESC=newest/highest first).
When true, include sparklines in each MarketOverview.
Which sparklines to include. If empty and include_sparklines is true, server defaults to 24h.
Numeric spot market identifier.
Last traded price in quote units scaled by 1e9.
Last trade timestamp in nanoseconds since epoch.
Rolling 24h change expressed in basis points (bp). Example: +123 = +1.23%. Measured from the 24h open to the last price, at minute granularity: the 24h open is the price at the start of the minute that contains the time 24h ago or, for a market that first traded later, its first trade. 0 when the market has no trade yet (its last trade timestamp is 0 too) and until its first minute of trading has ended.
Rolling 24h stats. Highest traded price in the 24h window, in quote units scaled by 1e9.
Lowest traded price in the 24h window, in quote units scaled by 1e9.
Rolling 24h base volume scaled by the base asset's market_data_volume_scale from GetSpotConfig. Omitted if the amount exceeds the signed 64-bit range.
Rolling 24h quote volume scaled by the pair's quote_quantity_scale from GetSpotConfig. Omitted if the amount exceeds the signed 64-bit range.
Rolling 24h USD volume, scaled by 1e6 (one unit is 0.000001 USD). Applies the current quote/USD conversion to the rolling quote volume. When conversion is unavailable, USDT and USDC are valued at USD parity. Omitted for other quote assets when a current conversion is unavailable.
Listing timestamp in nanoseconds since epoch. 0 when the pair has no listing time.
Current best bid price in quote units scaled by 1e9.
Best bid quantity scaled by the pair's base_quantity_scale from GetSpotConfig.
Current best ask price in quote units scaled by 1e9.
Best ask quantity scaled by the pair's base_quantity_scale from GetSpotConfig.
Time range and sampling resolution represented by these close prices.
Newest-first close prices in quote units scaled by 1e9.
Current multi-venue index price in quote units scaled by 1e9. Zero when no fresh, valid index price is available.
Opaque cursor for the next page. Empty when no more results exist.
| Key | HTTP status | Connect code | Error | When |
|---|---|---|---|---|
| bad-request | 400 | invalid_argument | Bad Request | Bad request. |
| invalid-argument | 400 | invalid_argument | Invalid Argument | Invalid argument. |
| not-found | 404 | not_found | Not Found | Not found. |
| unavailable | 503 | unavailable | Service Unavailable | Service unavailable. |
| upstream-error | 502 | unavailable | Upstream Error | Upstream error. |