# API reference

The reference is generated from the OpenAPI schema at https://docs.arche.fi/openapi.json. Use it for exact route, parameter and response details, and the task-first guides for workflow context. The interactive reference is at https://docs.arche.fi/reference.

## Endpoint index

All 90 operations in the OpenAPI schema, grouped by tag.

### Health

- `GET /health/z` — Liveness
- `GET /health/readiness` — Readiness

### System

- `GET /v1/system/metadata` — Get system metadata
- `GET /v1/system/ingestion/status` — Get EDGAR feed freshness

### Metrics

- `GET /v1/metrics/segments` — List segment/geography metric disclosures
- `GET /v1/metrics/definitions` — List metric definitions
- `GET /v1/metrics/definitions/{metric}` — Get one metric definition

### Fundamentals

- `GET /v1/fundamentals/macro/series` — Approved macro series registry
- `GET /v1/fundamentals/macro/series/{series_code}` — Approved macro series observations
- `GET /v1/fundamentals/macro/context/{target_date}` — Macro context for a date
- `GET /v1/edgar/derived-metrics/catalog` — List derived metrics catalog
- `GET /v1/edgar/derived-metrics/time-series` — Get derived metrics time series
- `GET /v1/edgar/companies/{cik}/metrics/{metric}/time-series` — Get normalized metric time series
- `GET /v1/edgar/metric-bundles` — List filing-based metric bundles
- `GET /v1/edgar/companies/{cik}/metric-bundles/{bundle_code}/time-series` — Get filing-based metric bundle time series
- `GET /v1/edgar/companies/{cik}/financial-state/time-series` — Get aligned financial-state time series
- `GET /v1/fundamentals/companies/{cik}/metrics/{metric}/time-series/real` — Inflation-adjusted EDGAR metric time series
- `GET /v1/fundamentals/time-series` — Fundamentals time series
- `GET /v1/fundamentals/derived/time-series` — Derived metrics time series
- `GET /v1/fundamentals/restatement-delta` — Restatement delta for a single statement
- `GET /v1/fundamentals/normalized-statements` — Normalized EDGAR statement as each filing reported it
- `GET /v1/fundamentals/normalized-statements/dq-overlay` — Normalized statement with data-quality overlay
- `GET /v1/analysis/version-delta` — First-filed versus latest-filed metric delta
- `GET /v1/analysis/metric-drift` — Metric drift analytics
- `GET /v1/analysis/model-impact` — Model impact of restatements

### Filings

- `GET /v1/edgar/companies/{cik}/filings` — List EDGAR filings for a company
- `GET /v1/edgar/companies/{cik}/filings/{accession_id}` — Get EDGAR filing detail
- `GET /v1/edgar/companies/{cik}/disclosures` — List a company's narrative disclosures
- `GET /v1/edgar/disclosures/{disclosure_id}` — Read one narrative disclosure
- `GET /v1/edgar/companies/{cik}/facts/concepts` — List every XBRL concept a company reported
- `GET /v1/edgar/companies/{cik}/facts` — List the values a company reported in XBRL
- `GET /v1/edgar/companies/{cik}/filings/{accession_id}/facts` — List every numeric fact in a filing's XBRL

### Companies

- `GET /v1/edgar/companies/{cik}` — Get canonical EDGAR company profile
- `GET /v1/edgar/companies:resolve` — Resolve canonical CIK by ticker
- `GET /v1/identity/companies/{cik}` — List company identity history by CIK
- `GET /v1/identity/tickers/{ticker}` — List ticker identity history
- `GET /v1/identity/search` — Search companies by ticker, CIK, or name
- `GET /v1/identity/resolve` — Resolve a ticker to one company as of a date

### Coverage

- `GET /v1/edgar/companies/{cik}/completeness` — Get EDGAR completeness summary for a company
- `GET /v1/edgar/reconciliation/ledger` — Get reconciliation ledger for a statement identity (Growth plan)
- `GET /v1/edgar/reconciliation/summary` — Get reconciliation summary for a fiscal-year window (Growth plan)
- `GET /v1/edgar/companies/{cik}/statements/dq/overlay` — Get a normalized statement with DQ overlay
- `GET /v1/data-quality/issues` — List public data-quality issues
- `POST /v1/query/execute` — Execute a deterministic public query
- `GET /v1/query/replay/{replay_token}` — Replay a query from its replay token
- `GET /v1/query/verify/{replay_token}` — Verify a replay token
- `GET /v1/coverage/metrics` — List metric coverage summaries
- `GET /v1/coverage/companies` — List company coverage summaries
- `GET /v1/coverage/companies/{cik}` — Get company coverage summary
- `GET /v1/coverage/metrics/{metric}` — Get metric coverage summary
- `GET /v1/coverage/selection` — Show the companies this plan covers
- `POST /v1/coverage/selection/release` — Release one company's coverage slot

