1. API
  2. Getting started

Guide

Getting
started.

The API exposes everything the platform's analytics use, and powers the MCP server so an assistant can query it in plain English. From zero to a first response takes a few minutes.

Steps

API and MCP access is included with every paid plan (see pricing). Each endpoint follows the same tier as the web app, so your token queries the data your plan includes and Pro unlocks the full surface.

  1. Create an account at /register and subscribe. Every plan starts with a 7-day free trial and includes the API.
  2. Just want it in an assistant? In Claude, open ApexVol in the connector directory and select Connect to Claude; in other assistants, add https://apexvol.com/mcp-server as a custom connector. Approve, done. See Connect to Claude below. No token needed for this route.
  3. Writing your own code? Generate a token under Account, then API Access: up to 3 active tokens, each secret shown once, one-year expiry by default. Tokens look like avmcp_…. Pasting the token into your local config or a private setup chat is the intended, safe way to wire it up; if it is ever exposed publicly, Rotate on the same page swaps it for a fresh secret.

Your first call

The token surface lives under /api/mcp/data/*. Always call the apex host, never www.: the redirect drops the Authorization header.

curlThe 30-delta call on AAPL
curl -H "Authorization: Bearer avmcp_YOUR_TOKEN" \
     "https://apexvol.com/api/mcp/data/options-by-delta/AAPL?delta=0.30"

Every endpoint has its own page with parameters, fields and a real response: start from the family list. Auth options are covered in Authentication.

Connect to Claude

The MCP server turns these endpoints into tools an assistant calls by name: ask "Find the 30-delta put on SPY for next month" and it calls get_options_by_delta, which works on every plan. The quickest route is the hosted connector: no install, no token. The step-by-step setup guide has the long version.

  1. Open ApexVol in Claude's connector directory and select Connect to Claude. (To add it by hand instead, open Customize, then Connectors, choose Add custom connector and paste https://apexvol.com/mcp-server, apex form, not www..)
  2. Sign in to ApexVol when Claude redirects you, then Approve read-only access. Approving creates a token labelled Claude connector on your account; revoke it under Account, then API Access to disconnect.

Prefer to run the server locally, in Claude Desktop, Claude Code, Cursor or another MCP client? Install the apexvol-mcp client from PyPI:

  1. Install (pipx recommended): pipx install apexvol-mcp
  2. Verify install and token before touching any config: APEXVOL_API_TOKEN=avmcp_… apexvol-mcp --check prints the version, the auth result and the remaining quota.
  3. Claude Code: claude mcp add apexvol -e APEXVOL_API_TOKEN=avmcp_… -- apexvol-mcp. Claude Desktop: add the config below and restart.
.mcp.jsonlocal client
{
  "mcpServers": {
    "apexvol": {
      "command": "apexvol-mcp",
      "env": { "APEXVOL_API_TOKEN": "avmcp_YOUR_TOKEN_HERE" }
    }
  }
}

Per-client install pages: Claude Desktop, Claude Code, Cursor, ChatGPT, VS Code, Windsurf, Gemini CLI. What the 44 Claude tools cover, and the data endpoints behind them: the MCP server page.

Troubleshooting

SymptomLikely causeFix
401 Invalid or revoked tokenAPEXVOL_API_TOKEN unset, malformed, revoked or expired.Re-check the env var and the token status; restart the client after config changes. If the token was revoked, generate a fresh one under Account, then API Access.
403 upgrade_requiredThe endpoint's feature sits above your plan tier.The payload names required_tier. Upgrade, or use the endpoints your plan includes; each endpoint page states its tier.
403 tier_requiredValid token but the account has no active paid or trial subscription.Any paid plan enables the API: subscribe at /pricing.
403 beta_requiredToken valid but API access is not enabled on the account.Every paid plan includes API access; subscribe at /pricing, or email support with questions.
404 on a documented pathA typo in the path, or the ticker is not covered.The body lists did_you_mean with the nearest real paths and their docs. Check coverage with /search.
424 with upstream: trueThe data feed did not answer for this ticker or window.Retry after a few seconds; this is never a client bug.
429 rate limitOver 60 a minute or 1,000 an hour on the token, or the monthly allowance.Wait Retry-After seconds and batch; the X-RateLimit-* headers on every response show the remaining budget.
SPX or index price looks 20 to 30 points highThe index chain price is the parity-implied forward for that expiration, not spot.Use the nearest expiration's value as the spot proxy; do not compare it to a live index quote.

Support: [email protected]. Full status list with payload shapes: errors.

Back to the hub Authentication

Next

The other guides,
and the reference.

Getting startedGet started with the ApexVol API: create an account, generate a token, make your first call, and connect the MCP server to Claude. Authentication & securityApexVol API authentication: Bearer-token (MCP) and session-cookie + CSRF access, token lifecycle, and 401/403 semantics. Plans, tiers & access controlHow ApexVol API access maps to plans: Free/Basic/Premium/Pro tiers, demo mode, and the feature-key access model. Rate limits & quotasApexVol API rate limits: demo, shared per-IP, and per-token MCP quotas, and what happens when you exceed them. Errors & response conventionsApexVol API request/response conventions, HTTP status codes, and error payload shapes.

Included with
every paid plan.

From $55 a month, tier-matched: your token queries the data your plan includes and Pro unlocks the full surface.

Start free trial Create a free account

Real market data, not a sandbox. See it live on AAPL.