Docs / Getting started

Quickstart

From signup to your first response in a few minutes.

1. Get an API key

Create an account with an email and password, no card. A key is minted for you on signup; make more under Dashboard → API keys. Keys look like edgr_AbCd… and go in the X-API-Key header. Want a one-off key? POST https://api.edgrapi.com/v1/keys returns a free one.

export EDGRAPI_KEY=edgr_...

2. Make your first call

Pull Apple's annual statements:

curl "https://api.edgrapi.com/v1/fundamentals/AAPL?period=annual&limit=4" \
  -H "X-API-Key: $EDGRAPI_KEY"
import os, requests
r = requests.get("https://api.edgrapi.com/v1/fundamentals/AAPL",
    params={"period": "annual", "limit": 4},
    headers={"X-API-Key": os.environ["EDGRAPI_KEY"]}, timeout=60)
r.raise_for_status()
print(r.json()["income_statement"][0]["revenue"])
const res = await fetch(
  "https://api.edgrapi.com/v1/fundamentals/AAPL?period=annual&limit=4",
  { headers: { "X-API-Key": process.env.EDGRAPI_KEY } });
const data = await res.json();
console.log(data.income_statement[0].revenue);

A successful response:

{
  "ticker": "AAPL", "company": "Apple Inc.",
  "period": "annual", "currency": "USD",
  "income_statement": [
    { "period": "2025", "revenue": 416161000000,
      "net_income": 112010000000, "eps_diluted": 7.46 }
  ],
  "source": "SEC EDGAR companyfacts"
}

3. Get computed ratios

curl https://api.edgrapi.com/v1/ratios/AAPL -H "X-API-Key: $EDGRAPI_KEY"

Returns margins, ROE/ROA, leverage and liquidity, already computed from the fundamentals.

4. List recent filings

curl "https://api.edgrapi.com/v1/filings/AAPL?form=10-K" -H "X-API-Key: $EDGRAPI_KEY"

Each plan meters total requests; free accounts get 100 to start. See Rate limits & plans.

Next

Authentication →