### Statements

- `GET /v1/edgar/companies/{cik}/statements` — List EDGAR statements for a company
- `GET /v1/edgar/companies/{cik}/filings/{accession_id}/statements` — Get the statements a filing reported
- `GET /v1/edgar/companies/{cik}/statements/restatement-timeline` — Get restatement metric timeline for a statement identity
- `GET /v1/edgar/companies/{cik}/filings/{accession_id}/statements/{statement_type}/{fiscal_year}/{fiscal_period}/fact-revisions` — Get the fact revision ledger of a filing's statement
- `GET /v1/edgar/companies/{cik}/filings/{accession_id}/statements/{statement_type}/{fiscal_year}/{fiscal_period}/metrics/{metric_name}/audit-chain` — Get the metric audit chain of a filing's statement
- `GET /v1/edgar/companies/{cik}/filings/{accession_id}/statements/{statement_type}/{fiscal_year}/{fiscal_period}/metrics/{metric_name}/provenance` — Get simplified metric provenance for a filing's statement
- `GET /v1/edgar/as-of/{date}/financials/{cik}` — Get EDGAR financials as-of a date or time
- `GET /v1/edgar/as-of/{date}/financials/{cik}/page` — Get one page of EDGAR financials as-of a date or time
- `GET /v1/edgar/statements/restatements/delta` — Get restatement delta between two filings
- `GET /v1/edgar/statements/restatements/ledger` — Get restatement ledger for a statement identity
- `GET /v1/edgar/restatement-alerts` — List restatement alert events
- `GET /v1/edgar/restatement-alerts/{restatement_alert_event_id}` — Get one restatement alert event
- `GET /v1/edgar/companies/{cik}/statements/overrides/trace` — Inspect XBRL mapping overrides for a statement identity

### Views

- `GET /v1/views/metrics` — List registered metric views (bundles)
- `GET /v1/views/metrics/{bundle_code}` — Get derived metrics time series for a metric view

### Modeling

- `GET /v1/modeling/companies/{company_id}/periods` — Modeling periods (Growth plan)
- `GET /v1/modeling/companies/{company_id}/ttm` — Modeling TTM (Growth plan)
- `GET /v1/modeling/companies/{company_id}/growth` — Modeling growth (Growth plan)
- `GET /v1/modeling/companies/{company_id}/ratios` — Modeling ratios (Growth plan)
- `GET /v1/modeling/companies/{company_id}/multi-year` — Modeling multi-year inputs (Growth plan)
- `POST /v1/modeling/universe/pit-snapshot` — Universe point-in-time snapshot (Growth plan)

### Bulk Export

- `GET /v1/bulk/datasets` — List the bulk export dataset contract (Scale plan)
- `GET /v1/bulk/snapshots` — List published bulk export snapshots (Scale plan)
- `GET /v1/bulk/snapshots/{snapshot_id}` — Read one bulk export snapshot's manifest (Scale plan)
- `GET /v1/bulk/snapshots/{snapshot_id}/files/{file_path}` — Issue a download URL for one snapshot file (Scale plan)
- `GET /v1/bulk/license` — Read the bulk-data license and whether it is accepted (Scale plan)
- `POST /v1/bulk/license/acceptance` — Accept the bulk-data license for the organization (Scale plan)

### Account

- `POST /v1/agent/signup` — Open a Free account for an agent's owner
- `POST /v1/agent/claim` — Claim the account an agent opened
- `POST /v1/agent/checkout-link` — Get a payment link for the account's owner

### AI

- `GET /v1/ai/companies/{company_id}/anomaly-explanations` — Anomaly explanations (Scale plan)
- `GET /v1/ai/companies/{company_id}/narratives` — Financial narratives (Growth plan)

### Webhooks

- `GET /v1/account/webhook-subscriptions` — List account webhook subscriptions
- `POST /v1/account/webhook-subscriptions` — Create account webhook subscription (Developer plan)
- `POST /v1/account/webhook-subscriptions/{subscription_id}/rotate-secret` — Rotate a webhook subscription's signing secret (Developer plan)
- `DELETE /v1/account/webhook-subscriptions/{subscription_id}` — Delete account webhook subscription

### MCP

- `POST /mcp` — Call the MCP server
- `GET /mcp/manifest` — Describe the MCP surface