# Cboe — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Retrieve delayed Cboe options chain data (including Greeks, pricing, volume, and open interest) for equities, indices, and VX futures, plus short sale circuit breaker (Rule 201) alerts by year.

**Category:** Finance & Markets | **Website:** [cboe.com/](https://cboe.com/) | **Docs:** [parse.bot/marketplace/413bf6ea-2e45-4930-8a88-4e26d45652e1/cboe-com-api](https://parse.bot/marketplace/413bf6ea-2e45-4930-8a88-4e26d45652e1/cboe-com-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/cboe/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get options chain

Retrieve detailed options chain data for equities, indices, and VX futures. Returns all option contracts with full Greeks, pricing, and volume data. Supports equity symbols (SPY, AAPL), index symbols (SPX, VIX, NDX - auto-prefixed with underscore), and caret-prefixed symbols (^SPX). Each option includes IV, Delta, Gamma, Theta, Vega, Rho, bid/ask, volume, and open interest. Paginates internally; the full chain is returned in one response.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `symbol` | string | Yes | Ticker symbol. Equities: SPY, AAPL, MSFT. Indices: SPX, VIX, NDX (auto-prefixed with underscore). Also accepts ^SPX format. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/cboe/get-options-chain \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"symbol":"<string>"}'
```

### Get short sale circuit breaker

Retrieve short sale circuit breaker (Rule 201) alerts published by CBOE. Returns all securities that triggered the short sale price test restriction for the specified year, including exchange, start/end times, and rescission status. Each alert includes the security symbol, name, exchange, timestamps, and whether the restriction was rescinded.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `year` | string | No | 4-digit year for circuit breaker data. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/cboe/get-short-sale-circuit-breaker \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"year":"<string>"}'
```

### Get vx futures options

Retrieve options on VX Futures with full option chain details. Only active or near-term VX futures contracts have options data available; expired contracts return a not-found error. VX futures use month codes: F=Jan, G=Feb, H=Mar, J=Apr, K=May, M=Jun, N=Jul, Q=Aug, U=Sep, V=Oct, X=Nov, Z=Dec. Symbol format: VX{month_code}{2-digit-year}. Each option includes full Greeks, pricing, and volume.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `futures_symbol` | string | Yes | VX futures symbol. Format: VX + month code + 2-digit year (e.g., VXK26 for May 2026). Only active/near-term contracts have options data. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/cboe/get-vx-futures-options \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"futures_symbol":"<string>"}'
```

## Next steps

- [All wrapped API providers](https://beta.paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://beta.paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://beta.paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://beta.paywithlocus.com/agent/index.md): every Locus agent page.