GET /v1/stream/ws - SEC API for AI

npx wscat -c "wss://api.secapi.ai/v1/stream/ws?stream_id=$SECAPI_STREAM_ID&ticket=$SECAPI_STREAM_TICKET" \
  -H "secapi-version: 2026-03-19"

# Mint the short-lived ticket first:
curl -X POST \
  -H "x-api-key: $SECAPI_API_KEY" \
  -H "secapi-version: 2026-03-19" \
  -H "content-type: application/json" \
  -d '{}' \
  "https://api.secapi.ai/v1/stream/tickets"

# Or authenticate the upgrade with an API key instead of a ticket:
npx wscat -c "wss://api.secapi.ai/v1/stream/ws?stream_id=$SECAPI_STREAM_ID" \
  -H "x-api-key: $SECAPI_API_KEY" \
  -H "secapi-version: 2026-03-19"

{
  "requestId": "req_2ZK8Q1W9F4M6P7R3"
}

Upgrade to a WebSocket connection for delivery event streaming

Audience: application and coding agent.

Coverage and source scope

Upgrades an active WebSocket stream subscription to a WebSocket connection. Clients must supply that subscription’s stream_id and authenticate with either a short-lived signed ticket minted from POST /v1/stream/tickets or the x-api-key header. Connections are capped by plan but are not separately billable in v1. Delivered events use the same delivery-event billing family as stream polling and are idempotent per subscription and event.

Canonical metadata

requestId
traceparent

Example request

npx wscat -c "wss://api.secapi.ai/v1/stream/ws?stream_id=$SECAPI_STREAM_ID&ticket=$SECAPI_STREAM_TICKET" \
  -H "secapi-version: 2026-03-19"

# Mint the short-lived ticket first:
curl -X POST \
  -H "x-api-key: $SECAPI_API_KEY" \
  -H "secapi-version: 2026-03-19" \
  -H "content-type: application/json" \
  -d '{}' \
  "https://api.secapi.ai/v1/stream/tickets"

# Or authenticate the upgrade with an API key instead of a ticket:
npx wscat -c "wss://api.secapi.ai/v1/stream/ws?stream_id=$SECAPI_STREAM_ID" \
  -H "x-api-key: $SECAPI_API_KEY" \
  -H "secapi-version: 2026-03-19"

Create and activate a WebSocket stream subscription first, then pass its $SECAPI_STREAM_ID and authenticate with either a short-lived $SECAPI_STREAM_TICKET minted with POST /v1/stream/tickets or an x-api-key upgrade header. Add an optional cursor to replay delivery records after that cursor. A ticket keeps a long-lived API key out of the browser-visible WebSocket URL.

Example response

{
  "requestId": "req_2ZK8Q1W9F4M6P7R3"
}

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

​Coverage and source scope

​Canonical metadata

​Example request

​Example response

​Give this prompt to your agent

​Failure posture

Coverage and source scope

Canonical metadata

Example request

Example response

Give this prompt to your agent

Failure posture