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.

Platform

Identity, org, auth metadata, usage, billing, events, and platform posture endpoints.
The sidebar labels inside this family are the literal calls you make over HTTP. Descriptions stay in the body so the navigation stays sharp and scannable.

Operations in this family

GET /.well-known/oauth-authorization-server

Return or proxy OAuth authorization server metadata for the configured WorkOS tenant

GET /.well-known/oauth-protected-resource

Return OAuth protected resource metadata for hosted MCP and API clients

POST /mcp

Hosted MCP transport endpoint

POST /v1/admin/maintenance/company-mapping-identifiers

Backfill FIGI-family and security identifier coverage into the canonical entity store from operator-supplied universe rows

POST /v1/admin/maintenance/hot-lane

Run operator-scoped hot-lane polling to enqueue fresh SEC publication observations

POST /v1/admin/maintenance/ingest-queue

Export an operator-scoped ingest queue and checkpoint summary from the running Datastream service

POST /v1/admin/maintenance/ingest-worker

Run operator-scoped ingest worker passes to materialize queued filing artifacts and sections

POST /v1/admin/maintenance/reconcile-hot

Run operator-scoped reconcile work to enqueue missing live hot-lane filings

POST /v1/admin/maintenance/warm-factor-data

Warm operator-scoped factor returns, exposures, and correlations for covered symbols and factor categories

POST /v1/admin/maintenance/warm-factor-intraday

Warm operator-scoped intraday factor snapshots for supported categories and windows

POST /v1/admin/maintenance/warm-macro-data

Bootstrap operator-scoped Tier-1 macro materialization for launch countries

POST /v1/admin/maintenance/warm-market-data

Warm operator-scoped market snapshots, reference, estimates, bars, and corporate-action caches for covered symbols

POST /v1/admin/maintenance/warm-market-latest

Warm search-visible manifests for the latest market-wide SEC filings by core form

GET /v1/admin/orgs

List operator-visible organizations with support-safe plan, usage, and recent activity summaries

GET /v1/admin/orgs/{org_id}

Return an operator-facing organization snapshot with API keys, billing, usage, events, webhooks, streams, and delivery state

GET /v1/admin/orgs/{org_id}/deliveries/summary

Return operator-scoped delivery aggregates for webhook and stream activity within a tenant

GET /v1/admin/orgs/{org_id}/requests/{request_id}

Return operator-scoped request diagnostics for a tenant request identifier

GET /v1/api_keys

List API keys for the current organization

POST /v1/api_keys

Create a new API key for the current organization

GET /v1/billing

Return the current organization’s billing snapshot, including pricing posture, budget controls, and settlement provider state

PUT /v1/billing/budget

Update organization-level spend caps, soft caps, and approval thresholds for PAYG usage

POST /v1/billing/checkout

Create a Stripe Checkout session for a self-serve Personal or Team Omni Datastream plan

POST /v1/billing/payg/activate

Create a Stripe Checkout setup session that activates Pay As You Go card-on-file billing

POST /v1/billing/portal

Create a Stripe Billing Portal session for the current organization

POST /v1/billing/quote

Quote a billable workflow or meter class against the current billing plan and budget gates

GET /v1/billing/rates

Return the public pricing catalog, plan metadata, and meter-family launch rates

POST /v1/billing/webhooks/stripe

Receive and process signed Stripe subscription lifecycle webhooks

GET /v1/events

List canonical event, webhook delivery, and stream records for the current organization

GET /v1/events/auditor-changes

Return 8-K Item 4.01 auditor change events with change-type classification (dismissal, resignation, engagement)

GET /v1/events/enforcement

Return official SEC litigation releases and administrative proceedings with explicit release-source semantics and shared trace references

GET /v1/events/export

Export filtered canonical events as JSON or NDJSON for support and operations

GET /v1/events/officer-changes

Return 8-K Item 5.02 officer and director change events with change-type classification (appointment, departure, resignation, termination)

GET /v1/events/restatements

Return 8-K Item 4.02 restatement and non-reliance events with severity classification and affected-period extraction

GET /v1/events/voting-results

Return 8-K Item 5.07 voting results with structured proposals, vote counts, and approval outcomes — first-in-market parser ahead of sec-api.io’s open bug

GET /v1/me

Return the current authenticated principal and organization context

GET /v1/org

Return the current organization profile