Sign in

v2

OpenAPI 3.0.02026-07-311824171.4 MB
Market Data
Public

Retrieves summary information such as open interest, 24-hour volume, best bid/ask prices, last trade price, and other market statistics for all instruments in a given currency.

Results can be filtered by instrument kind (future, option, etc.). This method provides a quick overview of market activity across all instruments for a currency.

Note: For real-time updates, we recommend using the WebSocket subscription to ticker.{instrument_name}.{interval} instead of polling this endpoint.

Try in API console

get/public/get_book_summary_by_currency

Query parameters

currency'BTC' | 'ETH' | 'USDC' | 'USDT' | 'EURR' required

Currency, i.e "BTC", "ETH", "USDC"

The currency symbol

kind'future' | 'option' | 'spot' | 'future_combo' | 'option_combo'

Instrument kind: "future", "option", "spot", "future_combo", "option_combo"

Instrument kind, if not provided instruments of all kinds are considered

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Example response

{
  "result": [
    {
      "instrument_name": "BTC-PERPETUAL",
      "high": 7022.89,
      "low": 7022.89,
      "base_currency": "ETH",
      "quote_currency": "USD",
      "volume": 223,
      "bid_price": 7022.89,
      "ask_price": 7022.89,
      "mid_price": 7022.89,
      "mark_price": 7022.89,
      "last": 7022.89,
      "open_interest": 0.5,
      "creation_timestamp": 1536569522277,
      "estimated_delivery_price": 11628.81,
      "current_funding": 0.12344,
      "underlying_index": "index_price",
      "underlying_price": 6745.34,
      "price_change": 10.23
    }
  ]
}