Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.secapi.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
GET /v1/entities/resolve

Resolve an entity by ticker, CIK, FIGI-family identifier, ISIN, CUSIP, or name with confidence and match-basis metadata
Audience: application and coding agent.

​
Agent mode

Pass ?view=agent to receive the compact agent shape: entity identifiers (id, ticker, cik, name) + primary identifiers + match metadata. Aliases, jurisdiction, full identifiers list, and metadata envelopes are dropped. See api conventions → response formats for the full ?view= contract.

​
Canonical metadata

  • requestId
  • traceparent
  • provenance
  • freshness
  • materialization

​
Example request

curl -X GET \
  -H "x-api-key: $OMNI_DATASTREAM_API_KEY" \
  -H "omni-version: 2026-03-19" \
  "https://api.secapi.ai/v1/entities/resolve"

​
Example response

{
  "requestId": "req_example_123",
  "traceparent": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01",
  "provenance": {
    "source": "sec",
    "accessionNumber": "0000320193-25-000079",
    "filingUrl": "https://www.sec.gov/Archives/edgar/data/320193/000032019325000079/aapl-20250927_htm.xml",
    "retrievedAt": "2026-03-17T00:00:00.000Z",
    "parserVersion": "2026-03-13.5",
    "rawSourceKey": "0000320193-25-000079"
  },
  "freshness": {
    "status": "fresh",
    "asOf": "2026-03-17T00:00:00.000Z",
    "sourcePublishedAt": "2025-10-31T00:00:00.000Z",
    "lagMs": 900000
  },
  "materialization": {
    "parserVersion": "2026-03-13.5",
    "materializationVersion": "datastream-3.0"
  }
}

​
Give this prompt to your agent

​
Failure posture

  • treat non-2xx responses as contract-aware failures, not free-form errors
  • preserve requestId and traceparent in logs and downstream reports
  • if provenance or freshness metadata is present, return it unchanged so trust is not lost in the handoff