public/get_book_summary_by_instrument

Retrieves summary information such as open interest, 24-hour volume, best bid/ask prices, last trade price, mark price, and other market statistics for a specific instrument.

This method provides a quick overview of current market activity and liquidity for a single instrument.

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/public/get_book_summary_by_instrument \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 3659,
  "method": "public/get_book_summary_by_instrument",
  "params": {
    "instrument_name": "ETH-22FEB19-140-P"
  }
}
'

200

{
  "jsonrpc": "2.0",
  "id": 3659,
  "result": [
    {
      "volume": 0.55,
      "underlying_price": 121.38,
      "underlying_index": "index_price",
      "quote_currency": "USD",
      "price_change": -26.7793594,
      "open_interest": 0.55,
      "mid_price": 0.2444,
      "mark_price": 80,
      "low": 0.34,
      "last": 0.34,
      "interest_rate": 0.207,
      "instrument_name": "ETH-22FEB19-140-P",
      "high": 0.34,
      "creation_timestamp": 1550227952163,
      "bid_price": 0.1488,
      "base_currency": "ETH",
      "ask_price": 0.34
    }
  ]
}

Query Parameters

instrument_name · string · required

Instrument name Unique instrument identifier

Example:

"BTC-PERPETUAL"

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · object[] · required

Hide child attributes

result. instrument_name · string · required

Unique instrument identifier

Example:

"BTC-PERPETUAL"

result. high · number · required

Price of the 24h highest trade

Example:

7022.89

result. low · number · required

Price of the 24h lowest trade, null if there weren't any trades

Example:

7022.89

result. base_currency · string · required

Base currency

Example:

"ETH"

result. quote_currency · string · required

Quote currency

Example:

"USD"

result. volume · number · required

The total 24h traded volume (in base currency)

Example:

223

result. bid_price · number · required

The current best bid price, null if there aren't any bids

Example:

7022.89

result. ask_price · number · required

The current best ask price, null if there aren't any asks

Example:

7022.89

result. mid_price · number · required

The average of the best bid and ask, null if there aren't any asks or bids

Example:

7022.89

result. mark_price · number · required

The current instrument market price

Example:

7022.89

result. last · number · required

The price of the latest trade, null if there weren't any trades

Example:

7022.89

result. open_interest · number · required

Optional (only for derivatives). The total amount of outstanding contracts in the corresponding amount units. For perpetual and inverse futures the amount is in USD units. For options and linear futures it is the underlying base currency coin.

Example:

0.5

result. creation_timestamp · integer · required

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result. estimated_delivery_price · number

Optional (only for derivatives). Estimated delivery price for the market.

Example:

11628.81

result. volume_usd · number

Volume in USD

result. volume_notional · number

Volume in quote currency (futures and spots only)

result. current_funding · number

Current funding (perpetual only)

Example:

0.12344

result. funding_8h · number

Funding 8h (perpetual only)

result. mark_iv · number

(Only for option) implied volatility for mark price

result. interest_rate · number

Interest rate used in implied volatility calculations (options only)

Example:

0

result. underlying_index · string

Name of the underlying future, or 'index_price' (options only)

Example:

"index_price"

result. underlying_price · number

underlying price for implied volatility calculations (options only)

Example:

6745.34

result. price_change · number

24-hour price change expressed as a percentage, null if there weren't any trades

Example:

10.23

id · integer

The id that was sent in the request