Sign in

v5

latestOpenAPI 3.1.0Proprietary2026-08-031,5423,1505.5 MB
Options

Sparse snapshot time-series for one underlier

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.

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

Path parameters

symbolstring required

Underlier ticker.

Example:AAPL

Underlier ticker.

Query parameters

from_datestring required

Inclusive history window start (YYYY-MM-DD).

Inclusive history window start (YYYY-MM-DD).

to_datestring required

Inclusive history window end (YYYY-MM-DD).

Inclusive history window end (YYYY-MM-DD).

expirystring nullable

Optional expiry filter (YYYY-MM-DD). Per-expiry aggregates come from this expiry only.

Optional expiry filter (YYYY-MM-DD). Per-expiry aggregates come from this expiry only.

fieldsstring nullable

CSV of fields to project. Whitelist enforced. Default: underlier_price,underlier_iv_30d_atm,put_call_ratio_volume,total_call_volume,total_put_volume.

Example:underlier_price,put_call_ratio_volume

CSV of fields to project. Whitelist enforced. Default: underlier_price,underlier_iv_30d_atm,put_call_ratio_volume,total_call_volume,total_put_volume.

Response

Sparse snapshot history payload.

Example response

{
  "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": "sugra_crypto",
    "attribution": "Short interest and Reg SHO daily short volume data is owned by and sourced from FINRA (Financial Industry Regulatory Authority).",
    "fallback_chain": [
      "sugra_crypto",
      "sugra_finance"
    ]
  }
}