summary: what the edgeful API is, who it's for, and where to find what you need. start here, then drill into the article that covers your question.

the edgeful API gives you the same data behind every report on the platform, programmatically. instead of pulling stats out of the UI one report at a time, you can hit an endpoint, pass a ticker and a date range, and get back the exact numbers you'd see in the report page. one thing to know up front: the individual views on a report page are each their own endpoint — see one report, many endpoints below.

every edgeful plan includes API access. essentials gets you a starter setup so you can try it. pro and all-access unlock the full reports catalog, every ticker, all available history, and per-day detail. the full tier breakdown is below.

the API isn't a feature most members will need — the report pages, screener, WIP dashboard, and edgeful AI are still the fastest ways to get the data into your trading. but if you fit one of these, it's worth a look:

if you've never written code before, you can still use the API. the no-code walkthrough with VS Code + Claude Code gets you pulling data in about 10 minutes without writing a single line of code.

and if you just want to ask questions rather than build something, you can skip the setup entirely — the MCP connector puts edgeful's reports directly inside a Claude chat, with no key and no project folder. see connecting edgeful to Claude, ChatGPT, and Grok with MCP.

using ChatGPT instead of Claude? if you only want to ask questions, ChatGPT itself can take the edgeful MCP connector through developer mode on a paid plan — no key, no Codex — see connecting edgeful to Claude, ChatGPT, and Grok with MCP. to actually use the API, you'll need OpenAI's Codex app. the regular ChatGPT app and chatgpt.com can't read the docs, create files, or run requests on your machine. download Codex at developers.openai.com/codex/app, and it works the same way Claude Code does.

a minimal call sends a GET request to the report endpoint with a ticker, market type, and date range. the base URL, auth header format, key format, and rotation are all in the authentication docs. for a working example with curl, Python, and JavaScript, see the quickstart.

the API is currently on v1. any breaking change will land as a new version, and we'll announce it ahead of time.

most reports aren't a single endpoint. the views you switch between on a report page each have their own slug, and each returns a different cut of the same underlying days.

the shape is <report>-<variant>. take the initial balance breakout report: initial-balance-breakout-standard returns the headline single / double / no break counts, while initial-balance-breakout-by-breakout splits the single-break days by which side broke, and initial-balance-breakout-by-double-break reports which side broke first. there are more for close, size, weekday, rejection, and the rest of the views on the page.

-standard is the headline cut, not the whole report. this matters because calling the wrong variant isn't an error. you get a clean 200 and a perfectly valid response — it just answers a different question than the one you asked. if the response shape looks right but the categories aren't the ones you wanted, you're usually on -standard when you want one of the variants.

two places to look up what exists for a given report:

reports are most of the API, but not all of it. a few other things live in the docs:

all of it is listed in the docs index at edgeful.com/docs/llms.txt.

every edgeful plan includes API access at no extra cost. the tier you have is determined by the plan you're already on. what changes between tiers is which reports, tickers, lookback, and live data are exposed. rate limits are uniform: 120 requests / 60s sustained, 30 requests / 10s burst, and 1,500 requests / hour on every tier.

try-before-you-upgrade. enough to confirm the API works, integrate it with Claude or ChatGPT, and prototype against it. not enough for long-term backtesting or production use on real tickers.

the tier most people end up on if they're using the API in production. opens up the full reports catalog and every ticker. pro isn't listed on the public pricing page, but you can switch to it yourself in the app: manage account → membership → view all plans.

the same API access as pro — the difference is the automation suite, not the data.

full breakdown of what each tier unlocks, plus rate-limit details, lives in rate limits and tier differences. for the upgrade path, see billing and upgrading between API tiers.

the API dashboard walks you through setup: pick chat apps (MCP) or coding agents (API), then your tool (Claude, ChatGPT, Grok, Claude Code, Codex, or Cursor), and each one has its own short setup video. it also holds your key, tutorial videos, and a daily usage heatmap that tracks your calls. it’s the fastest way to generate a key and get connected.

your keys live in the API dashboard — generate one there, then work through these focused articles that cover everything you need to use the API:

don't write code? start with the VS Code + Claude Code walkthrough. comfortable with code? start with getting your first API key, then read rate limits + tier differences so you know what your tier unlocks. either way, keep errors + troubleshooting open as a reference.

for the complete endpoint catalog, parameters, and response shapes, the developer docs are the source of truth:

the developer docs cover every report endpoint with example parameters, response shapes, and a "try it" panel where you can fire test requests from the browser.

the quick questions have their own article: whether you need a Claude or ChatGPT subscription, how much lookback each plan gets, whether the API costs extra, the rate limits, which endpoints you can call, and how to get your first key. they are all answered in the edgeful API — FAQ.