MarketOverviewService

List Market Overviews

List ticker-style market overview rows with optional sparklines. Supports symbol filtering, sorting, and pagination controls.

Method

GET

Path

/v1/spot/markets/overview

Visibility

Public endpoint

GET

/v1/spot/markets/overview

Request

Testnet

curl --request GET \ \
  --url 'https://api.testnet.polyester.com/v1/spot/markets/overview?includeSparklines=false&include_sparklines=false&limit=100&orderBy=CHANGE_24H_BPS&order_by=CHANGE_24H_BPS&pageToken=eyJvZmZzZXQiOjEwMH0&sort=ASC&sparklineIntervals=1h&sparkline_intervals=1h&symbolId=1' \
  --header 'Accept: */*'

Responses

{
  "markets": [
    {
      "bestAskQtyScaled": "100000",
      "bestAskTicks": "0.000000001",
      "bestBidQtyScaled": "100000",
      "bestBidTicks": "0.000000001",
      "change24hBps": 123,
      "high24hTicks": "0.000000001",
      "indexPriceTicks": "0.005",
      "lastPriceTicks": "0.005",
      "lastTradeTsNs": "1735689600000000000",
      "listedTsNs": "1735689600000000000",
      "low24hTicks": "0.000000001",
      "sparklines": [
        {
          "closeTicks": [
            "0.000000001"
          ],
          "interval": "1h"
        }
      ],
      "symbol": "BTC-USDT",
      "volume24hBaseScaled": "123456",
      "volume24hQuoteScaled": "123456",
      "volume24hUsdScaled": "0.123456"
    }
  ],
  "nextPageToken": "eyJvZmZzZXQiOjIwMH0"
}

includeSparklines boolean

When true, include sparklines in each MarketOverview.

include_sparklines boolean

When true, include sparklines in each market.

limit integer ≤ 2000

Maximum markets to return (server default 50, max 2000).

orderBy enum must be defined value

Sort key. When unset/UNSPECIFIED, defaults to descending 24h USD volume.

order_by enum must be defined value

Sort key.

pageToken string max 512 chars

Opaque cursor from the previous response.

sort enum must be defined value

Sort direction.

sparklineIntervals array

Which sparklines to include. If empty and include_sparklines is true, server defaults to 24h.

sparkline_intervals string

Sparkline intervals; repeat query param.

symbolId array max 2000 items, unique

Filter by stable numeric pair IDs from GetSpotConfig. When empty, returns all enabled markets.

symbols string

Filter by specific symbols; repeat query param (e.g., ?symbols=BTC-USDT&symbols=ETH-USDT).

16 fields

bestAskQtyScaled string /^[0-9]…9]+)?$/

Best ask quantity scaled by the pair's base_quantity_scale from GetSpotConfig.

Example 100000

bestAskTicks string /^[0-9]…9]+)?$/

Current best ask price in quote units scaled by 1e9.

Example 0.000000001

bestBidQtyScaled string /^[0-9]…9]+)?$/

Best bid quantity scaled by the pair's base_quantity_scale from GetSpotConfig.

Example 100000

bestBidTicks string /^[0-9]…9]+)?$/

Current best bid price in quote units scaled by 1e9.

Example 0.000000001

change24hBps integer (int32)

Rolling 24h change expressed in basis points (bp). Example: +123 = +1.23%.

Example 123

high24hTicks string /^[0-9]…9]+)?$/

Rolling 24h stats. Highest traded price in the 24h window, in quote units scaled by 1e9.

Example 0.000000001

indexPriceTicks string /^[0-9]…9]+)?$/

Current multi-venue index price in quote units scaled by 1e9. Zero when no fresh, valid index price is available.

Example 0.005

lastPriceTicks string /^[0-9]…9]+)?$/

Last traded price in quote units scaled by 1e9.

Example 0.005

lastTradeTsNs string /^[0-9]+$/

Last trade timestamp in nanoseconds since epoch.

Example 1735689600000000000

listedTsNs string /^[0-9]+$/

Listing timestamp in nanoseconds since epoch.

Example 1735689600000000000

low24hTicks string /^[0-9]…9]+)?$/

Lowest traded price in the 24h window, in quote units scaled by 1e9.

Example 0.000000001

2 fields

symbol string

Trading pair symbol, e.g. BTC-USDT.

Example BTC-USDT

volume24hBaseScaled string /^[0-9]…9]+)?$/

24h base volume; omitted if the scaled amount exceeds int64.

Example 123456

volume24hQuoteScaled string /^[0-9]…9]+)?$/

24h executed quote volume; omitted if the scaled amount exceeds int64.

Example 123456

volume24hUsdScaled string /^[0-9]…9]+)?$/

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.

Example 0.123456

nextPageToken string

Opaque cursor for the next page. Empty when no more results exist.

Example eyJvZmZzZXQiOjIwMH0

Possible errors: 5

Key	Status	Error	When
unauthenticated	401	Unauthenticated	Authentication required.
permission-denied	403	Permission Denied	Permission denied.
invalid-argument	400	Invalid Argument	Invalid argument.
not-found	404	Not Found	Not found.
unavailable	503	Unavailable	Service unavailable.

GET

/v1/spot/markets/overview

Request

Testnet

curl --request GET \ \
  --url 'https://api.testnet.polyester.com/v1/spot/markets/overview?includeSparklines=false&include_sparklines=false&limit=100&orderBy=CHANGE_24H_BPS&order_by=CHANGE_24H_BPS&pageToken=eyJvZmZzZXQiOjEwMH0&sort=ASC&sparklineIntervals=1h&sparkline_intervals=1h&symbolId=1' \
  --header 'Accept: */*'

Responses

{
  "markets": [
    {
      "bestAskQtyScaled": "100000",
      "bestAskTicks": "0.000000001",
      "bestBidQtyScaled": "100000",
      "bestBidTicks": "0.000000001",
      "change24hBps": 123,
      "high24hTicks": "0.000000001",
      "indexPriceTicks": "0.005",
      "lastPriceTicks": "0.005",
      "lastTradeTsNs": "1735689600000000000",
      "listedTsNs": "1735689600000000000",
      "low24hTicks": "0.000000001",
      "sparklines": [
        {
          "closeTicks": [
            "0.000000001"
          ],
          "interval": "1h"
        }
      ],
      "symbol": "BTC-USDT",
      "volume24hBaseScaled": "123456",
      "volume24hQuoteScaled": "123456",
      "volume24hUsdScaled": "0.123456"
    }
  ],
  "nextPageToken": "eyJvZmZzZXQiOjIwMH0"
}

Polyester is best experienced on desktop.

Request

Responses