> ## 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/stream/ws

> Upgrade to a WebSocket connection for delivery event streaming

Upgrade to a WebSocket connection for delivery event streaming

<Info>
  Audience: application and coding agent.
</Info>

## Canonical metadata

* `requestId`
* `traceparent`

## Example request

<RequestExample>
  ```bash theme={null}
  npx wscat -c "wss://api.secapi.ai/v1/stream/ws?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"
  ```
</RequestExample>

<Info>
  Mint the short-lived `$SECAPI_STREAM_TICKET` first with `POST /v1/stream/tickets` so you do not expose a long-lived API key in a browser-visible WebSocket URL.
</Info>

## Example response

<ResponseExample>
  ```json theme={null}
  {
    "requestId": "req_2ZK8Q1W9F4M6P7R3"
  }
  ```
</ResponseExample>

## Give this prompt to your agent

<Prompt>
  Use SEC API GET /v1/stream/ws to upgrade to a WebSocket connection for delivery event streaming. Preserve `requestId`, `traceparent` in the output. Return a concise markdown summary plus the exact structured payload fields that a downstream engineer or agent should keep using this result.
</Prompt>

## 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