# 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

| Name | Type | Required | Default | What it is | Constraints |
| --- | --- | --- | --- | --- | --- |
| `symbol` | string | yes | (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

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

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/finance/options",
    params={"symbol": "AAPL"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ symbol: "AAPL" });
const res = await fetch(`https://api.onekey.dev/v1/finance/options?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## 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](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `option` | `market.symbol` | - |
| `bid` | `market.bid` | `toNumber` |
| `ask` | `market.ask` | `toNumber` |
| `last_trade_price` | `market.price` | `toNumber` |
| `open` | `market.open` | `toNumber` |
| `high` | `market.high` | `toNumber` |
| `low` | `market.low` | `toNumber` |
| `volume` | `market.volume` | `toNumber` |
| `open_interest` | `market.openInterest` | `toNumber` |
| `last_trade_time` | `ext.lastTradeTime` | `toIsoDate` |
| `iv` | `ext.impliedVolatility` | `toNumber` |
| `delta` | `ext.delta` | `toNumber` |
| `gamma` | `ext.gamma` | `toNumber` |
| `theta` | `ext.theta` | `toNumber` |
| `vega` | `ext.vega` | `toNumber` |
| `rho` | `ext.rho` | `toNumber` |
| `theo` | `ext.theoreticalPrice` | `toNumber` |

## 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

| Status | Code | What to do |
| --- | --- | --- |
| 401 | `unauthorized` | Check the `x-api-key` header. |
| 402 | `insufficient_credits` | [Add credits](https://onekey.dev/pricing); your balance must cover the price. |
| 404 | `not_found` | Unknown endpoint path. |
| 422 | `invalid_params` | Fix the parameters using the table above. Free. |
| 429 | `rate_limited` | Wait `Retry-After` seconds, then retry. |
| 502 | `upstream_error` | The source failed. Refunded; retry with backoff. |

See [Errors](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).