Developer Documentation

ApexVol API

One surface under /api exposing the platform's options analytics — implied volatility, Greeks & dealer positioning, flow, screeners, strategy simulation, and risk. The same API powers the MCP server, so Claude can query everything in natural language.

Ways to consume it

ConsumerAuthBest for
Claude (AI assistant)MCP token Natural-language analytics via the apexvol-mcp server — no HTTP coding.
Scripts / integrationsBearer token Programmatic access to /api/mcp/data/* with a long-lived token.
Browser / web appSession cookie + CSRF The platform UI; quick experiments from a logged-in browser.

Service notes

18 July 2026 — Options flow endpoints (GET /flow, GET /smart-money) are temporarily unavailable: the upstream options feed is not reporting reliable intraday volume, so these return HTTP 503 with an explanation rather than misleading zeros. All other analytics are unaffected. Flow resumes automatically when the feed recovers.

Getting started

API & MCP access is included with every paid plan — 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. Generate an API token under Account → API Access (up to 3 active; the secret is shown once). Tokens look like avmcp_….
  3. Call the API with your token, or connect the MCP server to Claude and just ask. Pasting the token into your local config or a private setup chat is the intended, safe way to wire it up — only rotate it if it's exposed somewhere public.
First call (Bearer)
curl -H "Authorization: Bearer avmcp_YOUR_TOKEN" \
     "https://apexvol.com/api/mcp/data/iv-rank/AAPL"

Full getting-started guide →

Guides

Authentication

Three access classes; each endpoint below is labeled with one.

  • Bearer token — send Authorization: Bearer avmcp_<token> to /api/mcp/data/*. Tokens are hashed server-side and checked for status/expiry.
  • Session cookie + CSRF — log in, then write requests carry an X-CSRFToken header from GET /api/csrf-token.
  • Public — a small set needs no auth (subject to demo-mode limits).

Endpoint reference

MCP / Claude integration

The Bearer-token data surface and the Claude tools — the primary programmatic path.

Options Chain & Price History

The core market-data endpoints behind the dashboard: live chains with Greeks, lazy-loaded expirations, the volatility table, historical OHLC, HV series, return distributions, and Pro-tier historical chain snapshots (chain state at any past date/time, back-to-back comparisons, and intraday timelines).

Volatility Analytics

The deepest part of the API: IV rank and cones, vol surfaces and smiles, term structure, volatility risk premium, HV regimes, IV mispricing, skew analytics, and day-over-day IV shift. Most endpoints require Premium (volatility_lab / iv_dashboard) or Pro (vol_term_analytics, iv_shift, skew_intelligence, volatility_arbitrage).

Greeks & Dealer Positioning

Greeks heatmaps and statistics (Basic), the unified Greeks-exposure endpoint that powers GEX/DEX/charm/vanna views (Premium), and the legacy GEX module (currently hidden).

Options Flow & 0DTE

Flow analytics (Premium) and zero-days-to-expiration analytics (Pro, with two public helper endpoints).

Screeners & Market Overview

Market-wide endpoints: the bulk our institutional data feed-powered screener, quick public screeners, the market overview, and the (temporarily disabled) legacy screener and vol-surface-monitor routes.

Events & Earnings

Earnings and event analytics: IV run-up patterns, historical earnings moves, expected-vs-actual comparisons, post-earnings drift, the earnings-straddle analyzer, and the (currently hidden) expected-move module.

Stock Analytics

Per-ticker equity analytics that complement the options tools: price context, dividends, correlation/beta, borrow rates, and cross-sectional relative value.

Strategy Building, Simulation & Spreads

The Strategy Lab back end: Black-Scholes chain re-pricing, probability of profit, template strategy building and optimization (Basic via the simulator key), plus the Pro-tier calendar-spread analyzers and the coming-soon iron-condor scanner.

Portfolio Risk Management

Portfolio-level Greeks, scenario analysis, stress testing, and hedge simulation. All endpoints require login and the Pro plan (feature key risk_manager) and are rate-limited at 100/min.

7 days free, cancel anytime Card required · no charge for 7 days
Start trial →