API reference
The reference is generated from the current OpenAPI schema. Use it for exact route, parameter, and response details, then pair it with the task-first guides for workflow context. For a plain list of every route, see the endpoint index.
OpenAPI schema
/openapi.json
Endpoint index
All 90 operations in the OpenAPI schema, grouped by tag, with the parameters each one takes. Open an operation in the interactive reference above for response shapes and examples, or read the schema itself.
Health
- GET
/health/zLiveness — Return a fast liveness signal (no external I/O).
- GET
/health/readinessReadiness — Return readiness status based on DB/Redis probes.
System
- GET
/v1/system/metadataGet system metadata — Return static API metadata and client limits, including the public HTTP API version and maximum page size.
- GET
/v1/system/ingestion/statusGet EDGAR feed freshness — Return how current each EDGAR feed is: when it last succeeded, how far behind it is, and whether it is stale, so a job can check the corpus is current before it runs.
Metrics
- GET
/v1/metrics/segmentsList segment/geography metric disclosures — Return source disclosure rows classified as SEGMENT or GEOGRAPHY.
cik? company_id? dimension_type? page? page_size? period? ticker?
- GET
/v1/metrics/definitionsList metric definitions — Return the deterministic public registry of canonical and derived metric definitions.
- GET
/v1/metrics/definitions/{metric}Get one metric definition — Return one deterministic metric definition by metric code.
metric
Fundamentals
- GET
/v1/fundamentals/macro/seriesApproved macro series registry — Return the explicit approved macro context registry.
- GET
/v1/fundamentals/macro/series/{series_code}Approved macro series observations — Return deterministic observations for one approved macro series.
from_date series_code to_date as_of_date?
- GET
/v1/fundamentals/macro/context/{target_date}Macro context for a date — Return a compact government macro context snapshot for a target date.
target_date as_of_date?
- GET
/v1/edgar/derived-metrics/catalogList derived metrics catalog — Return the canonical catalog of derived metric definitions.
- GET
/v1/edgar/derived-metrics/time-seriesGet derived metrics time series — Return a derived metrics time series for one or more companies with deterministic ordering and stable metric definitions.
statement_type ciks? frequency? from_date? metrics? tickers? to_date?
- GET
/v1/edgar/companies/{cik}/metrics/{metric}/time-seriesGet normalized metric time series — Return a deterministic ordered time series of normalized EDGAR facts for one metric.
cik metric as_of_date? as_reported? fiscal_period? fiscal_year_from? fiscal_year_to? include_provenance? page? page_size? period_type? statement_type?
- GET
/v1/edgar/metric-bundlesList filing-based metric bundles — Return the additive catalog of filing-based EDGAR metric bundles supported by this phase.
- GET
/v1/edgar/companies/{cik}/metric-bundles/{bundle_code}/time-seriesGet filing-based metric bundle time series — Return deterministic aligned bundle rows by fiscal period for one company and bundle code.
bundle_code cik as_of_date? fiscal_period? fiscal_year_from? fiscal_year_to? include_provenance? page? page_size? period_type?
- GET
/v1/edgar/companies/{cik}/financial-state/time-seriesGet aligned financial-state time series — Return one aligned EDGAR financial-state row per fiscal period for a company.
cik as_of_date? fiscal_period? fiscal_year_from? fiscal_year_to? include_macro_context? include_provenance? page? page_size? period_type?
- GET
/v1/fundamentals/companies/{cik}/metrics/{metric}/time-series/realInflation-adjusted EDGAR metric time series — Return a nominal and CPI-adjusted metric time series for an existing Arche fundamental metric.
cik metric as_of_date? base_year? cpi_series? fiscal_period? fiscal_year_from? fiscal_year_to?
- GET
/v1/fundamentals/time-seriesFundamentals time series — Return a panel-friendly fundamentals time series derived from normalized EDGAR statements.
statement_type ciks? core_metrics_only? frequency? from? metrics? page? page_size? tickers? to?
- GET
/v1/fundamentals/derived/time-seriesDerived metrics time series — Return a panel-friendly derived metrics time series (margins, growth, cash flows, returns) computed from normalized EDGAR statements when requested; the /v1/modeling ratio and growth routes answer from a point-in-time as-of snapshot instead.
statement_type ciks? frequency? from? metrics? page? page_size? tickers? to?
- GET
/v1/fundamentals/restatement-deltaRestatement delta for a single statement — Compare two filings that report one statement and return the per-metric changes between them (old, new and diff for each canonical metric that changed).
fiscal_period fiscal_year statement_type cik? from_accession? metrics? statement_date? ticker? to_accession?
- GET
/v1/fundamentals/normalized-statementsNormalized EDGAR statement as each filing reported it — Return the latest normalized EDGAR statement for a given (CIK, statement_type, fiscal_year, fiscal_period) identity tuple, optionally with the statement as each SEC filing reported it, the original and each amendment, one entry per filing in acceptance order.
fiscal_period fiscal_year statement_type cik? detail? include_usd? include_version_history? statement_date? ticker?
- GET
/v1/fundamentals/normalized-statements/dq-overlayNormalized statement with data-quality overlay — Return a normalized EDGAR statement for a given identity tuple, combined with its fact-level data-quality overlay (fact-quality flags and anomalies).
accession_id fiscal_period fiscal_year statement_type cik? statement_date? ticker?
- GET
/v1/analysis/version-deltaFirst-filed versus latest-filed metric delta — Return the change in one metric between a reporting period's first-filed figures and its latest-filed figures, across the SEC filings that reported it.
fiscal_period fiscal_year metric statement_type cik? statement_date? ticker?
- GET
/v1/analysis/metric-driftMetric drift analytics — Return original-versus-latest drift analytics for a single reporting period.
fiscal_period fiscal_year metric statement_type cik? statement_date? ticker?
- GET
/v1/analysis/model-impactModel impact of restatements — Return valuation and sensitivity analytics comparing a period's first-filed figures with its latest-filed figures.
fiscal_period fiscal_year statement_type allow_market_inputs? cik? statement_date? ticker?
Filings
- GET
/v1/edgar/companies/{cik}/filingsList EDGAR filings for a company — Returns a paginated list of normalized EDGAR filing headers for the given CIK.
cik filing_types? from_date? include_amendments? page? page_size? per_page? to_date?
- GET
/v1/edgar/companies/{cik}/filings/{accession_id}Get EDGAR filing detail — Return normalized EDGAR filing metadata for a specific filing.
accession_id cik include_long_form? include_statements?
- GET
/v1/edgar/companies/{cik}/disclosuresList a company's narrative disclosures — Returns a paginated list of the narrative disclosures a company has filed: accounting policies, segment descriptions, debt terms, contingencies and the other text blocks that accompany the statements.
cik accession_id? page? page_size? per_page? period_of_report?
- GET
/v1/edgar/disclosures/{disclosure_id}Read one narrative disclosure — Returns a single disclosure and its narrative text.
disclosure_id
- GET
/v1/edgar/companies/{cik}/facts/conceptsList every XBRL concept a company reported — Returns each XBRL concept the company has reported, with the taxonomy's label and definition, the units used, how many values were reported and the span of periods they cover.
cik as_of? page? page_size? per_page? search? taxonomy?
- GET
/v1/edgar/companies/{cik}/factsList the values a company reported in XBRL — Returns the values the company reported under any XBRL concept, not only the canonical statement metrics: each with its unit, period, and the filing that reported it.
cik as_of? concepts? filing_types? page? page_size? per_page? period_end_from? period_end_to? units?
- GET
/v1/edgar/companies/{cik}/filings/{accession_id}/factsList every numeric fact in a filing's XBRL — Returns every numeric value the filing tagged in XBRL, exactly as filed: the standard taxonomies' concepts and the filer's own extension concepts (such as `aapl:...`), consolidated values and every value broken out by an axis -- segment, product or service, geography and the rest -- with the axis and member in `dimensions`.
accession_id cik axes? concepts? dimensioned? page? page_size? per_page? taxonomies?
Companies
- GET
/v1/edgar/companies/{cik}Get canonical EDGAR company profile — Return a canonical SEC/EDGAR company profile for a CIK with provenance metadata.
cik
- GET
/v1/edgar/companies:resolveResolve canonical CIK by ticker — Resolve a canonical CIK from ticker at a point-in-time date.
ticker as_of?
- GET
/v1/identity/companies/{cik}List company identity history by CIK — Return deterministic identity rows for one CIK.
cik page? page_size?
- GET
/v1/identity/tickers/{ticker}List ticker identity history — Return deterministic identity rows for one ticker symbol across time.
ticker page? page_size?
- GET
/v1/identity/searchSearch companies by ticker, CIK, or name — Search deterministic company identity records by ticker, CIK, or company name.
query page? page_size?
- GET
/v1/identity/resolveResolve a ticker to one company as of a date — Resolve a ticker symbol to the single company identity visible on the requested as-of date.
ticker as_of_date?
Coverage
- GET
/v1/edgar/companies/{cik}/completenessGet EDGAR completeness summary for a company — Return a minimal completeness summary for a company, including the latest filing identifiers and how many statements each statement type has.
cik
- GET
/v1/edgar/reconciliation/ledgerGet reconciliation ledger for a statement identity — Return the reconciliation results recorded for a statement identity.
accession_id fiscal_period fiscal_year statement_type cik? limit? page? page_size? rule_category? statement_date? statuses? ticker?
Growth plan or higher
- GET
/v1/edgar/reconciliation/summaryGet reconciliation summary for a fiscal-year window — Return PASS/FAIL/SKIPPED counts by category over a multi-year window, one filing's current statement per bucket.
fiscal_year_from fiscal_year_to statement_type cik? limit? rule_category? ticker?
Growth plan or higher
- GET
/v1/edgar/companies/{cik}/statements/dq/overlayGet a normalized statement with DQ overlay — Return a normalized statement payload with DQ anomalies and severity overlays for one filing's statement, named by cik, statement_type, fiscal_year, fiscal_period and the filing's accession_id.
accession_id cik fiscal_period fiscal_year statement_type statement_date?
- GET
/v1/data-quality/issuesList public data-quality issues — Return EDGAR data-quality issues with deterministic ordering: severity DESC, cik ASC, fiscal_year ASC NULLS LAST, fiscal_period ASC NULLS LAST, rule_code ASC, with a fixed tie-break so pages never overlap.
cik? fiscal_period? fiscal_year? metric? page? page_size? rule_code? severity? statement_type? ticker?
- POST
/v1/query/executeExecute a deterministic public query — Execute one supported deterministic query, compute immutable manifest hashes, persist the manifest and the result, and optionally return the result payload.
- GET
/v1/query/replay/{replay_token}Replay a query from its replay token — Return the response a replay token was minted for, exactly as first returned, beside its immutable manifest, and re-verify it.
replay_token
- GET
/v1/query/verify/{replay_token}Verify a replay token — Re-run the query a replay token was minted for and say whether it still returns the same data.
replay_token
- GET
/v1/coverage/metricsList metric coverage summaries — Return the EDGAR coverage and completeness summary for every canonical metric, each counted over every company Arche serves.
page? page_size?
- GET
/v1/coverage/companiesList company coverage summaries — Return deterministic company-level EDGAR coverage and completeness summaries.
page? page_size?
- GET
/v1/coverage/companies/{cik}Get company coverage summary — Return the company-level EDGAR coverage and completeness summary for one company, named by CIK or ticker.
cik
- GET
/v1/coverage/metrics/{metric}Get metric coverage summary — Return the EDGAR coverage and completeness summary for one canonical metric, counted over every company Arche serves.
metric
- GET
/v1/coverage/selectionShow the companies this plan covers — Return how the caller's coverage is decided, and, when it is the caller's own selection, which companies are held and when each slot frees itself.
- POST
/v1/coverage/selection/releaseRelease one company's coverage slot — Give one company's slot back immediately rather than waiting out its window.
Statements
- GET
/v1/edgar/companies/{cik}/statementsList EDGAR statements for a company — Returns a paginated list of normalized statements (income, balance sheet, cash flow) for a company over a date range.
cik statement_type detail? from_date? include_restated? include_usd? page? page_size? per_page? to_date?
- GET
/v1/edgar/companies/{cik}/filings/{accession_id}/statementsGet the statements a filing reported — Return the statements (income, balance sheet, cash flow) a specific EDGAR filing reported: one row per statement type and statement date, carrying the filing's current figures.
accession_id cik detail? include_usd? statement_type?
- GET
/v1/edgar/companies/{cik}/statements/restatement-timelineGet restatement metric timeline for a statement identity — Return the restatement timeline and per-metric deltas for a specific statement identity across the SEC filings that reported it, in acceptance order.
cik fiscal_period fiscal_year statement_type include_unchanged_filings? statement_date?
- GET
/v1/edgar/companies/{cik}/filings/{accession_id}/statements/{statement_type}/{fiscal_year}/{fiscal_period}/fact-revisionsGet the fact revision ledger of a filing's statement — Return the immutable fact revision events one filing's statement recorded against the earlier filing it revised.
accession_id cik fiscal_period fiscal_year statement_type statement_date?
- GET
/v1/edgar/companies/{cik}/filings/{accession_id}/statements/{statement_type}/{fiscal_year}/{fiscal_period}/metrics/{metric_name}/audit-chainGet the metric audit chain of a filing's statement — Return the filing, XBRL concept and mapping behind one metric of one filing's statement, and every override applied to it in order.
accession_id cik fiscal_period fiscal_year metric_name statement_type statement_date?
- GET
/v1/edgar/companies/{cik}/filings/{accession_id}/statements/{statement_type}/{fiscal_year}/{fiscal_period}/metrics/{metric_name}/provenanceGet simplified metric provenance for a filing's statement — Return the simplified public provenance drill-down for one metric of one filing's statement.
accession_id cik fiscal_period fiscal_year metric_name statement_type statement_date?
- GET
/v1/edgar/as-of/{date}/financials/{cik}Get EDGAR financials as-of a date or time — Return normalized EDGAR financial statements as known at a date or an exact time.
cik date audit_mode? detail? include_usd?
- GET
/v1/edgar/as-of/{date}/financials/{cik}/pageGet one page of EDGAR financials as-of a date or time — Return one page of a company's normalized EDGAR statements as known at a date or an exact time, selected by statement type, fiscal year and fiscal period.
cik date limit audit_mode? detail? fiscal_period? fiscal_year_from? fiscal_year_to? include_usd? latest_only? offset? statement_type?
- GET
/v1/edgar/statements/restatements/deltaGet restatement delta between two filings — Compare two filings that report one statement and return the per-metric changes between them (old, new and diff for each canonical metric that changed).
fiscal_period fiscal_year statement_type cik? from_accession? statement_date? ticker? to_accession?
- GET
/v1/edgar/statements/restatements/ledgerGet restatement ledger for a statement identity — Return the restatement ledger for a given (cik, statement_type, fiscal_year, fiscal_period) identity.
fiscal_period fiscal_year statement_type cik? include_unchanged_filings? statement_date? ticker?
- GET
/v1/edgar/restatement-alertsList restatement alert events
cik? from? materiality_score? page? page_size? per_page? statement_type? ticker? to?
- GET
/v1/edgar/restatement-alerts/{restatement_alert_event_id}Get one restatement alert event — Return one restatement alert event by identifier.
restatement_alert_event_id
- GET
/v1/edgar/companies/{cik}/statements/overrides/traceInspect XBRL mapping overrides for a statement identity — Return an override trace showing which mapping rules were evaluated, applied, or suppressed for one filing's statement, named by cik, statement_type, fiscal_year, fiscal_period and the filing's accession_id.
accession_id cik fiscal_period fiscal_year statement_type canonical_metric_code? dimension_key? gaap_concept? statement_date?
Views
- GET
/v1/views/metricsList registered metric views (bundles) — Return the catalog of registered metric views (bundles) that can be used with the derived-metrics time-series endpoints.
- GET
/v1/views/metrics/{bundle_code}Get derived metrics time series for a metric view — Return a derived metrics time series for one or more companies using a predefined metric view (bundle).
bundle_code statement_type ciks? frequency? from_date? metrics? tickers? to_date?
Modeling
- GET
/v1/modeling/companies/{company_id}/periodsModeling periods — Return point-in-time modeling period rows for a company.
as_of company_id from? page? page_size? sort? statement_type? to?
Growth plan or higher
- GET
/v1/modeling/companies/{company_id}/ttmModeling TTM — Return point-in-time trailing-twelve-month modeling rows.
as_of company_id from? page? page_size? sort? statement_type? to?
Growth plan or higher
- GET
/v1/modeling/companies/{company_id}/growthModeling growth — Return point-in-time growth rows (YoY/QoQ/CAGR).
as_of company_id from? page? page_size? sort? statement_type? to?
Growth plan or higher
- GET
/v1/modeling/companies/{company_id}/ratiosModeling ratios — Return point-in-time ratio rows (margins, returns, leverage).
as_of company_id from? page? page_size? sort? statement_type? to?
Growth plan or higher
- GET
/v1/modeling/companies/{company_id}/multi-yearModeling multi-year inputs — Return point-in-time valuation inputs for multi-year modeling.
as_of company_id from? page? page_size? sort? statement_type? to?
Growth plan or higher
- POST
/v1/modeling/universe/pit-snapshotUniverse point-in-time snapshot — Return an institutional-safe batch compare snapshot for a CIK universe at a single as-of date.
page? page_size?
Growth plan or higher
Bulk Export
- GET
/v1/bulk/datasetsList the bulk export dataset contract — Return every dataset a snapshot holds, with its columns, types, key and partition column.
Scale plan or higher
- GET
/v1/bulk/snapshotsList published bulk export snapshots — Return published snapshots with each dataset's rows, bytes, file count and how many of those files changed since the previous snapshot.
page? page_size? per_page?
Scale plan or higher
- GET
/v1/bulk/snapshots/{snapshot_id}Read one bulk export snapshot's manifest — Return every file of one published snapshot: its path, dataset, partition, rows, bytes, sha256, and whether its bytes changed since the previous snapshot.
snapshot_id
Scale plan or higher
- GET
/v1/bulk/snapshots/{snapshot_id}/files/{file_path}Issue a download URL for one snapshot file — Return a short-lived URL that reads one file of a published snapshot directly from object storage, beside the file's size and sha256.
file_path snapshot_id
Scale plan or higher
- GET
/v1/bulk/licenseRead the bulk-data license and whether it is accepted — Return the current bulk-data license -- its version, the SHA-256 of its text, and the text itself -- with whether the caller's organization has accepted it.
Scale plan or higher
- POST
/v1/bulk/license/acceptanceAccept the bulk-data license for the organization — Record the caller's organization's acceptance of the current bulk-data license.
Scale plan or higher
Account
- POST
/v1/agent/signupOpen a Free account for an agent's owner — Lets an AI agent open a Free Arche account with its owner's real email and receive a working API key without a browser.
- POST
/v1/agent/claimClaim the account an agent opened — Makes the signed-in user the owner of the account an AI agent opened, named by the `agent_claim` token from the invitation Arche emailed the owner.
- POST
/v1/agent/checkout-linkGet a payment link for the account's owner — Returns a checkout page for a self-serve plan, for the account the API key belongs to.
AI
- GET
/v1/ai/companies/{company_id}/anomaly-explanationsAnomaly explanations — Return AI explanations of the data-quality anomalies found in a company's statements.
as_of company_id min_severity? page? page_size?
Scale plan or higher
- GET
/v1/ai/companies/{company_id}/narrativesFinancial narratives — Return plain-language narratives of how a company's figures moved.
as_of company_id narrative_type page? page_size? statement_type?
Growth plan or higher
Webhooks
- GET
/v1/account/webhook-subscriptionsList account webhook subscriptions — List the organization's outbound webhook subscriptions for restatement alerts.
- POST
/v1/account/webhook-subscriptionsCreate account webhook subscription — Create an outbound webhook subscription for restatement alerts.
Developer plan or higher
- POST
/v1/account/webhook-subscriptions/{subscription_id}/rotate-secretRotate a webhook subscription's signing secret — Issue a new signing secret for one of the organization's webhook subscriptions.
subscription_id
Developer plan or higher
- DELETE
/v1/account/webhook-subscriptions/{subscription_id}Delete account webhook subscription — Delete one of the organization's webhook subscriptions.
subscription_id
MCP
- POST
/mcpCall the MCP server — Model Context Protocol endpoint, speaking Streamable HTTP in JSON response mode.
- GET
/mcp/manifestDescribe the MCP surface — Return how to connect to the MCP endpoint (`POST /mcp`) and what it offers: every tool with its input schema and the least-entitled plan that may call it, and the `mcp` rate-limit class with the limit each plan is metered against; Enterprise limits are negotiated per agreement and carry no figure.