> ## Documentation Index
> Fetch the complete documentation index at: https://docs.asksurf.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Options Market Data



## OpenAPI

````yaml openapi.json GET /gateway/v1/market/options
openapi: 3.1.0
info:
  title: Hermod
  version: 0.0.1
servers:
  - url: https://api.asksurf.ai
security: []
paths:
  /gateway/v1/market/options:
    get:
      tags:
        - Market
      summary: Options Market Data
      description: >-
        Returns options market data for a `symbol`.


        **Included fields:** open interest, volume, put/call ratio, max pain
        price.
      operationId: market-options
      parameters:
        - description: >-
            Token symbol. Can be `BTC`, `ETH`, `SOL`, `XRP`, `BNB`, `DOGE`,
            `ADA`, or `AVAX`.
          explode: false
          in: query
          name: symbol
          required: true
          schema:
            description: >-
              Token symbol. Can be `BTC`, `ETH`, `SOL`, `XRP`, `BNB`, `DOGE`,
              `ADA`, or `AVAX`.
            enum:
              - BTC
              - ETH
              - SOL
              - XRP
              - BNB
              - DOGE
              - ADA
              - AVAX
            examples:
              - BTC
            type: string
        - description: Field to sort results by
          explode: false
          in: query
          name: sort_by
          schema:
            default: volume_24h
            description: Field to sort results by
            enum:
              - open_interest
              - volume_24h
            examples:
              - volume_24h
            type: string
        - description: Sort order
          explode: false
          in: query
          name: order
          schema:
            default: desc
            description: Sort order
            enum:
              - asc
              - desc
            examples:
              - desc
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleListResponseMarketOptionsItem'
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataAPIError'
          description: Error
      security:
        - AccessToken: []
components:
  schemas:
    SimpleListResponseMarketOptionsItem:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
            - >-
              https://example.com/schemas/SimpleListResponseMarketOptionsItem.json
          format: uri
          readOnly: true
          type: string
        data:
          items:
            $ref: '#/components/schemas/MarketOptionsItem'
          type:
            - array
            - 'null'
        meta:
          $ref: '#/components/schemas/ObjectResponseMeta'
      required:
        - data
        - meta
      type: object
    DataAPIError:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
            - https://example.com/schemas/DataAPIError.json
          format: uri
          readOnly: true
          type: string
        error:
          $ref: '#/components/schemas/DataAPIErrorDetail'
      required:
        - error
      type: object
    MarketOptionsItem:
      additionalProperties: false
      properties:
        exchange:
          description: Options exchange name
          type: string
        max_pain_price:
          description: >-
            Max pain price for the nearest expiry in USD. Only available for
            individual exchanges (Deribit, OKX, Binance, Bybit), not present on
            the `All` aggregate row.
          format: double
          type: number
        open_interest:
          description: Total options open interest in USD
          format: double
          type: number
        put_call_ratio:
          description: >-
            Put/call open interest ratio (put OI / call OI). Values above 1
            indicate bearish sentiment. Only available for individual exchanges
            (Deribit, OKX, Binance, Bybit), not present on the `All` aggregate
            row.
          format: double
          type: number
        symbol:
          description: Underlying token symbol like `BTC` or `ETH`
          type: string
        updated_at:
          description: Unix timestamp (seconds) of last update
          format: int64
          type: integer
        volume_24h:
          description: 24-hour options trading volume in USD
          format: double
          type: number
      required:
        - symbol
        - exchange
        - open_interest
        - volume_24h
        - updated_at
      type: object
    ObjectResponseMeta:
      additionalProperties: false
      properties:
        cached:
          description: Whether this response was served from cache
          type: boolean
        credits_used:
          description: Credits deducted for this request
          format: int64
          type: integer
      required:
        - credits_used
        - cached
      type: object
    DataAPIErrorDetail:
      additionalProperties: false
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
      type: object

````