Sparse snapshot time-series for one underlier

GET

/api/v1/options/{symbol}/snapshot/history

Last modified:2026-07-19 17:02:27

Maintainer:Not configured

OperationId:options_symbol_snapshot_history

Time-series of per-date snapshot projections between from_date and to_date (both inclusive). Sparse: dates without a snapshot are represented by a null entry in snapshots. The fields CSV parameter restricts the projection to a whitelist; default fields are underlier_price,underlier_iv_30d_atm,put_call_ratio_volume,total_call_volume,total_put_volume. Per-expiry aggregates come from the matching expiry block when ?expiry=YYYY-MM-DD is set; without the filter, volumes / OI sum across all fetched expiries and put-call ratios are recomputed from the aggregate totals (max-pain and DTE keep the front-expiry value). When ?expiry is set but the requested expiry is absent from a given day's snapshot, that day's entry is null (sparse) rather than a row with all-None fields. The window may not extend past the 90-day retention boundary nor into the future.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://sugra.ai/api/v1/options//snapshot/history?from_date=undefined&to_date=undefined&expiry=undefined&fields=undefined' \
--header 'x-api-key: <api-key>'

Responses

🟢200OK

application/json

Sparse snapshot history payload.

Bodyapplication/json

Example

{
    "data": {
        "symbol": "string",
        "from_date": "string",
        "to_date": "string",
        "fields": [
            "string"
        ],
        "expiry_filter": "string",
        "snapshots": [
            {
                "snapshot_date": "string",
                "fields": {
                    "property1": "string",
                    "property2": "string"
                }
            }
        ]
    },
    "meta": {
        "endpoint": "/api/v1/fred/us/cpi",
        "data_time": "2026-04-16T14:30:00Z",
        "response_time": "2026-04-16T14:30:12Z",
        "provider": "Sugra API v1.0.1",
        "source": "string",
        "attribution": "string",
        "fallback_used": true,
        "fallback_chain": [
            "string"
        ],
        "cached": true,
        "stale": true
    }
}

🟠401Unauthorized

🟠422Parameter Error

🟠429

🔴503Service Unavailable

Modified at 2026-07-19 17:02:27

Latest or dated options snapshot for one underlier

Precomputed IV surface + term structure for one underlier