CLclear-street
Instrument Data

Get Snapshots

Changed on

Get market data snapshots for one or more securities.

Three targeting modes, mutually exclusive: instrument_ids (1-100 ids), underlying_instrument_id + expiry together, which resolves the underlier's option chain for that expiry and returns a snapshot for every contract in it (uncapped), or event_codes (1-100 event tickers), which returns a snapshot for every market in those events in any status (uncapped). Unknown event codes are ignored.

get/v1/market-data/snapshot

Request

  • Base URL
    https://api.clearstreet.com
  • Auth
    HTTP bearer

Query parameters

instrument_idsInstrumentIdOrSymbol[]

Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols). Accepts 1 to 100 IDs; duplicate resolved ids collapse to a single row. Required unless underlying_instrument_id and expiry are provided; mutually exclusive with that pair.

underlying_instrument_idstring

Instrument identifier: either an instrument UUID or a symbol (symbol for equities, OSI for options). Non-UUID inputs are resolved server-side.

Instrument identifier or symbol of the underlying equity/index for an option chain. Must be provided together with expiry; mutually exclusive with instrument_ids.

expirystring date

Filter the option chain to contracts expiring on this date (YYYY-MM-DD). Must be provided together with underlying_instrument_id.

Response

Market data snapshots

Example response

{
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero"
  },
  "metadata": {
    "page_number": 1,
    "total_items": 42,
    "total_pages": 5
  },
  "data": [
    {
      "cumulative_volume": 12345678,
      "instrument_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8",
      "last_quote": {
        "ask": "210.14",
        "ask_size": 200,
        "ask_timestamp": "2026-08-11T14:30:01.987654321Z",
        "ask_venue": "XNAS",
        "bid": "210.10",
        "bid_size": 300,
        "bid_timestamp": "2026-08-11T14:30:00.123456789Z",
        "bid_venue": "XNAS",
        "midpoint": "210.12"
      },
      "last_trade": {
        "price": "210.12",
        "size": 100,
        "timestamp": "2026-08-11T14:30:02.123456789Z",
        "venue": "XNAS"
      },
      "name": "Apple Inc.",
      "open_interest": 4520,
      "session": {
        "change": "4.68",
        "change_percent": "2.2780",
        "cumulative_volume": 12345678,
        "high": "211.30",
        "low": "207.55",
        "ohlv_applicable": true,
        "ohlv_date": "2026-08-11",
        "open": "208.00",
        "previous_close": "205.44",
        "previous_close_unadjusted": "208.30"
      },
      "short_sale_restricted": false,
      "symbol": "AAPL"
    }
  ]
}

Changes

  • 7e4b278ca27aRevision changes
    • info

      added the non-success response with the status

  • 1bd9eddeffc8Revision changes
    • breaking

      the /// response's property type changed from no type to object for status

    • warning

      for the query request parameter instrument_ids, the type of property items/ changed from no type to string

    • info

      added the new optional query request parameter expiry

    • info

      added the new optional query request parameter underlying_instrument_id

    • info

      added the non-success response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      the response property /// became required for the status

    • info

      response property allOf[subschema #2]/data/items/cumulative_volume deprecated

    • info

      removed subschema #1 from the /// response property oneOf list for the response status

    • info

      added the required property //// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the success response with the status