Guide

Getting started

The API exposes everything the platform's analytics tools use, and powers the MCP server so Claude can query it in natural language. From zero to your first response takes a few minutes.

Steps

API & 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.

Create an account at /register and subscribe — every plan starts with a 7-day free trial and includes the API.
Generate a token under Account → API Access — up to 3 active tokens; each secret is shown once and expires after 1 year by default (configurable at creation). Tokens look like avmcp_….
Call the API with your token (below), or connect the MCP server to Claude and ask in plain English. Pasting the token into your local config or a private setup chat is the intended, safe way to wire it up — if it's ever exposed publicly, one-click Rotate on the same page swaps it for a fresh secret.

Your first call

The Bearer-token surface lives under /api/mcp/data/*.

curl

curl -H "Authorization: Bearer avmcp_YOUR_TOKEN" \
     "https://apexvol.com/api/mcp/data/iv-rank/AAPL"

Full request/response details for every endpoint are in the endpoint reference. Auth options are covered in Authentication.

Connect to Claude

The apexvol-mcp server turns these endpoints into natural-language Claude tools — ask "What's the IV rank for SPY?" It installs from PyPI; see the step-by-step setup guide for a full walkthrough.

Install (pipx recommended): pipx install apexvol-mcp
Verify install + token before touching Claude config: APEXVOL_API_TOKEN=avmcp_… apexvol-mcp --check — prints version, auth result, and remaining quota.
Claude Code: claude mcp add apexvol -e APEXVOL_API_TOKEN=avmcp_… -- apexvol-mcp. Claude Desktop: add the config below and restart.

Config preview:

.mcp.json

{
  "mcpServers": {
    "apexvol": {
      "command": "apexvol-mcp",
      "env": { "APEXVOL_API_TOKEN": "avmcp_YOUR_TOKEN_HERE" }
    }
  }
}

Full MCP setup, the 43 Claude tools, and the data endpoints: MCP / Claude integration →

Troubleshooting

Symptom	Likely cause	Fix
`403 demo_restricted`	Anonymous/Free account requesting a non-AAPL ticker.	Log in with an active subscription, or test against AAPL.
`403 upgrade_required`	Your plan is below the endpoint's feature tier.	Upgrade (payload includes `required_tier`), or use an endpoint on your plan.
`403 tier_required`	Valid token but the account has no active subscription.	Any paid plan enables the API — subscribe at `/pricing`.
`403 upgrade_required` (token)	The endpoint's feature sits above your plan tier.	Payload names `required_tier` — upgrade, or use endpoints your plan includes.
`403 beta_required`	Token valid but API access isn't enabled on the account.	Every paid plan includes API access — subscribe at `/pricing`, or email support with questions.
`400 csrf_expired`	Stale CSRF token on a write request.	`GET /api/csrf-token` and retry with the new header.
404 on a documented endpoint	Unpublished feature, or the resource/ticker doesn't exist.	Verify the ticker / resource ID.
429 rate-limit	Demo (30/min), shared (100/min), or MCP token (60/min) limits.	Back off and batch; authenticate to leave demo limits.
`"Invalid or missing API token"`	`APEXVOL_API_TOKEN` unset, malformed, revoked, or expired.	Re-check the env var + token status; restart Claude after config changes. If the token was revoked, generate a fresh one under Account → API Access and update the env var.
SPX/index price looks ~20–30 pts high	Index chain price is the parity-implied forward, not spot.	Use the nearest expiration's value as your spot/ATM proxy; don't compare directly to a live index quote.

Support: support@apexvol.com.

← Overview Authentication →