> ## Documentation Index
> Fetch the complete documentation index at: https://docs.etherfuse.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect to the live update stream

> Opens a WebSocket that streams `order_updated` events for your organization. Authenticate with a token from `POST /ramp/ws-api-token` passed as the `token` query parameter; a browser cannot set an `Authorization` header on a WebSocket upgrade. The token is single-use and expires in 30 seconds. Each frame signals that an order changed; re-read the order with `GET /ramp/order/{order_id}` for the authoritative state, including any pending approval package. Connect over `wss` (for example `wss://api.etherfuse.com/ramp/ws?token=...`).



## OpenAPI

````yaml /openapi.json get /ramp/ws
openapi: 3.1.0
info:
  title: Etherfuse FX API
  description: Partner-facing ramp API for onramps, offramps, swaps, and KYC.
  license:
    name: Proprietary
  version: 1.0.0
servers:
  - url: https://api.sand.etherfuse.com
    description: Sandbox
security:
  - ApiKeyAuth: []
tags:
  - name: Authentication
    description: >-
      Partner JWT authentication — exchange a JWT for an access token, or launch
      a user into the app.
  - name: Lookup
    description: >-
      Public reference data: exchange rates, stablebonds, bond costs, country
      codes.
  - name: Assets
    description: Rampable stablecoins and stablebonds available per blockchain.
  - name: Onboarding
    description: Hosted and programmatic customer onboarding.
  - name: Bank Accounts
    description: Register and retrieve customer bank accounts.
  - name: Quotes
    description: Price quotes for onramps, offramps, and swaps.
  - name: Orders
    description: Create, track, and manage ramp orders.
  - name: Swaps
    description: Crypto-to-crypto swaps.
  - name: Sponsored
    description: Token approvals for sponsored (gasless) offramps.
  - name: Customers
    description: Customer (child-organization) records.
  - name: Wallets
    description: Register and manage customer wallets.
  - name: KYC
    description: Submit and check customer KYC status.
  - name: Webhooks
    description: Event notification subscriptions.
  - name: Organizations
    description: Organization identity, child orgs, and partner fees.
paths:
  /ramp/ws:
    get:
      tags:
        - WebSocket
      summary: Connect to the live update stream
      description: >-
        Opens a WebSocket that streams `order_updated` events for your
        organization. Authenticate with a token from `POST /ramp/ws-api-token`
        passed as the `token` query parameter; a browser cannot set an
        `Authorization` header on a WebSocket upgrade. The token is single-use
        and expires in 30 seconds. Each frame signals that an order changed;
        re-read the order with `GET /ramp/order/{order_id}` for the
        authoritative state, including any pending approval package. Connect
        over `wss` (for example `wss://api.etherfuse.com/ramp/ws?token=...`).
      operationId: ramp_ws_stream
      parameters:
        - name: token
          in: query
          required: true
          description: >-
            Single-use, org-scoped token from POST /ramp/ws-api-token. Expires
            in 30 seconds.
          schema:
            type: string
      responses:
        '101':
          description: >-
            Switching Protocols: the connection is upgraded to a WebSocket and
            streams order_updated events.
        '400':
          description: Missing token query parameter.
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key sent in the Authorization header.

````