Markets

Get options summary (Deribit-compatible format)

get/options-summary

Request

  • Base URL: https://testnet-api.hypercall.xyz
  • URL: https://testnet-api.hypercall.xyz/options-summary
  • Auth: none declared

Query parameters

currencystring nullable

Filter by currency (e.g., "BTC", "ETH"). Supports comma-separated values and "ALL". When omitted, returns options for all active underlyings.

kindstring nullable

Option kind

include_rfq_provider_quotesboolean nullable

Include raw per-provider RFQ indicative quotes in each option summary.

rfq_provider_quotesboolean nullable

Backward-compatible short alias for include_rfq_provider_quotes.

rfq_provider_quotes_limitinteger nullable

Optional cap for per-provider RFQ indicative quotes per instrument.

provider_quotes_limitinteger nullable

Backward-compatible short alias for rfq_provider_quotes_limit.

limitinteger nullable

Short GET param alias for rfq_provider_quotes_limit.

Response

Options summary

ask_ivnumber double nullable

Quote-derived ask-side implied volatility

ask_pricenumber double required

Best ask price

base_currencystring required

Base currency

best_ask_sizenumber double nullable

Best ask size on the orderbook, in human-readable contracts.

best_bid_sizenumber double nullable

Best bid size on the orderbook, in human-readable contracts.

bid_ivnumber double nullable

Quote-derived bid-side implied volatility

bid_pricenumber double required

Best bid price

creation_timestampinteger required

Creation timestamp

estimated_delivery_pricenumber double required

Estimated delivery price

expiration_timestampinteger required

Expiration timestamp

highnumber double nullable

24h high

indicative_ask_pricenumber double nullable

Best indicative RFQ ask price from quote providers.

indicative_ask_sizenumber double nullable

Best indicative RFQ ask size, in human-readable contracts.

indicative_bid_pricenumber double nullable

Best indicative RFQ bid price from quote providers.

indicative_bid_sizenumber double nullable

Best indicative RFQ bid size, in human-readable contracts.

instrument_idinteger required

Instrument ID

instrument_namestring required

Instrument name/symbol

interest_ratenumber double required

Interest rate

lastnumber double nullable

Last trade price

lownumber double nullable

24h low

mark_ivnumber double nullable

Theoretical implied volatility used for mark price and greeks

mark_pricenumber double required

Mark price

mid_pricenumber double required

Mid price

open_interestnumber double required

Open interest

option_token_addressstring nullable

Option token contract address

price_changenumber double nullable

24h price change in percentage points, computed as: ((current_best_bid - reference_best_ask_near_24h_ago) / reference_best_ask_near_24h_ago) * 100.

quote_currencystring required

Quote currency

theoretical_pricenumber double nullable

Theoretical option price derived from the vol oracle, when available.

underlying_indexstring required

Underlying index name

underlying_pricenumber double required

Underlying price

volumenumber double required

24h volume

volume_usdnumber double required

24h volume in USD

Changes

No recorded changes to this operation across all 1 revision of this API.