- API
- Flow API
Flow API
Options flow,
as numbers.
The contracts carrying the most premium today, the ones trading far above their open interest, the call and put totals behind the sentiment label. Per ticker, live during the session.
A real response
This is what
comes back.
Captured from the live endpoint on 2026-09-07, lists cut to a few rows so it fits on a page. The shape is exactly what your code receives.
{
"data_freshness": "LIVE",
"is_market_hours": true,
"largest_flows": [
{
"ask": 2.84,
"bid": 2.8,
"delta": 0.4141,
"dte": 4,
"expiration": "2026-09-11",
"is_unusual": false,
"mid": 2.82,
"moneyness": "OTM",
"oi": 25020,
"premium": 13525566.0,
"strike": 232.5,
"ticker": "NVDA",
"timestamp": "2026-09-07T16:53:31.572572",
"type": "CALL",
"volume": 47963,
"volume_oi_ratio": 1.917
},
{
"ask": 2.29,
"bid": 2.23,
"delta": 0.2663,
"dte": 11,
"expiration": "2026-09-18",
"is_unusual": false,
"mid": 2.26,
"moneyness": "OTM",
"oi": 76042,
"premium": 12802674.0,
"strike": 240.0,
"ticker": "NVDA",
"timestamp": "2026-09-07T16:53:31.623444",
"type": "CALL",
"volume": 56649,
"volume_oi_ratio": 0.745
}
],
"message": "Showing live market data.",
"stock_price": 230.3,
"success": true,
"summary": {
"call_put_ratio": 1.9931,
"net_premium": 170872165.5,
"put_call_ratio": 0.5017,
"sentiment": "BULLISH",
"total_call_premium": 313658742.5,
"total_call_volume": 1166098.0,
"total_flow_count": 321,
"total_put_premium": 142786577.0,
"total_put_volume": 585059.0
},
"ticker": "NVDA",
"timestamp": "2026-09-07T16:53:31.710135",
"top_expirations": [
[
"2026-09-18",
{
"premium": 100034602.0,
"volume": 283452
}
],
[
"2026-09-11",
{
"premium": 98571641.0,
"volume": 539458
}
],
[
"2026-10-16",
{
"premium": 87886168.0,
"volume": 170080
}
]
],
"top_strikes": [
[
230.0,
{
"calls": 100586,
"premium": 90223116.0,
"puts": 87333,
"volume": 187919
}
],
[
235.0,
{
"calls": 194007,
"premium": 75171403.0,
"puts": 30184,
"volume": 224191
}
],
[
232.5,
{
"calls": 101063,
"premium": 42516519.0,
"puts": 37409,
"volume": 138472
}
]
],
"unusual_activity": [
{
"ask": 4.0,
"bid": 3.9,
"delta": -0.6144,
"dte": 2,
"expiration": "2026-09-09",
"is_unusual": true,
"mid": 3.95,
"moneyness": "ITM",
"oi": 226,
"premium": 9502515.0,
"strike": 232.5,
"ticker": "NVDA",
"timestamp": "2026-09-07T16:53:31.553273",
"type": "PUT",
"volume": 24057,
"volume_oi_ratio": 106.4469
},
{
"ask": 1.08,
"bid": 1.05,
"delta": 0.2609,
"dte": 2,
"expiration": "2026-09-09",
"is_unusual": true,
"mid": 1.065,
"moneyness": "OTM",
"oi": 9213,
"premium": 9413748.0,
"strike": 235.0,
"ticker": "NVDA",
"timestamp": "2026-09-07T16:53:31.553356",
"type": "CALL",
"volume": 88392,
"volume_oi_ratio": 9.5943
}
],
"window": {
"detail": "full"
}
}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/flow/NVDA"import requests
r = requests.get("https://apexvol.com/api/mcp/data/flow/NVDA",
headers={"Authorization": "Bearer avmcp_YOUR_TOKEN"})
d = r.json()["data"]
print(d["summary"]["sentiment"], d["summary"]["net_premium"])
for f in d["largest_flows"][:5]:
print(f["type"], f["strike"], f["expiration"], f["premium"], f["volume_oi_ratio"])
What is the largest options flow in NVDA today, and does it read bullish or bearish?
The assistant calls get_options_flow 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.
Field by field
What each
number means.
summary.call_put_ratio, put_call_ratio- Volume-weighted ratios for the session.
summary.total_call_premium, total_put_premium, net_premium- Dollars traded on each side and the difference.
summary.sentiment- BULLISH, BEARISH or NEUTRAL from the premium balance, so a caller can branch.
largest_flows[]- Per contract: strike, expiration, type, volume, open interest, volume_oi_ratio, premium, delta, moneyness and is_unusual.
unusual_activity[]- The contracts where today's volume is a multiple of open interest, the classic unusual-activity screen.
top_strikes, top_expirations- Where the premium is concentrating.
data_freshness, is_market_hours- LIVE with the session open; otherwise the last session, and the response says which.
The family
5 endpoints,
one prefix.
All under https://apexvol.com/api/mcp/data. Parameters are bounded and the docs say the bounds; out-of-range values are clamped or rejected, never silently changed. The reference has every response field.
| Method | Path | Parameters | Returns |
|---|---|---|---|
GET | /flow/{ticker} | detail compact or full | Summary totals, the largest flows by premium, unusual activity by volume against OI, top strikes and expirations. |
GET | /smart-money/{ticker} | none | The subset that looks institutional: size, moneyness and timing filters applied. |
GET | /volume-profile/{ticker} | expiration | Call and put volume by strike for one expiration. |
GET | /screen | screen_type unusual_volume and others, limit | The universe ranked by a flow preset in one request, from bulk data. |
GET | /vol-arb-scan | ticker | Where implied and forecast vol disagree by strike, the flow that is mispriced rather than merely large. |
The same data, in plain English
5 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.
- get_options_flow
- get_smart_money_flow
- scan_volatility_arb
- screen_market
- get_volume_profile
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, with a 10,000-request monthly budget per account. Every response carries the remaining counts in headers.
- Plans
- Included with every paid plan from $55 a month. Each endpoint follows the tier of its web feature; Pro unlocks the full surface.
- Spec
- OpenAPI 3.1 at /docs/api/openapi.json and the whole reference as one Markdown file at /docs/api/apexvol-api.md.
Questions
Asked before
the first call.
Is the flow real-time?
Live during US market hours from the same options feed the terminal uses, with a timestamp on every response. Outside the session the last day's flow is returned and data_freshness says so.
What counts as unusual?
Volume against open interest. A contract trading several times its carried-in open interest is new positioning rather than churn, and those rows are flagged is_unusual and listed under unusual_activity. Premium size is reported separately so the two can be combined.
Is this tick-level order flow?
No. The endpoint aggregates the session's volume and premium per contract, which is what the unusual-activity and sentiment reads need. It does not label individual prints as sweeps or blocks.
Can I scan the whole market?
Yes. /screen with a flow preset ranks the coverage universe from bulk data in one or two upstream calls, so a market-wide unusual-volume list costs one request against your budget.
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.