- API
- Account API
Account API
Your meter and the map,
one call each.
How much of the month's allowance this account has spent, what is left and when it resets, from any of your tokens. And the whole endpoint list with paths, plans, parameters and a working example for each, so a client can discover the API without reading a page.
A real response
This is what
comes back.
Captured from the live endpoint on 2026-09-08, lists cut to a few rows so it fits on a page. The shape is exactly what your code receives. Run it on your own ticker from the endpoint page.
{
"calls_this_month": 0,
"docs": "https://apexvol.com/docs/api/guides/rate-limits",
"endpoints": [],
"limit": 10000,
"month": "2026-09",
"percent_used": 0.2,
"plan": "pro",
"rate_limits": {
"per_hour": 1000,
"per_minute": 60,
"remaining_hour": 1000,
"remaining_minute": 60
},
"remaining": 9981,
"resets_at": "2026-10-01T00:00:00+00:00",
"this_token": {
"label": "local capture 2026-09-08",
"token_id": "CAP4F1221",
"unknown_paths_7d": {}
},
"tokens_active": 1,
"unit": "data_requests",
"used": 19
}Every response is wrapped as {"success": true, "data": {...}}. Errors use the same envelope with an error string and a status code that means what it says.
Call it three ways. Same token, same JSON.
curl -H "Authorization: Bearer avmcp_YOUR_TOKEN" \
"https://apexvol.com/api/mcp/data/me/usage"import requests
headers = {"Authorization": "Bearer avmcp_YOUR_TOKEN"}
r = requests.get("https://apexvol.com/api/mcp/data/me/usage", headers=headers)
r.raise_for_status()
data = r.json()["data"]
print(data["used"])How much of my ApexVol API allowance is left this month?
The assistant calls and answers from the JSON above.More prompts for this family in the prompt library. Set the server up in Claude Desktop, Claude Code, Cursor, ChatGPT, VS Code, Windsurf or Gemini CLI.
The family
2 endpoints,
one prefix.
All under https://apexvol.com/api/mcp/data. Each card opens a page with the parameters and their bounds, every response field, a real captured response and a console that runs it on your ticker.
GET /
Which endpoints does the ApexVol API expose, and what does each one need?
Every endpoint with its method, path, plan, parameters, docs page and an example request.
Basic
GET /me/usage
How much of my monthly API allowance is left, and which endpoints have I been calling?
Your own meter: month used, allowance, remaining, reset time and calls by endpoint.
Basic
Field by field
What each
number means.
used, limit, remaining, percent_used- The month's data requests spent against the plan's allowance, in the unit the cap is enforced in.
resets_at- ISO 8601 UTC timestamp of the first of next month, when the counter returns to zero.
rate_limits- The per-minute and per-hour ceilings for this token and what is left of each right now.
endpoints[]- Calls per endpoint this month, each with its docs page, so a client can see where its budget goes.
this_token.unknown_paths_7d- Paths under /api/mcp/data this token requested that do not exist, with counts: an integration that is guessing shows up here first.
endpoint_count, families[], endpoints[]- On the index: every endpoint with method, path, family, plan, parameters, docs URL and an example request that works as written.
The same data, in plain English
0 MCP tools
wrap this family.
Connect the ApexVol MCP server and an assistant can call these by name. One URL, a sign-in, no token to paste.
Set it up in:
What people build
Three things
this is for.
Access
- Auth
- Bearer token, prefix
avmcp_, created under Account, then API Access. Shown once, hashed at rest, rotates in one click. - Limits
- 60 requests a minute and 1,000 an hour per token, plus a monthly allowance by plan. Every response carries the remaining counts in headers.
- Plans
- Included with every paid or trial plan from $55 a month. Each endpoint follows the tier of its web feature; the cards above show which.
- Spec
- OpenAPI 3.1 at /docs/api/openapi.json, this family as one Markdown file, the whole reference at /llms-full.txt. Shared conventions, the error model and the changelog.
Questions
Asked before
the first call.
Do these calls cost anything?
No. Neither endpoint touches the market-data feed, so they spend nothing from the monthly allowance. They do count against the per-minute and per-hour rate limits like any other call.
Which plan do I need?
Any paid or trial plan. Both endpoints are available to every token that can call the API at all; the usage figures are for the account the token belongs to.
Why does used count data requests rather than API calls?
Because that is what the allowance is enforced in. One call can fetch several expirations upstream and spend several units, and a call answered from cache spends none. The usage endpoint reports the same number the limit checks.
Does the index list endpoints my plan cannot use?
Yes. It lists the whole token surface with the plan each endpoint needs, so a client can tell in advance which calls would return 403.
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.
Real market data, not a sandbox. See it live on AAPL.