Quickstart (REST)

Fetch a company’s financial statements by ticker in one call, then turn the same data into a ready-to-render statement. Copy, paste, run. Every example below works as-is once you drop in your key.

1. Get your API key

Every request authenticates with an API key, sent either as an X-API-Key header or a ?apiKey= query parameter. Create one on the Credentials page, or sign up for a free account first. The free plan needs no credit card.

Keep it server-side

Treat your key like a password. Send it from your backend, not from browser JavaScript where anyone can read it.

2. Your first call — statements by ticker

Ask for Apple’s most recent quarterly statements. You pass a ticker — no need to look up a filing ID first; the engine resolves the right company and the right filing for you.

first call · cURL · bash

curl "https://api.finradar.ai/api/v1/xbrl/companies/AAPL/statements?period=Q" \
  -H "X-API-Key: YOUR_API_KEY"

first call · Python · python

import requests

resp = requests.get(
    "https://api.finradar.ai/api/v1/xbrl/companies/AAPL/statements",
    params={"period": "Q"},
    headers={"X-API-Key": "YOUR_API_KEY"},
)
data = resp.json()
print(data["meta"]["resolved_accession"])   # the exact filing you were served
print(data["data"]["statements"].keys())    # income, balance, cash-flow, ...

3. What you got back

Every response uses the same envelope, so your parsing code is the same on every endpoint:

status — "success" or "error".
data — the statements themselves (the numbers exactly as reported in the filing).
meta — which filing answered you (resolved_accession, period_of_report), so a served number always traces back to its source document.
request_id — a unique id for the call; quote it if you ever contact support.

A blank figure is never a silent zero. When a value is missing you get an honest marker (nm for not-meaningful, or an absent/hole status) with a reason, so you always know the difference between “really zero” and “not reported.”

4. Next: a ready-to-render statement

The call above returns the filing faithfully. When you want the numbers already arranged into a professional statement — canonical line items in presentation order, with footing checks that prove the totals add up — add template=true on the time-series endpoint:

rendered statement · cURL · bash

curl "https://api.finradar.ai/api/v1/xbrl/timeseries?ticker=AAPL&period=A&template=true" \
  -H "X-API-Key: YOUR_API_KEY"

Browse the full As-Filed engine: Company Financials (As-Filed).
Every response tells you what it cost (X-Tokens-Charged) and how much budget is left (X-RateLimit-*).
Prefer a whole spreadsheet over single calls? See Quickstart (Bulk Files).
Want a machine-readable spec or a client library? See the Integrations hub (OpenAPI, Python SDK, CLI, MCP server).