DEVELOPER DOCUMENTATION
Research APIs, with evidence included.
FastAPI endpoints expose the same local-first data and research workflows used by the interface. Authenticate with a bearer access token or an API key created in Settings.
Quick start
curl https://your-domain.example/api/v1/auth/login \
-H 'Content-Type: application/json' \
-d '{"email":"you@example.com","password":"your-password"}'
curl https://your-domain.example/api/v1/tools/trends/AAPL \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN'Tool responses include success, data, source, error, and next_steps. Source is local, edgar_live, or hybrid. Data is saved before background graph and vector indexing.
| Method | Endpoint | Purpose |
|---|---|---|
| GET | /api/v1/companies/?q=Apple | Search companies |
| GET | /api/v1/tools/company/AAPL | Local-first company profile |
| GET | /api/v1/tools/trends/AAPL?start_year=2020&end_year=2024 | Financial time series and YoY growth |
| POST | /api/v1/tools/compare | Multi-company comparisons |
| GET | /api/v1/documents/{accession} | Filing metadata, text, and sections |
| POST | /api/v1/rag/agent-response | Cited research answer |
| POST | /api/v1/rag/agent-response-stream | SSE research stream |
| GET | /api/v1/rag/chunks?query=supply+chain | Search document passages |
| GET | /api/v1/graph/company/AAPL/peers | Weighted peer grouping |
| POST | /api/v1/filings/ingest | Admin: durable background ingestion |
| GET | /api/v1/export/metrics?format=xlsx&cik=AAPL | Excel data export |
| POST | /api/v1/workflows/{kind} | Disclosure, screen, KPI, and entity workflows |
| GET | /api/v1/workspace/notes | Your private notes and tracked issues |
| GET | /api/v1/coverage | Provider coverage and limitations |
Streaming research
POST a JSON body with query, company_filter, fiscal_year_range, and optional session_id. Events arrive as session, thinking, sources, data, message, and complete. The message event contains incremental text. Reuse session_id for follow-up questions; memory=false excludes previous messages from the model context.
The full OpenAPI schema and interactive reference are served by FastAPI at /api-docs. Coverage is SEC-first; global investor-relations-only documents require additional providers.