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.

Give this prompt to your agent

Generated from the Omni Datastream contract and prompt asset registry.
For persona-tuned prompts (50 prompts × 5 customer segments — law firms, investment managers, sophisticated investors, insurance, PR firms), see the agent prompt library.

Setup prompt

You are using Omni Datastream as the SEC data system of record.

Base URLs:
- REST API: https://api.secapi.ai
- Hosted MCP: https://api.secapi.ai/mcp
- Protected resource metadata: https://api.secapi.ai/.well-known/oauth-protected-resource
- Authorization server metadata: https://api.secapi.ai/.well-known/oauth-authorization-server
- Docs root: https://docs.secapi.ai

Rules:
- Prefer structured Omni Datastream endpoints and MCP tools over raw filing text when possible.
- Check GET /v1/billing and GET /v1/limits before expensive or repeated workflows.
- Use POST /v1/billing/quote before repeated heavy workflows, and stop if the server returns `billing_budget_approval_required` or `billing_budget_hard_cap_exceeded`.
- If the client does not already have a long-lived API key, have a human operator mint a sponsor token via POST /v1/agent/bootstrap_tokens and exchange it through POST /v1/agent/bootstrap before repeated machine workflows.
- Preserve requestId, traceparent, Omni-Plan-Key, Omni-Billing-State, Omni-Free-Grant-Remaining, provenance, freshness, and materialization metadata on every downstream artifact.
- Warn before repeated loops when the org is close to exhausting the starter grant or is in payg_pending_card.
- Use the generated prompt snippets below before improvising generic SEC workflows.

Generated snippets

Issuer Research

  • Endpoint focus: /v1/filings/latest
  • Summary: Resolve an issuer, pull the latest 10-K, and extract the risk sections.
Use Omni Datastream to resolve AAPL, fetch the latest 10-K, extract Item 1A and Item 7, and return a concise markdown research brief with requestId, billing headers, provenance, and freshness metadata for every section.

Statement Workflow

  • Endpoint focus: /v1/statements/all
  • Summary: Fetch the all-statements bundle and segmented revenue history.
Use Omni Datastream to fetch the annual all-statements bundle and segmented revenue history for AAPL, then summarize the last three periods with the key changes, source accession numbers, and the billing posture used during the workflow.

Ownership Workflow

  • Endpoint focus: /v1/owners/institutional/investor
  • Summary: Inspect a manager portfolio and the latest holder graph for an issuer.
Use Omni Datastream to pull Berkshire Hathaway's latest institutional investor portfolio, then fetch the ticker-centric institutional holder graph for AAPL and highlight the biggest positions with quarter-over-quarter changes while preserving requestId and plan metadata.

Offerings Workflow

  • Endpoint focus: /v1/offerings
  • Summary: Monitor recent S-1 and 424B activity.
Use Omni Datastream to search recent S-1 and 424B4 filings, then return the newest issuers, accession numbers, offering family, prospectus URLs, and billing headers from the request sequence in a sortable markdown table.

Corporate Actions Workflow

  • Endpoint focus: /v1/events/ma
  • Summary: Inspect recent SEC-native M&A events and SEC-furnished earnings materials.
Use Omni Datastream to fetch recent M&A events and SEC-furnished earnings materials for AAPL, then return the latest filings, event or coverage classification, accession numbers, concise traceable summaries, and any billing posture warnings encountered.

Contract coverage

  • /v1/statements/segmented-revenues — Return filing-derived segmented revenue history with XBRL product or geography dimensions, capability state, and trace references when issuers disclose them
  • /v1/statements/share-float — Return a share-float wrapper backed by SEC company facts, including disclosed public float when available and shares-outstanding fallback semantics otherwise
  • /v1/statements/all — Return the balance sheet, income statement, and cash flow statement as one normalized bundle
  • /v1/entities/resolve — Resolve an entity by ticker, CIK, FIGI-family identifier, ISIN, CUSIP, or name with confidence and match-basis metadata
  • /v1/entities — Search canonical SEC entities across issuers, managers, insiders, and funds
  • /v1/filings — Search filing manifests with historical filters, accession lookup semantics, sorting, and cursor pagination
  • /v1/filings/latest — Retrieve the latest filing for an entity and form
  • /v1/filings/latest/render — Render the latest filing into Markdown-like text
  • /v1/filings/latest/sections/{section_key} — Extract a section from the latest filing for an entity and form
  • /v1/filings/latest/risk-categories — Return deterministic Item 1A risk-category coverage for the latest covered filing of an issuer
  • /v1/filings/{accession_number} — Retrieve a filing manifest by accession number from the materialized filing corpus
  • /v1/filings/{accession_number}/sections/{section_key} — Extract a filing item or section from a specific accession-number filing