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

# Realtime session

> Mint a short-lived WebSocket URL for live trade, balance and PnL frames across your tracked wallets.

The returned `wsUrl` embeds a ticket valid for about 60 seconds — fetch a fresh session before each connect rather than caching the URL. With no tracked wallets you get a 200 with an empty `wsUrl` and a note, not an error. Requires `tracker.read`.



## OpenAPI

````yaml https://www.oceanx.trade/api/v1/openapi.json get /api/v1/tracker/realtime/session
openapi: 3.1.0
info:
  title: OceanX Developer API
  version: 1.0.0
  description: >-
    Public API for the OceanX trading platform. Currently in beta and free to
    use while in beta.


    This spec covers the **spot quote** domain. The wallet **tracker** and
    **perps** domains are documented at https://docs.oceanx.trade/api/overview
    and are not yet described here.
  contact:
    url: https://docs.oceanx.trade
  termsOfService: https://www.oceanx.trade/legal/terms
  license:
    name: Proprietary
    url: https://www.oceanx.trade/legal/terms
servers:
  - url: https://www.oceanx.trade
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Market Data
    description: Read-only OceanX market context sourced and cached by VM producers.
  - name: Spot
    description: >-
      Executable Solana swap quotes off OceanX's own router, and the exit
      checker that reports whether a whole position can be sold.
  - name: Callouts
    description: >-
      Public token callouts — user-posted token calls with live click/volume
      attribution stats. Read-only.
paths:
  /api/v1/tracker/realtime/session:
    get:
      tags:
        - Tracker
      summary: Realtime session
      description: >-
        Mint a short-lived WebSocket URL for live trade, balance and PnL frames
        across your tracked wallets.


        The returned `wsUrl` embeds a ticket valid for about 60 seconds — fetch
        a fresh session before each connect rather than caching the URL. With no
        tracked wallets you get a 200 with an empty `wsUrl` and a note, not an
        error. Requires `tracker.read`.
      operationId: createTrackerRealtimeSession
      parameters:
        - name: group
          in: query
          schema:
            type: string
      responses:
        '200':
          description: A ticketed WebSocket URL.
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: Requests allowed per window.
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Requests left.
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Unix seconds when the window resets.
          content:
            application/json:
              schema:
                type: object
                required:
                  - wsUrl
                  - wallets
                  - expiresInSeconds
                properties:
                  wsUrl:
                    type: string
                    description: >-
                      Connect within `expiresInSeconds`. Empty when nothing is
                      tracked.
                  wallets:
                    type: array
                    items:
                      type: string
                  expiresInSeconds:
                    type: integer
                    example: 60
                  note:
                    type: string
        '400':
          description: Failed validation before reaching the engine.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, malformed or revoked API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The key is valid but lacks the required scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited. Honour `Retry-After`.
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: Requests allowed per window.
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Requests left.
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Unix seconds when the window resets.
            Retry-After:
              schema:
                type: integer
              description: Seconds to wait.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: The routing engine is unreachable or timed out. Retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Stable machine-readable code. Branch on this, not the message.
              example: no_route
            message:
              type: string
              description: Human-readable detail. May change.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An OceanX API key, created in the app under Settings → Developer API.
        Send it as `Authorization: Bearer ox_live_…`. These endpoints require
        the `md.read` scope, which is on every key by default.

````