# SourceKeel API

Base URL: http://127.0.0.1
Authentication: `Authorization: Bearer sk_live_...`

Use CIK for stable company identity. Tickers are aliases.

Five-minute setup:
1. Sign up at `/signup`.
2. Create a key in `/dashboard`.
3. Export `SOURCEKEEL_BASE_URL` and `SOURCEKEEL_API_KEY`.
4. Call `GET /v1/companies/{cik}` or `GET /v1/filings/{accession}`.
5. Follow `links`, `objects`, and `applicable_extractions`.

Example issuer used in docs:
- Company: Amprius Technologies, Inc.
- Ticker: AMPX
- CIK: 0001899287
- Sample accession: 0001899287-26-000015
- Form: 10-K

Full AMPX endpoint capture:
- `docs/ampx-endpoint-examples.md` records every documented endpoint against AMPX where possible, including HTTP status, schema/error shape, counts, representative response excerpts, and pending validation items.

Primary calls:
- GET /v1/companies/lookup?ticker=AMPX
- GET /v1/tickers/AMPX
- GET /v1/companies/0001899287
- GET /v1/companies/0001899287/filings
- GET /v1/companies/0001899287/financials/latest
- GET /v1/companies/0001899287/facts/all/latest
- GET /v1/companies/0001899287/revenue-segments/latest
- GET /v1/companies/0001899287/schema
- GET /v1/companies/0001899287/securities
- GET /v1/companies/0001899287/security-lifecycle
- GET /v1/filings/0001899287-26-000015
- GET /v1/filings/0001899287-26-000015/documents
- GET /v1/filings/0001899287-26-000015/facts/revenue
- GET /v1/filings/0001899287-26-000015/sections
- GET /v1/filings/0001899287-26-000015/sections/item7
- GET /v1/filings/0001899287-26-000015/cover-securities
- GET /objects/filings/accession/0001899287-26-000015/source_manifest.json

Response rules:
- Materialized object endpoints return full source-backed objects.
- Search/feed endpoints use `limit` and `cursor`.
- Send `Accept-Encoding: gzip` for large JSON responses.
- Bulk endpoints return `bulk_export` descriptors; download the returned `object_url` for pre-compressed JSONL gzip exports.
- Failures use `sourcekeel.failure.v1` with structured `failure_reason`.

AMPX captured failure examples:
- `GET /v1/bulk/facts` with a non-Mirror key returns `mirror_plan_required` and evidence object `/objects/bulk/facts/latest.jsonl.gz`.
- `GET /v1/public-offering-structures?cik=0001899287` currently returns `public_offering_structures_bulk_not_available`; company public-offering history exists, but the global bulk search artifact must be rebuilt.
- `GET /v1/filings/0001899287-26-000045/cover-securities` currently returns `object_not_found` for `/objects/filings/accession/0001899287-26-000045/cover_securities.json`.
- `GET /v1/companies/0001899287/filings/0001899287-26-000015/sections/item999` returns a `sourcekeel.section.v1` object with `extraction_status=not_materialized`.

AMPX pending validation:
- Global index gaps: company search, feature manifest, feed indexes, schema catalog, and public-offering search.
- Parser validation gaps: Schedule 13D/G activism/beneficial ownership, Form D private offerings, Form 144 proposed sales, and subsidiaries.
- Filing object gaps: extraction index, filing schema, and section schema output.

OpenAPI: /openapi.json
Human docs: /docs