Options Market Data

GET/gateway/v1/market/options

Returns options market data for a `symbol`.

Included fields: open interest, volume, put/call ratio, max pain price.

Query Parameters

symbolenum<string>required

Token symbol. Can be `BTC`, `ETH`, `SOL`, `XRP`, `BNB`, `DOGE`, `ADA`, or `AVAX`.

Available options:BTCETHSOLXRPBNBDOGEADAAVAX

Example: BTC

sort_byenum<string>

Field to sort results by

Available options:open_interestvolume_24h

Example: volume_24h

orderenum<string>

Sort order

Available options:ascdesc

Example: desc

Options Market Data

const options = {method: 'GET'};

fetch('https://api.asksurf.ai/gateway/v1/market/options?symbol=BTC&sort_by=volume_24h&order=desc', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "$schema": "https://example.com/schemas/SimpleListResponseMarketOptionsItem.json",
  "data": [
    {
      "exchange": "<string>",
      "max_pain_price": 123,
      "open_interest": 123,
      "project_id": "<string>",
      "put_call_ratio": 123,
      "symbol": "<string>",
      "updated_at": 123,
      "volume_24h": 123
    }
  ],
  "meta": {
    "cached": true,
    "credits_used": 123,
    "empty_reason": "<string>"
  }
}