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&limit=100&orderBy=CHANGE_24H_BPS&sort=ASC&sparklineIntervals=1h&symbols=BTC-USDT' \
  --header 'Accept: */*'

Responses

{
  "markets": [
    {
      "bestAsk": "0.000000001",
      "bestAskQty": "0.001",
      "bestBid": "0.000000001",
      "bestBidQty": "0.001",
      "change24hBps": 123,
      "high24h": "0.000000001",
      "indexPrice": "61000.25",
      "lastPrice": "61000.25",
      "lastTradeTsNs": "1735689600000000000",
      "listedTsNs": "1735689600000000000",
      "low24h": "0.000000001",
      "sparklines": [
        {
          "close": [
            "0.000000001"
          ],
          "interval": "1h"
        }
      ],
      "symbol": "BTC-USDT",
      "volume24hBase": "0.00123456",
      "volume24hQuote": "0.123456",
      "volume24hUsd": "0.123456"
    }
  ],
  "nextPageToken": "eyJvZmZzZXQiOjIwMH0"
}

includeSparklines 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.

pageToken string max 512 chars

Opaque cursor from the previous response.

sort enum must be defined value

Sort direction.

sparklineIntervals string

Sparkline intervals; repeat query param.

symbols string

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

16 fields

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

Current best ask price as a decimal string in quote asset units.

Example 0.000000001

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

Best ask quantity as a decimal string in base asset units.

Example 0.001

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

Current best bid price as a decimal string in quote asset units.

Example 0.000000001

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

Best bid quantity as a decimal string in base asset units.

Example 0.001

change24hBps integer (int32)

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.

Example 123

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

Highest traded price in the rolling 24h window, as a decimal string in quote asset units.

Example 0.000000001

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

Current multi-venue index price as a decimal string in quote asset units. Zero when no fresh, valid index price is available.

Example 61000.25

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

Last traded price as a decimal string in quote asset units, for example '28334.99'.

Example 61000.25

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

Last trade timestamp in nanoseconds since epoch.

Example 1735689600000000000

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

Listing timestamp in nanoseconds since epoch. 0 when the pair has no listing time.

Example 1735689600000000000

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

Lowest traded price in the rolling 24h window, as a decimal string in quote asset units.

Example 0.000000001

2 fields

symbol string

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

Example BTC-USDT

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

Rolling 24h base volume as a decimal string in base asset units. Omitted when the volume exceeds the supported range.

Example 0.00123456

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

Rolling 24h executed quote volume as a decimal string in quote asset units. Omitted when the volume exceeds the supported range.

Example 0.123456

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

Rolling 24h USD volume as a decimal string in USD with up to 6 decimal places. 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	HTTP status	Connect code	Error	When
unauthenticated	401	unauthenticated	Unauthenticated	Authentication required.
permission-denied	403	permission_denied	Permission Denied	Permission denied.
invalid-argument	400	invalid_argument	Invalid Argument	Invalid argument.
not-found	404	not_found	Not Found	Not found.
unavailable	503	unavailable	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&limit=100&orderBy=CHANGE_24H_BPS&sort=ASC&sparklineIntervals=1h&symbols=BTC-USDT' \
  --header 'Accept: */*'

Responses

{
  "markets": [
    {
      "bestAsk": "0.000000001",
      "bestAskQty": "0.001",
      "bestBid": "0.000000001",
      "bestBidQty": "0.001",
      "change24hBps": 123,
      "high24h": "0.000000001",
      "indexPrice": "61000.25",
      "lastPrice": "61000.25",
      "lastTradeTsNs": "1735689600000000000",
      "listedTsNs": "1735689600000000000",
      "low24h": "0.000000001",
      "sparklines": [
        {
          "close": [
            "0.000000001"
          ],
          "interval": "1h"
        }
      ],
      "symbol": "BTC-USDT",
      "volume24hBase": "0.00123456",
      "volume24hQuote": "0.123456",
      "volume24hUsd": "0.123456"
    }
  ],
  "nextPageToken": "eyJvZmZzZXQiOjIwMH0"
}