API reference

Stock Options Chain API

The nearest expiry's options chain for one instrument: calls and puts with strike, last, bid, ask, volume, open interest and implied volatility, plus the other expiries.

Read as Markdown Use with an AI agent

Endpoint

GET/v1/finance/optionslive · proven2 credits

Try in Playground

Parameters

Query parameters

Name	Required	Description	Example
`symbol`	yes	Ticker symbol	`AAPL`
`dry_run`	no	Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution.	`1`

Examples

Make the request

curl

curl "https://www.monocrawl.com/v1/finance/options?symbol=AAPL" \
  -H "x-api-key: mn_your_key_here"

TypeScript

typescript

const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
  "https://www.monocrawl.com/v1/finance/options?symbol=AAPL",
  { headers: { "x-api-key": key } },
);
const body = await res.json();

if (!body.success) {
  // one error shape for every endpoint — see /docs/errors
  throw new Error(`${body.error.type}: ${body.error.message}`);
}

console.log(body.data, "credits left:", body.credits_remaining);

Python

python

import os
import requests

res = requests.get(
    "https://www.monocrawl.com/v1/finance/options?symbol=AAPL",
    headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
    timeout=60,
)
body = res.json()

if not body["success"]:
    # one error shape for every endpoint — see /docs/errors
    raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")

print(body["data"], "credits left:", body["credits_remaining"])

Response

Response fields and example

This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.

200 · application/json

{
  "success": true,
  "platform": "finance",
  "endpoint": "/v1/finance/options",
  "data": {
    "calls": [
      {
        "ask": 0,
        "bid": 0,
        "change": 0,
        "change_percent": 0,
        "implied_volatility": 0,
        "in_the_money": false,
        "last": 0,
        "open_interest": 0,
        "strike": 0,
        "symbol": "example",
        "volume": 0
      }
    ],
    "expiries": [
      "example"
    ],
    "expiry": "example",
    "has_mini_options": false,
    "puts": [
      {
        "ask": 0,
        "bid": 0,
        "change": 0,
        "change_percent": 0,
        "implied_volatility": 0,
        "in_the_money": false,
        "last": 0,
        "open_interest": 0,
        "strike": 0,
        "symbol": "example",
        "volume": 0
      }
    ],
    "quote": {
      "as_of": "example",
      "change": 0,
      "change_percent": 0,
      "currency": "example",
      "day_high": 0,
      "day_low": 0,
      "exchange": "example",
      "fifty_two_week_high": 0,
      "fifty_two_week_low": 0,
      "market_cap": 0,
      "market_state": "example",
      "name": "example",
      "open": 0,
      "previous_close": 0,
      "price": 0,
      "shares_outstanding": 0,
      "symbol": "example",
      "type": "example",
      "volume": 0
    },
    "strikes": [
      0
    ],
    "symbol": "example"
  },
  "credits_used": 2,
  "credits_remaining": 99,
  "request_id": "req_…",
  "cached": false
}

The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.

Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.

Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.

