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

# Authorize a private realtime channel subscription

> Authorizes a Pusher/Ably client to subscribe to `private-orders-{organisationId}` for push updates on your own orders (opened, filled, cancelled, rejected). The channel name must exactly match your organisation's own channel — subscribing to another organisation's channel is rejected with 403.




## OpenAPI

````yaml /xentfi-pro/openapi.json post /v1/orderbook/realtime/auth
openapi: 3.0.3
info:
  title: XentFi Pro API
  version: 1.0.0
  description: >-
    API documentation for XentFi Pro — programmatic liquidity and trading on
    XentFi's hybrid off-chain matching / on-chain settlement order book.
    Requires a Pro account and an API key with the Trade scope. See the XentFi
    Pro Overview and Authentication guides in this tab before making requests.
  contact:
    name: XentFi Pro Support
    email: support@xentfi.com
servers:
  - url: https://api.pro.xentfi.com
    description: XentFi Pro production server
security: []
tags:
  - name: OrderBook
    description: Place, list, cancel, and inspect orders and their fills.
  - name: OrderBook Markets
    description: Market configuration, order book depth, trades, ticker, and candles.
  - name: OrderBook Settlement
    description: Inspect on-chain settlement batches produced from matched trades.
  - name: OrderBook Ops
    description: Engine health/status and realtime (websocket) channel authorization.
paths:
  /v1/orderbook/realtime/auth:
    post:
      tags:
        - OrderBook Ops
      summary: Authorize a private realtime channel subscription
      description: >
        Authorizes a Pusher/Ably client to subscribe to
        `private-orders-{organisationId}` for push updates on your own orders
        (opened, filled, cancelled, rejected). The channel name must exactly
        match your organisation's own channel — subscribing to another
        organisation's channel is rejected with 403.
      operationId: authorizeRealtimeChannel
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                socket_id:
                  type: string
                channel_name:
                  type: string
              required:
                - socket_id
                - channel_name
      responses:
        '200':
          description: Channel authorization signature (Pusher auth response format)
          content:
            application/json:
              schema:
                type: object
                properties:
                  auth:
                    type: string
        '400':
          description: Missing socket_id or channel_name
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Not authorized to subscribe to the requested channel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
          OrgIdAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: NOT_FOUND
            message:
              type: string
              example: Wallet not found
            timestamp:
              type: string
              format: date-time
            requestId:
              type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: apiKey
    OrgIdAuth:
      type: apiKey
      in: header
      name: orgId

````