Get started

Quickstart

From zero to a working request in five minutes.

1. Get a key

Sign in at clarifo.com → Settings → API keys → Create key. The raw key is shown once. It looks like:

key
clf_3a7f8b0d1e2c4f5a6b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e

Store it as an environment variable. Never commit it to source control.

bash
export CLARIFO_API_KEY="clf_…"

2. Make your first call

Search for Neste's annual reports:

curl
curl https://api.clarifo.com/api/v1/data/filings/search \
  -H "Authorization: Bearer $CLARIFO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"company": "Neste", "document_type": "annual_report", "limit": 5}'

You should see a response like:

json
{
  "filings": [
    {
      "docid": "neste_2024_annual",
      "company_name": "Neste Oyj",
      "year": "2024",
      "document_type": "annual_report",
      "document_type_label": "Annual Report",
      "page_count": 142,
      "market": "nordic"
    }
  ],
  "total": 1
}

3. Pull structured financials

bash
curl "https://api.clarifo.com/api/v1/data/companies/Neste/financials?years=3" \
  -H "Authorization: Bearer $CLARIFO_API_KEY"

Returns annual revenue, operating income, EBITDA, net income, equity, cash flow, EPS — plus a latest_period block that surfaces the freshest quarterly figure when one is newer than the latest annual.

4. Cite your numbers

Every figure that has a filing-level source comes with a page_id. Resolve it to a viewable URL:

bash
curl https://api.clarifo.com/api/v1/data/filings/722df34e9f191a97_20/snapshot \
  -H "Authorization: Bearer $CLARIFO_API_KEY"

Nordic filings return a per-page PNG (CloudFront-cached). US filings return a SEC EDGAR link. Either way, your end users can click straight to the exact page that produced the number.

Next steps