Authentication
One key, three ways in: REST header, RapidAPI proxy, or MCP bearer token.
API keys
Keys look like edgr_.... Create and revoke them in your dashboard.
Send your key on every request in the X-API-Key header:
curl https://api.edgrapi.com/v1/company/AAPL -H "X-API-Key: edgr_..."Treat keys like passwords. If one leaks, revoke it in the dashboard and create a new one; revocation takes effect immediately.
The key goes in a header, never in the URL. Edgrapi does not accept the key as a
?api_key= query parameter, because secrets in URLs leak into server logs, browser
history, proxies and Referer headers. Use X-API-Key or Authorization: Bearer.
Sandbox keys
A key prefixed edgr_test_ is a sandbox key. Calls with it are free — they
spend no credits and never touch SEC or government sources — and return a fixed, realistically-shaped
sample response for the endpoint. Use them to build and test your integration (in code, in CI, in your
docs) without burning credits.
curl https://api.edgrapi.com/v1/insider/AAPL -H "X-API-Key: edgr_test_..."Every sandbox response carries an X-Sandbox: true header and a "sandbox": true
field, so it's unmistakable. Because a sandbox key can't cost anything or return anything real, it's safe
to commit, paste in examples, or share. Create one on the API keys page (pick
Sandbox in the create form) or try one in the playground. Switch to a
live key (the plain edgr_ prefix) for real data — those spend credits as normal.
Server-side only
Call /v1 from your backend, not from browser JavaScript. The API sends no CORS
headers, on purpose: a key that reaches the browser is a key you have leaked to every user and
extension on the page. If a frontend needs Edgrapi data, proxy the request through your own server
and keep the key there.
Via RapidAPI
Subscribe through RapidAPI and their proxy authenticates you, so you don't need an Edgrapi key. RapidAPI meters your plan and forwards verified requests to the origin.
Via MCP & agents
The hosted MCP server and the agent skill use the same key as a bearer token:
Authorization: Bearer edgr_...See AI agents & MCP for full setup.
MCP tool → REST endpoint
The MCP tools follow the tool-calling convention of a verb-noun name (get_fundamentals),
while REST uses the resource path (/v1/fundamentals). Same data, same credit cost. The
mapping:
| MCP tool | REST endpoint |
|---|---|
get_company | GET /v1/company/{ticker} |
get_fundamentals | GET /v1/fundamentals/{ticker} |
get_ratios | GET /v1/ratios/{ticker} |
get_filings | GET /v1/filings/{ticker} |
get_sections | GET /v1/sections/{ticker} |
get_insider | GET /v1/insider/{ticker} |
get_events | GET /v1/events/{ticker} |
get_holdings | GET /v1/holdings/{identifier} |
get_activist | GET /v1/activist/{identifier} |
get_xbrl | GET /v1/xbrl/{ident} |
get_shares | GET /v1/shares/{ticker} |
resolve_entity | GET /v1/resolve |
search_filings | GET /v1/search/fulltext |