Docs
View as Markdown

finance.options

stable 2 credits

Delayed options chain for a ticker, every listed contract with quotes and Greeks.

GET /v1/finance/options

What you get#

A list of Finance results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

  • 2 credits for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
symbolstringyes(required)Underlying ticker, e.g. AAPL, or an index with a leading underscore (_SPX)max 10 chars; must match _?[A-Z0-9]{1,9}; trimmed, upper

Request#

curl "https://api.onekey.dev/v1/finance/options?symbol=AAPL" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Finance response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": [
    {
      "market": {
        "symbol": "AAPL261002P00310000",
        "bid": 0.01,
        "ask": 0.02,
        "price": 0.02,
        "open": 0.05,
        "high": 0.05,
        "low": 0.01,
        "volume": 2074,
        "openInterest": 2356
      },
      "ext": {
        "lastTradeTime": "2026-10-01T15:59:25Z",
        "impliedVolatility": 0.4796,
        "delta": -0.0059,
        "gamma": 0.002,
        "theta": -0.0151,
        "vega": 0.003,
        "rho": -0.0001,
        "theoreticalPrice": 0.015
      }
    },
    {
      "market": {
        "symbol": "AAPL261002P00315000",
        "bid": 0.02,
        "ask": 0.03,
        "price": 0.03,
        "open": 0.08,
        "high": 0.11,
        "low": 0.02,
        "volume": 7158,
        "openInterest": 1921
      },
      "ext": {
        "lastTradeTime": "2026-10-01T15:54:38Z",
        "impliedVolatility": 0.3951,
        "delta": -0.0097,
        "gamma": 0.0038,
        "theta": -0.0212,
        "vega": 0.0047,
        "rho": -0.0003,
        "theoreticalPrice": 0.0212
      }
    }
  ],
  "metadata": {
    "platform": "finance",
    "endpoint": "options",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 2,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
optionmarket.symbol-
bidmarket.bidtoNumber
askmarket.asktoNumber
last_trade_pricemarket.pricetoNumber
openmarket.opentoNumber
highmarket.hightoNumber
lowmarket.lowtoNumber
volumemarket.volumetoNumber
open_interestmarket.openInteresttoNumber
last_trade_timeext.lastTradeTimetoIsoDate
ivext.impliedVolatilitytoNumber
deltaext.deltatoNumber
gammaext.gammatoNumber
thetaext.thetatoNumber
vegaext.vegatoNumber
rhoext.rhotoNumber
theoext.theoreticalPricetoNumber

Caching and freshness#

  • Fresh for about 1 minute. Repeat calls in that window are served from cache and are free.
  • Between 1 minute and 5 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 15 minutes more (marked stale).
  • A "not found" is remembered for 2 minutes and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).