Field inside data	Type	Meaning
`calls`	`array \| null`	Optional calls supplied by this operation. Null means unknown.
`calls[].ask`	`number \| null`	Optional ask supplied by this operation. Null means unknown.
`calls[].bid`	`number \| null`	Optional bid supplied by this operation. Null means unknown.
`calls[].change`	`number \| null`	Optional change supplied by this operation. Null means unknown.
`calls[].change_percent`	`number \| null`	Optional change percent supplied by this operation. Null means unknown.
`calls[].implied_volatility`	`number \| null`	Optional implied volatility supplied by this operation. Null means unknown.
`calls[].in_the_money`	`boolean \| null`	Optional in the money supplied by this operation. Null means unknown.
`calls[].last`	`number \| null`	Optional last supplied by this operation. Null means unknown.
`calls[].open_interest`	`number \| null`	Optional open interest supplied by this operation. Null means unknown.
`calls[].strike`	`number \| null`	Optional strike supplied by this operation. Null means unknown.
`calls[].symbol`	`string \| null`	Optional symbol supplied by this operation. Null means unknown.
`calls[].volume`	`number \| null`	Optional volume supplied by this operation. Null means unknown.
`expiries`	`array \| null`	Optional expiries supplied by this operation. Null means unknown.
`expiry`	`string \| null`	Optional expiry supplied by this operation. Null means unknown.
`has_mini_options`	`boolean \| null`	Optional has mini options supplied by this operation. Null means unknown.
`puts`	`array \| null`	Optional puts supplied by this operation. Null means unknown.
`puts[].ask`	`number \| null`	Optional ask supplied by this operation. Null means unknown.
`puts[].bid`	`number \| null`	Optional bid supplied by this operation. Null means unknown.
`puts[].change`	`number \| null`	Optional change supplied by this operation. Null means unknown.
`puts[].change_percent`	`number \| null`	Optional change percent supplied by this operation. Null means unknown.
`puts[].implied_volatility`	`number \| null`	Optional implied volatility supplied by this operation. Null means unknown.
`puts[].in_the_money`	`boolean \| null`	Optional in the money supplied by this operation. Null means unknown.
`puts[].last`	`number \| null`	Optional last supplied by this operation. Null means unknown.
`puts[].open_interest`	`number \| null`	Optional open interest supplied by this operation. Null means unknown.
`puts[].strike`	`number \| null`	Optional strike supplied by this operation. Null means unknown.
`puts[].symbol`	`string \| null`	Optional symbol supplied by this operation. Null means unknown.
`puts[].volume`	`number \| null`	Optional volume supplied by this operation. Null means unknown.
`quote`	`object \| null`	Optional quote supplied by this operation. Null means unknown.
`quote.as_of`	`string \| null`	Optional as of supplied by this operation. Null means unknown.
`quote.change`	`number \| null`	Optional change supplied by this operation. Null means unknown.
`quote.change_percent`	`number \| null`	Optional change percent supplied by this operation. Null means unknown.
`quote.currency`	`string \| null`	Optional currency supplied by this operation. Null means unknown.
`quote.day_high`	`number \| null`	Optional day high supplied by this operation. Null means unknown.
`quote.day_low`	`number \| null`	Optional day low supplied by this operation. Null means unknown.
`quote.exchange`	`string \| null`	Optional exchange supplied by this operation. Null means unknown.
`quote.fifty_two_week_high`	`number \| null`	Optional fifty two week high supplied by this operation. Null means unknown.
`quote.fifty_two_week_low`	`number \| null`	Optional fifty two week low supplied by this operation. Null means unknown.
`quote.market_cap`	`number \| null`	Optional market cap supplied by this operation. Null means unknown.
`quote.market_state`	`string \| null`	Optional market state supplied by this operation. Null means unknown.
`quote.name`	`string \| null`	Optional name supplied by this operation. Null means unknown.
`quote.open`	`number \| null`	Optional open supplied by this operation. Null means unknown.
`quote.previous_close`	`number \| null`	Optional previous close supplied by this operation. Null means unknown.
`quote.price`	`number \| null`	Source price. Currency, taxes and availability depend on the listing.
`quote.shares_outstanding`	`number \| null`	Optional shares outstanding supplied by this operation. Null means unknown.
`quote.symbol`	`string \| null`	Optional symbol supplied by this operation. Null means unknown.
`quote.type`	`string \| null`	Optional type supplied by this operation. Null means unknown.
`quote.volume`	`number \| null`	Optional volume supplied by this operation. Null means unknown.
`strikes`	`array \| null`	Optional strikes supplied by this operation. Null means unknown.
`symbol`	`string \| null`	Optional symbol supplied by this operation. Null means unknown.

Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.

The example is invented and illustrates types only; zero and empty values are not claims about a real result.

Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference

Stock Options Chain API

Query parameters

Make the request

Response fields and example

More Markets reference

First call in under a minute