Get Book Summary by Instrument
Method: public/get_book_summary_by_instrument
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| instrumentName | string | true | Instrument name |
Response
Returns an object with the following fields:
| Name | Type | Description |
|---|---|---|
| askPrice | string | The current best ask price, null if there aren't any asks |
| baseCurrency | string | Base currency |
| bidPrice | string | The current best bid price, null if there aren't any bids |
| createdAt | long | The timestamp (milliseconds since the Unix epoch) |
| currentFunding | string | Current funding (perpetual only) |
| estimatedDeliveryPrice | string | Optional (only for derivatives). Estimated delivery price for the market. For more details, see Contract Specification > General Documentation > Expiration Price. |
| funding8h | string | Funding 8h (perpetual only) |
| high | string | Price of the 24h highest trade |
| instrumentName | string | Unique instrument identifier |
| interestRate | string | Interest rate used in implied volatility calculations (options only) |
| last | string | The price of the latest trade, null if there weren't any trades |
| low | string | Price of the 24h lowest trade, null if there weren't any trades |
| markIv | string | (Only for option) implied volatility for mark price |
| markPrice | string | The current instrument market price |
| midPrice | string | The average of the best bid and ask, null if there aren't any asks or bids |
| openInterest | string | 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 and it is the underlying base currency coin. |
| priceChange | string | 24-hour price change expressed as a percentage, null if there weren't any trades |
| quoteCurrency | string | Quote currency |
| underlyingIndex | string | Name of the underlying future, or 'index_price' (options only) |
| underlyingPrice | string | underlying price for implied volatility calculations (options only) |
| volume | string | The total 24h traded volume (in base currency) |
| volumeNotional | string | Volume in quote currency (futures and spots only) |
| volumeUsd | string | Volume in USD |
Response Example
{
"rid": 65001,
"result": [{
"askPrice": "113853.0",
"baseCurrency": "BTC",
"bidPrice": "113852.5",
"createdAt": 1760410463912,
"currentFunding": "0.0",
"estimatedDeliveryPrice": "113858.59",
"funding8h": "0.0",
"high": "115999.0",
"instrumentName": "BTC-PERPETUAL",
"last": "113808.0",
"low": "113768.0",
"markPrice": "113849.45",
"midPrice": "113852.75",
"openInterest": "13795028350",
"priceChange": "-1.5472",
"quoteCurrency": "USD",
"volume": "6200.03711088",
"volumeNotional": "711975490.0",
"volumeUsd": "711975490.0"
}]
}