Read the snapshot
Requests read PostgreSQL data populated by the ingestion pipeline. They do not call SEC EDGAR at request time.
Read normalized company profiles, filings, financial metrics, source lineage, validation status, and AI-ready financial context through one focused API.
Requests read PostgreSQL data populated by the ingestion pipeline. They do not call SEC EDGAR at request time.
Explain responses connect values to accessions, filings, XBRL concepts, parsers, and validation states.
Missing expected facts remain visible rather than being replaced by a proxy that changes their accounting meaning.
This page is the API reference hub — everything else this area covers is one click away in the sidebar to the left. Guides, tutorials, and core concepts live at /learn instead.
| Sidebar section | What’s there |
|---|---|
| Coverage & Demo Tickers | The full 8-ticker matrix — which are safe defaults, which are intentional partial-data examples. |
| Data Quality & Lineage | The AVAILABLE/MISSING/LINEAGE_MISSING glossary and a real lineage example. |
| Known Limitations | What this MVP intentionally does not do, and why. |
| Authentication | Self-serve key issuance (curl path) and the CLI (iris auth login) alternative. |
| Error Codes / Rate Limits / AI Usage | The API Reference group — the closed error-code vocabulary, rate-limit contract, and the AI-context response shape. |
| API Endpoints | Every OpenAPI operation, generated live from the real schema, with Try It and Visual View. |
Runnable code lives in the repo, not the sidebar: the examples/ directory (financial-health dashboard, missing-data explainer, AI-agent tool, CLI quickstart) and ledgerbase-iris-cli/README.md for the full CLI command reference.