Skip to main content

the edgeful API — overview + walkthrough

overview of the edgeful API — what it is, who it's for, where to start, and links to the developer docs

Written by Brad

the edgeful API

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 a single endpoint, pass a ticker and a date range, and get back the exact numbers you'd see in the report page.

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, and longer historical lookbacks. the full tier breakdown is below.

who it's for

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:

  • you want to drop edgeful data straight into Claude, ChatGPT, or any other AI for analysis

  • you're building a custom dashboard, scanner, or daily prep tool

  • you want to send yourself a daily or weekly digest with specific report stats

  • you're running automations that need market stats as input

  • you're a quant or developer who'd rather work with JSON than click through a UI

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.

a quick taste

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

the API is currently on v1. there's no version prefix in the URL — v1 endpoints live at the root. any breaking change will land as a new version and we'll announce it ahead of time.

what each plan includes for the API

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: 30 requests / 60s sustained + 5 requests / 5s burst on every tier.

feature

essentials ($49/mo)

pro ($99/mo)

all-access ($299/mo)

reports

3 select reports

all reports

all reports

tickers

RTY, AAPL, ETH/USDT, GBP/CAD

all tickers

all tickers

historical lookback

6 months

1 year

8 years

what's in play (live)

not included

included

included

screener (live)

not included

included

included

data depth

summary only

summary only

per-day / row-level detail

essentials ($49/mo)

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.

  • 3 reports — Opening Stats, Green & Red Days by Weekday, Previous Day's Range

  • 4 test tickers — RTY (futures), AAPL (stock), ETH/USDT (crypto), GBP/CAD (forex) — one from each market type so you can test every shape of request

  • 6 months of historical lookback

  • summary data only — the per-day detailed field is omitted from responses

  • no live data — what's in play and the screener aren't exposed

pro ($99/mo)

the tier most people end up on if they're using the API in production. opens up the full reports catalog and every ticker.

  • all reports — the full catalog

  • all tickers — futures (ES, NQ, GC, etc.), stocks (SPY, QQQ, AAPL, etc.), forex (EURUSD, GBPJPY, etc.), crypto (BTCUSD, ETHUSD, etc.)

  • 1 year of historical lookback

  • live data — what's in play and screener endpoints both exposed

  • summary data only — same response shape as essentials, broader catalog and longer lookback

all-access (algos plan, $299/mo)

everything in pro, plus the historical depth and per-day detail for precise backtests and event-driven analyses.

  • everything in pro, plus:

  • 8 years of historical lookback (soon to be 9)

  • per-day / row-level detail — the detailed field is populated on the response, so you can drill into the underlying days (e.g., every day SPY gapped down >0.5% and didn't fill)

  • the algo suite — algo dashboard + TradingView indicator suite bundled in

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.

where to start

your keys live in the API dashboard — generate one there, then work through these 6 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.

the full developer docs

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.

related articles

Did this answer your question?