openapi.yaml

openapi: 3.1.0
info:
  title: Dodex REST API
  description: Public REST API for the Dodex prediction-market exchange. See docs/api-spec.md for the long-form contract.
  version: 0.1.0
servers:
- url: https://api.dodex.example.com
paths:
  /api/v1/account:
    get:
      tags:
      - account
      summary: Account balances
      operationId: get_account
      parameters:
      - name: X-DODEX-APIKEY
        in: header
        description: API key issued by the Dodex backend.
        required: true
        schema:
          type: string
      - name: timestamp
        in: query
        description: Unix milliseconds. Included in the signed payload.
        required: true
        schema:
          type: integer
          format: int64
      - name: recvWindow
        in: query
        description: Request validity window in milliseconds. Default 5000, max 60000.
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int64
      - name: signature
        in: query
        description: Hex HMAC SHA-256 of canonicalQueryString + canonicalRequestBody.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with json format data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - apiKey: []
  /api/v1/account/balances:
    get:
      tags:
      - account
      summary: Market balances
      operationId: get_account_balances
      parameters:
      - name: X-DODEX-APIKEY
        in: header
        description: API key issued by the Dodex backend.
        required: true
        schema:
          type: string
      - name: timestamp
        in: query
        description: Unix milliseconds. Included in the signed payload.
        required: true
        schema:
          type: integer
          format: int64
      - name: recvWindow
        in: query
        description: Request validity window in milliseconds. Default 5000, max 60000.
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int64
      - name: signature
        in: query
        description: Hex HMAC SHA-256 of canonicalQueryString + canonicalRequestBody.
        required: true
        schema:
          type: string
      - name: predictionMarketAddress
        in: query
        description: Market address.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with json format data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketBalancesResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - apiKey: []
  /api/v1/accounts:
    post:
      tags:
      - account
      summary: Register a trading account
      operationId: register_account
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - pnAddress
              - pnPubkeyHex
              - pnSeckeyHex
              - pnDihHex
              properties:
                pnAddress:
                  type: string
                  description: Address of the deployed PrivateNote, `0:…`.
                pnDihHex:
                  type: string
                  description: deposit_identifier_hash, hex (≤256 bits).
                pnPubkeyHex:
                  type: string
                  description: Note owner public key, hex (≤256 bits).
                pnSeckeyHex:
                  type: string
                  description: Note owner secret key, 32-byte hex. Sealed under the KEK at rest.
              additionalProperties: false
        required: true
      responses:
        '200':
          description: Response with json format data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterAccountResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - {}
  /api/v1/inference/depth:
    get:
      tags:
      - inference-market-data
      summary: Inference order book depth
      operationId: get_inference_depth
      parameters:
      - name: inferenceOrderBookAddress
        in: query
        description: The model's order-book address.
        required: true
        schema:
          type: string
      - name: limit
        in: query
        description: Levels per side. Default 100, max 1000; out-of-range values clamp.
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int64
          maximum: 1000.0
          minimum: 1.0
      responses:
        '200':
          description: Response with json format data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InferenceDepthResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - {}
  /api/v1/inference/markets:
    get:
      tags:
      - inference-market-data
      summary: List inference markets
      operationId: get_inference_markets
      parameters:
      - name: inferenceOrderBookAddress
        in: query
        description: Single-market lookup. Mutually exclusive with filters and pagination.
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: producer
        in: query
        description: Filter by model producer.
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: status
        in: query
        description: Comma-separated statuses to include. Currently only TRADING.
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: sort
        in: query
        description: Sort field. createdAt (default, DESC).
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: cursor
        in: query
        description: Opaque pagination cursor from a previous call.
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: limit
        in: query
        description: Page size. Default 50, max 200; out-of-range values clamp.
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int64
          maximum: 200.0
          minimum: 1.0
      responses:
        '200':
          description: Response with json format data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InferenceMarketsResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - {}
  /api/v1/inference/orders:
    get:
      tags:
      - inference-market-data
      summary: List inference orders
      description: |-
        Unlike this file's other handlers, which use `non_empty_query` and treat a

        present-but-blank value as absent, this endpoint uses `non_blank_query` and rejects one

        with `-1102`. Deliberate: `tokenContract=` silently becoming "no TokenContract filter"

        would return the whole book and read as a confident answer to a question nobody asked.
      operationId: get_inference_orders
      parameters:
      - name: inferenceOrderBookAddress
        in: query
        description: The model's order-book address.
        required: true
        schema:
          type: string
      - name: tokenContract
        in: query
        description: Exact deal TokenContract. Mutually exclusive with `note`. Refused with -1500 (HTTP 503, retry) while the book has a live SELL whose TokenContract the indexer does not know.
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: note
        in: query
        description: Exact owning PrivateNote address. Mutually exclusive with `tokenContract`.
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: side
        in: query
        description: BUY or SELL.
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: status
        in: query
        description: 'Comma-separated: LIVE, FILLED, CANCELLED, EXPIRED. Default: all. LIVE means currently resting; EXPIRED means the book dropped it once its deadline passed.'
        required: false
        schema:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/InferenceOrderStatus'
        style: form
        explode: false
      - name: limit
        in: query
        description: Page size. Default 100, max 500; out-of-range values are rejected.
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int64
          maximum: 500.0
          minimum: 1.0
      - name: cursor
        in: query
        description: Keyset cursor from a previous call's nextCursor.
        required: false
        schema:
          type:
          - string
          - 'null'
      responses:
        '200':
          description: Response with json format data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InferenceOrdersResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - {}
  /api/v1/inference/trades:
    get:
      tags:
      - inference-market-data
      summary: Recent inference trades
      description: |-
        `limit` clamps rather than rejects, following this file's other handlers — unlike

        `/api/v1/prediction/trades`, whose contract refuses an out-of-range limit with -1102.
      operationId: get_inference_trades
      parameters:
      - name: inferenceOrderBookAddress
        in: query
        description: The model's order-book address.
        required: true
        schema:
          type: string
      - name: limit
        in: query
        description: Number of trades, newest first. Default 20, max 1000; out-of-range values clamp.
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int64
          maximum: 1000.0
          minimum: 1.0
      responses:
        '200':
          description: Response with json format data
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InferenceTradeDto'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - {}
  /api/v1/oracles:
    get:
      tags:
      - market-data
      summary: List oracles
      operationId: get_oracles
      parameters:
      - name: oracleAddress
        in: query
        description: Filter by oracle address.
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: eventId
        in: query
        description: Return only the event list containing this event id; events[] is narrowed to it.
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: deadlineBefore
        in: query
        description: Include only events with deadline < deadlineBefore (unix seconds).
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int64
      - name: cursor
        in: query
        description: Opaque pagination cursor returned from a previous page.
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: limit
        in: query
        description: Number of oracles. Default 50, max 200.
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int64
      responses:
        '200':
          description: Response with json format data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OraclesResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - {}
  /api/v1/prediction/batchOrders:
    post:
      tags:
      - trading
      summary: Submit a batch of orders atomically
      operationId: create_batch_orders
      parameters:
      - name: X-DODEX-APIKEY
        in: header
        description: API key issued by the Dodex backend.
        required: true
        schema:
          type: string
      - name: timestamp
        in: query
        description: Unix milliseconds. Included in the signed payload.
        required: true
        schema:
          type: integer
          format: int64
      - name: recvWindow
        in: query
        description: Request validity window in milliseconds. Default 5000, max 60000.
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int64
      - name: signature
        in: query
        description: Hex HMAC SHA-256 of canonicalQueryString + canonicalRequestBody.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchOrdersRequest'
        required: true
      responses:
        '200':
          description: Response with json format data
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BatchOrderResponseItem'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - apiKey: []
    delete:
      tags:
      - trading
      summary: Cancel a batch of orders atomically
      operationId: delete_batch_orders
      parameters:
      - name: X-DODEX-APIKEY
        in: header
        description: API key issued by the Dodex backend.
        required: true
        schema:
          type: string
      - name: timestamp
        in: query
        description: Unix milliseconds. Included in the signed payload.
        required: true
        schema:
          type: integer
          format: int64
      - name: recvWindow
        in: query
        description: Request validity window in milliseconds. Default 5000, max 60000.
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int64
      - name: signature
        in: query
        description: Hex HMAC SHA-256 of canonicalQueryString + canonicalRequestBody.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - predictionMarketAddress
              - symbol
              - orderIds
              properties:
                orderIds:
                  type: array
                  items:
                    type: string
                  description: Chain-assigned order ids, u64 decimal strings. Cancelled atomically; at most `outcome.maxBatchSize` ids.
                predictionMarketAddress:
                  type: string
                  description: Market address.
                symbol:
                  type: string
                  description: Outcome-token symbol shared by every id.
              additionalProperties: false
        required: true
      responses:
        '200':
          description: Response with json format data
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CancelBatchOrderResponseItem'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - apiKey: []
  /api/v1/prediction/buyFullSet:
    post:
      tags:
      - positions
      summary: Buy a full set of outcome tokens
      operationId: buy_full_set
      parameters:
      - name: X-DODEX-APIKEY
        in: header
        description: API key issued by the Dodex backend.
        required: true
        schema:
          type: string
      - name: timestamp
        in: query
        description: Unix milliseconds. Included in the signed payload.
        required: true
        schema:
          type: integer
          format: int64
      - name: recvWindow
        in: query
        description: Request validity window in milliseconds. Default 5000, max 60000.
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int64
      - name: signature
        in: query
        description: Hex HMAC SHA-256 of canonicalQueryString + canonicalRequestBody.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - predictionMarketAddress
              - collateral
              properties:
                collateral:
                  type: string
                  description: Quote-asset amount to spend, as a decimal string. Spent from the caller's free balance; any remainder that does not divide evenly is refunded.
                predictionMarketAddress:
                  type: string
                  description: Market address.
              additionalProperties: false
        required: true
      responses:
        '200':
          description: Response with json format data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuyFullSetResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - apiKey: []
  /api/v1/prediction/depth:
    get:
      tags:
      - market-data
      summary: Order book depth
      operationId: get_depth
      parameters:
      - name: predictionMarketAddress
        in: query
        description: Market address.
        required: true
        schema:
          type: string
      - name: symbol
        in: query
        description: Outcome-token symbol.
        required: true
        schema:
          type: string
      - name: limit
        in: query
        description: Levels per side. Default 100, max 1000; out-of-range values clamp.
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int64
          maximum: 1000.0
          minimum: 1.0
      responses:
        '200':
          description: Response with json format data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DepthResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - {}
  /api/v1/prediction/markets:
    get:
      tags:
      - market-data
      summary: List markets
      operationId: get_markets
      parameters:
      - name: predictionMarketAddress
        in: query
        description: Single-market lookup. Mutually exclusive with listing filters and pagination.
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: status
        in: query
        description: Comma-separated MarketStatus filter.
        required: false
        schema:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/MarketStatus'
        style: form
        explode: false
      - name: quoteAsset
        in: query
        description: Filter by quote asset symbol.
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: oracleName
        in: query
        description: Filter by oracle name.
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: resolvesFrom
        in: query
        description: Return only markets settled from this inference model's order book (its inferenceOrderBookAddress).
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: closingBefore
        in: query
        description: Return only markets with timings.resultEnd before this unix-seconds bound.
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int64
      - name: sort
        in: query
        description: 'Sort order: resultStart (default, ascending) or createdAt (descending).'
        required: false
        schema:
          allOf:
          - type: 'null'
          - $ref: '#/components/schemas/MarketsSort'
      - name: cursor
        in: query
        description: Opaque pagination cursor returned from a previous page.
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: limit
        in: query
        description: Page size. Default 50, max 200; out-of-range values clamp.
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int64
          maximum: 200.0
          minimum: 1.0
      responses:
        '200':
          description: Response with json format data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketsResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - {}
  /api/v1/prediction/order:
    post:
      tags:
      - trading
      summary: Submit a new order
      operationId: create_order
      parameters:
      - name: X-DODEX-APIKEY
        in: header
        description: API key issued by the Dodex backend.
        required: true
        schema:
          type: string
      - name: timestamp
        in: query
        description: Unix milliseconds. Included in the signed payload.
        required: true
        schema:
          type: integer
          format: int64
      - name: recvWindow
        in: query
        description: Request validity window in milliseconds. Default 5000, max 60000.
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int64
      - name: signature
        in: query
        description: Hex HMAC SHA-256 of canonicalQueryString + canonicalRequestBody.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrderRequest'
        required: true
      responses:
        '200':
          description: Response with json format data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateOrderResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - apiKey: []
    delete:
      tags:
      - trading
      summary: Cancel an order by orderId
      operationId: delete_order
      parameters:
      - name: X-DODEX-APIKEY
        in: header
        description: API key issued by the Dodex backend.
        required: true
        schema:
          type: string
      - name: timestamp
        in: query
        description: Unix milliseconds. Included in the signed payload.
        required: true
        schema:
          type: integer
          format: int64
      - name: recvWindow
        in: query
        description: Request validity window in milliseconds. Default 5000, max 60000.
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int64
      - name: signature
        in: query
        description: Hex HMAC SHA-256 of canonicalQueryString + canonicalRequestBody.
        required: true
        schema:
          type: string
      - name: predictionMarketAddress
        in: query
        description: Market address.
        required: true
        schema:
          type: string
      - name: symbol
        in: query
        description: Outcome-token symbol.
        required: true
        schema:
          type: string
      - name: orderId
        in: query
        description: Chain-assigned order id, u64 decimal string.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with json format data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelOrderResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - apiKey: []
  /api/v1/prediction/orders:
    get:
      tags:
      - trading
      summary: List orders
      operationId: get_orders
      parameters:
      - name: X-DODEX-APIKEY
        in: header
        description: API key issued by the Dodex backend.
        required: true
        schema:
          type: string
      - name: timestamp
        in: query
        description: Unix milliseconds. Included in the signed payload.
        required: true
        schema:
          type: integer
          format: int64
      - name: recvWindow
        in: query
        description: Request validity window in milliseconds. Default 5000, max 60000.
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int64
      - name: signature
        in: query
        description: Hex HMAC SHA-256 of canonicalQueryString + canonicalRequestBody.
        required: true
        schema:
          type: string
      - name: predictionMarketAddress
        in: query
        description: Market filter. Must pair with symbol when set.
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: symbol
        in: query
        description: Symbol filter. Must pair with predictionMarketAddress.
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: status
        in: query
        description: 'Comma-separated OrderStatus filter. PENDING_NEW and PENDING_CANCEL are not queryable. Default: all statuses.'
        required: false
        schema:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/QueryableOrderStatus'
        style: form
        explode: false
      - name: limit
        in: query
        description: Page size, 1..=500. Default 100.
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int64
          maximum: 500.0
          minimum: 1.0
      - name: cursor
        in: query
        description: Opaque pagination cursor.
        required: false
        schema:
          type:
          - string
          - 'null'
      responses:
        '200':
          description: Response with json format data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrdersPageResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - apiKey: []
  /api/v1/prediction/trades:
    get:
      tags:
      - market-data
      summary: Recent trades
      operationId: get_trades
      parameters:
      - name: predictionMarketAddress
        in: query
        description: Market address.
        required: true
        schema:
          type: string
      - name: symbol
        in: query
        description: Outcome-token symbol.
        required: true
        schema:
          type: string
      - name: limit
        in: query
        description: Number of trades, newest first. Default 20, max 1000.
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int64
          maximum: 1000.0
          minimum: 1.0
      responses:
        '200':
          description: Response with json format data
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TradeResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - {}
  /readiness:
    get:
      tags:
      - system
      summary: Readiness probe
      operationId: readiness
      responses:
        '200':
          description: Ok
          content:
            text/plain:
              schema:
                type: string
      security:
      - {}
components:
  schemas:
    AccountBalanceItem:
      type: object
      required:
      - asset
      - free
      - locked
      properties:
        asset:
          type: string
          description: Asset symbol.
        free:
          type: string
          description: Spendable amount, as a decimal string.
        locked:
          type: string
          description: Amount locked in open orders, as a decimal string.
    AccountResponse:
      type: object
      required:
      - accountId
      - updateTime
      - balances
      properties:
        accountId:
          type: string
          description: Account UUID.
        balances:
          type: array
          items:
            $ref: '#/components/schemas/AccountBalanceItem'
          description: Per-asset balances aggregated across all markets.
        updateTime:
          type: integer
          format: int64
          description: Unix milliseconds. When the balances snapshot was assembled.
    BatchOrderResponseItem:
      type: object
      required:
      - clientOrderId
      - transactTime
      - status
      properties:
        clientOrderId:
          type: string
          description: |-
            Echo of the item's `newOrderClientId`, or the backend-generated
            id when none was supplied.
        status:
          $ref: '#/components/schemas/OrderStatus'
        transactTime:
          type: integer
          format: int64
          description: Unix milliseconds. The moment the batch was accepted.
    BatchOrdersRequest:
      type: object
      required:
      - predictionMarketAddress
      - symbol
      - orders
      properties:
        orders:
          type: array
          items:
            $ref: '#/components/schemas/BatchOrdersRequestItem'
          description: |-
            Orders to place atomically. At most `outcome.maxBatchSize`
            items.
        predictionMarketAddress:
          type: string
          description: Market address.
        symbol:
          type: string
          description: Outcome-token symbol shared by every item.
    BatchOrdersRequestItem:
      type: object
      required:
      - side
      - quantity
      properties:
        newOrderClientId:
          type:
          - string
          - 'null'
          description: |-
            Client-supplied order id. Auto-generated by the backend when
            omitted.
        price:
          type:
          - string
          - 'null'
          description: Limit price as a decimal string. Required for `LIMIT` orders.
        quantity:
          type: string
          description: Order quantity as a decimal string.
        side:
          $ref: '#/components/schemas/OrderSide'
        timeInForce:
          allOf:
          - type: 'null'
          - $ref: '#/components/schemas/TimeInForce'
        type:
          allOf:
          - type: 'null'
          - $ref: '#/components/schemas/OrderType'
    BuyFullSetResponse:
      type: object
      required:
      - predictionMarketAddress
      - transactTime
      properties:
        predictionMarketAddress:
          type: string
          description: Echo of the request's `predictionMarketAddress`.
        transactTime:
          type: integer
          format: int64
          description: Unix milliseconds. The moment the request was accepted.
    CancelBatchOrderResponseItem:
      type: object
      required:
      - orderId
      - clientOrderId
      - transactTime
      - status
      properties:
        clientOrderId:
          type: string
          description: |-
            Id recorded at placement; empty string when the order was
            placed without a `newOrderClientId`.
        orderId:
          type: string
          description: Echo of the cancelled order's id.
        status:
          $ref: '#/components/schemas/OrderStatus'
        transactTime:
          type: integer
          format: int64
          description: Unix milliseconds. The moment the batch cancel was accepted.
    CancelOrderResponse:
      type: object
      required:
      - orderId
      - clientOrderId
      - transactTime
      - status
      properties:
        clientOrderId:
          type: string
          description: |-
            Id recorded at placement; empty string when the order was
            placed without a `newOrderClientId`.
        orderId:
          type: string
          description: Echo of the cancelled order's id.
        status:
          $ref: '#/components/schemas/OrderStatus'
        transactTime:
          type: integer
          format: int64
          description: Unix milliseconds. The moment the cancel was accepted.
    CancelReason:
      type: string
      description: |-
        Why a market was cancelled. Present only when `terminal.kind` is
        `CANCELLED`; `null` otherwise.
      enum:
      - PMP_REJECTED_BY_ORACLE
      - EVENT_CANCELLED
    CreateOrderRequest:
      type: object
      required:
      - predictionMarketAddress
      - symbol
      - side
      - quantity
      properties:
        newOrderClientId:
          type:
          - string
          - 'null'
          description: |-
            Client-supplied order id. Auto-generated by the backend when
            omitted.
        predictionMarketAddress:
          type: string
          description: Market address.
        price:
          type:
          - string
          - 'null'
          description: Limit price as a decimal string. Required for `LIMIT` orders.
        quantity:
          type: string
          description: Order quantity as a decimal string.
        side:
          $ref: '#/components/schemas/OrderSide'
        symbol:
          type: string
          description: Outcome-token symbol.
        timeInForce:
          allOf:
          - type: 'null'
          - $ref: '#/components/schemas/TimeInForce'
        type:
          allOf:
          - type: 'null'
          - $ref: '#/components/schemas/OrderType'
    CreateOrderResponse:
      type: object
      required:
      - clientOrderId
      - transactTime
      - status
      properties:
        clientOrderId:
          type: string
          description: |-
            Echo of `newOrderClientId`, or the backend-generated id when
            none was supplied.
        status:
          $ref: '#/components/schemas/OrderStatus'
        transactTime:
          type: integer
          format: int64
          description: Unix milliseconds. The moment the order was accepted.
    DepthResponse:
      type: object
      required:
      - predictionMarketAddress
      - symbol
      - lastUpdateId
      - bids
      - asks
      properties:
        asks:
          type: array
          items:
            type: array
            items:
              type: string
            maxItems: 2
            minItems: 2
          description: Price levels as [price, quantity] decimal-string pairs, best ask first.
        bids:
          type: array
          items:
            type: array
            items:
              type: string
            maxItems: 2
            minItems: 2
          description: Price levels as [price, quantity] decimal-string pairs, best bid first.
        lastUpdateId:
          type: string
          description: |-
            Opaque lex-comparable chain-order cursor; a larger string means
            a newer event has touched this `(predictionMarketAddress, symbol)`. Empty
            string when no order event has landed yet. Do not parse as an
            integer.
        predictionMarketAddress:
          type: string
          description: Market address.
        symbol:
          type: string
          description: Outcome-token symbol.
    ErrorBody:
      type: object
      required:
      - code
      - msg
      properties:
        code:
          type: integer
          format: int32
          description: |-
            Negative machine-readable error code. See docs/api-spec.md
            §Error Codes for the full table.
        msg:
          type: string
          description: Human-readable error message.
    EventDto:
      type: object
      required:
      - eventId
      - oracles
      properties:
        description:
          type:
          - string
          - 'null'
          description: |-
            User-facing description. Same confirmation caveat as
            `eventName`.
        eventId:
          type: string
          description: |-
            `0x`-prefixed uint256 hex digest, computed on-chain from the
            event metadata; identical across every oracle confirming the
            same event.
        eventName:
          type:
          - string
          - 'null'
          description: |-
            User-facing event title. `null` until at least one oracle
            confirmation has landed.
        oracles:
          type: array
          items:
            $ref: '#/components/schemas/OracleDto'
          description: |-
            One entry per oracle that confirmed this market. Empty when no
            confirmation has landed yet.
    InferenceDepthResponse:
      type: object
      required:
      - inferenceOrderBookAddress
      - lastUpdateId
      - bids
      - asks
      properties:
        asks:
          type: array
          items:
            type: array
            items:
              type: string
            maxItems: 2
            minItems: 2
          description: Price levels as [pricePerTick, ticks] decimal-string pairs, best ask first.
        bids:
          type: array
          items:
            type: array
            items:
              type: string
            maxItems: 2
            minItems: 2
          description: Price levels as [pricePerTick, ticks] decimal-string pairs, best bid first.
        contractVersion:
          type:
          - string
          - 'null'
          description: |-
            Version of the deployed order-book contract for this book; `null` when
            not yet known on chain.
        inferenceOrderBookAddress:
          type: string
        lastUpdateId:
          type: string
          description: Opaque lex-comparable chain-order cursor; empty when no order has landed.
    InferenceMarketDto:
      type: object
      required:
      - inferenceOrderBookAddress
      - model
      - status
      - quoteAsset
      - makerCommission
      - takerCommission
      - pricePrecision
      - quantityPrecision
      - tickSize
      - stepSize
      - minNotional
      - createdAt
      properties:
        contractVersion:
          type:
          - string
          - 'null'
          description: |-
            Version of the deployed order-book contract (e.g. `"4.0.30"`). Distinct
            from `model.version` (the AI model's own version). `null` when not yet
            known on chain.
        createdAt:
          type: integer
          format: int64
        inferenceOrderBookAddress:
          type: string
        makerCommission:
          type: string
          description: Signed decimal string; the seller rebate cap (negative).
        minNotional:
          type: string
        model:
          $ref: '#/components/schemas/InferenceModelDto'
        pricePrecision:
          type: integer
          format: int32
          minimum: 0.0
        quantityPrecision:
          type: integer
          format: int32
          minimum: 0.0
        quoteAsset:
          type: string
        referencePrice:
          type:
          - string
          - 'null'
          description: Weekly-median price per tick; `null` when the book has no recent liquidity.
        status:
          $ref: '#/components/schemas/InferenceMarketStatusDto'
        stepSize:
          type: string
        takerCommission:
          type: string
          description: Decimal string; the buyer fee `platform_fee_bps / 10000`.
        tickSize:
          type: string
    InferenceMarketStatusDto:
      type: string
      description: Reserved for future inactive states; clients treat it as opaque.
      enum:
      - TRADING
    InferenceMarketsResponse:
      type: object
      required:
      - serverTime
      - hasMore
      - markets
      properties:
        hasMore:
          type: boolean
        markets:
          type: array
          items:
            $ref: '#/components/schemas/InferenceMarketDto'
        nextCursor:
          type:
          - string
          - 'null'
        serverTime:
          type: integer
          format: int64
    InferenceModelDto:
      type: object
      required:
      - ref
      properties:
        name:
          type:
          - string
          - 'null'
        producer:
          type:
          - string
          - 'null'
        ref:
          type: string
          description: Canonical `producer--name--version`, or the model hash when unknown.
        version:
          type:
          - string
          - 'null'
    InferenceOrderDto:
      type: object
      required:
      - orderId
      - inferenceOrderBookAddress
      - side
      - price
      - ticks
      - ticksInitial
      - status
      properties:
        createdAt:
          type:
          - integer
          - 'null'
          format: int64
          description: |-
            Unix seconds, like every timestamp this API returns. `null` when the chain
            timestamp was not recovered — the row is served regardless.
        deadline:
          type:
          - string
          - 'null'
          description: |-
            `null` means no deadline is known to the indexer — either the chain has none, or it
            has one the read model has not recovered yet (subscriptions never publish theirs).
        inferenceOrderBookAddress:
          type: string
        note:
          type:
          - string
          - 'null'
        orderId:
          type: string
        price:
          type: string
        side:
          type: string
        status:
          type: string
        ticks:
          type: string
        ticksInitial:
          type: string
        tokenContract:
          type:
          - string
          - 'null'
          description: |-
            `null` on BUY orders and on rows whose TokenContract is not known to the indexer.
            A query filtering on `tokenContract` is refused while any live SELL of the book is
            in that state, so `null` here never hides a match.
        updatedAt:
          type:
          - integer
          - 'null'
          format: int64
    InferenceOrderStatus:
      type: string
      description: |-
        Order statuses accepted by the `GET /api/v1/inference/orders` `status` filter.
        `LIVE` means currently resting; see docs/api-spec.md §Inference Orders.
        Shapes the OpenAPI `status` parameter's allowed values; the handler passes the raw CSV
        query string to the application crate's parser rather than using this enum for logic.
      enum:
      - LIVE
      - FILLED
      - CANCELLED
      - EXPIRED
    InferenceOrdersResponse:
      type: object
      required:
      - serverTime
      - lastUpdateId
      - hasMore
      - orders
      properties:
        hasMore:
          type: boolean
        lastUpdateId:
          type: string
          description: |-
            `max(last_chain_order)` over the book. Covers chain-projected events only: the
            reconciler mutates rows without advancing it, so two snapshots sharing a
            `lastUpdateId` are not guaranteed identical.
        nextCursor:
          type:
          - string
          - 'null'
        orders:
          type: array
          items:
            $ref: '#/components/schemas/InferenceOrderDto'
        serverTime:
          type: integer
          format: int64
    InferenceTradeDto:
      type: object
      description: |-
        One public trade in the `GET /api/v1/inference/trades` tape. The endpoint returns a
        bare JSON array of these, newest first — no envelope, so unlike `/inference/depth`
        and `/inference/markets` the tape carries no `contractVersion`. A client that needs
        the book's contract generation reads it from `/api/v1/inference/markets`.
      required:
      - tradeId
      - price
      - qty
      - quoteQty
      - time
      - isBuyerMaker
      properties:
        isBuyerMaker:
          type: boolean
          description: |-
            `true` when the resting (maker) side was the buy order and the taker sold
            (downtick); `false` when the taker bought.
        price:
          type: string
          description: Clearing price per tick, scaled by the book's price precision.
        qty:
          type: string
          description: Matched tick count, scaled by the book's quantity precision.
        quoteQty:
          type: string
          description: |-
            Quote-asset notional (`price × qty`), scaled by the quote asset's on-chain
            `decimals`. This is the notional, not what the buyer paid: the book charges
            `price + tickFee(price)` per tick and reports that separately.
        time:
          type: integer
          format: int64
          description: Unix milliseconds. On-chain match time.
        tradeId:
          type: string
          description: |-
            Opaque, lex-comparable id for the match — the chain order of the
            `InferenceFilled` event that recorded it. Shared by both sides of the match.
    MarketBalancesResponse:
      type: object
      required:
      - predictionMarketAddress
      - updateTime
      - balances
      properties:
        balances:
          type: array
          items:
            $ref: '#/components/schemas/OutcomeBalanceItem'
          description: Per-outcome balances on this market.
        predictionMarketAddress:
          type: string
          description: Market address.
        updateTime:
          type: integer
          format: int64
          description: Unix milliseconds. When the balances snapshot was assembled.
    MarketDto:
      type: object
      required:
      - predictionMarketAddress
      - predictionOrderBookAddress
      - marketName
      - status
      - quoteAsset
      - tokenType
      - makerCommission
      - takerCommission
      - createdAt
      - event
      - outcomes
      properties:
        createdAt:
          type: integer
          format: int64
          description: Unix seconds. Market creation timestamp.
        event:
          $ref: '#/components/schemas/EventDto'
        makerCommission:
          type: string
          description: |-
            Maker fee rate as a signed decimal string. A negative value is
            a maker rebate credited to the maker.
        marketName:
          type: string
          description: |-
            Technical market name. Not the user-facing title; see
            `event.eventName`.
        outcomes:
          type: array
          items:
            $ref: '#/components/schemas/OutcomeDto'
          description: Outcome-token descriptors.
        predictionMarketAddress:
          type: string
          description: Stable market identifier.
        predictionOrderBookAddress:
          type: string
          description: |-
            Deterministic order-book address. Always present; trading
            availability depends on `status`.
        quoteAsset:
          type: string
          description: Quote-asset symbol for display.
        resolvesFrom:
          allOf:
          - type: 'null'
          - $ref: '#/components/schemas/ResolvesFromDto'
        status:
          $ref: '#/components/schemas/MarketStatus'
        takerCommission:
          type: string
          description: |-
            Taker fee rate as a decimal string, charged to the taker.
            Always non-negative.
        terminal:
          allOf:
          - type: 'null'
          - $ref: '#/components/schemas/TerminalDto'
        timings:
          allOf:
          - type: 'null'
          - $ref: '#/components/schemas/TimingsDto'
        tokenType:
          type: integer
          format: int32
          description: Numeric quote-asset token type.
    MarketStatus:
      type: string
      description: |-
        Market phase. A market is in exactly one of nine phases; see
        docs/api-spec.md §Market Status for the lifecycle.
      enum:
      - PENDING
      - UPCOMING
      - STAKING
      - AWAITING_FREEZE
      - TRADING
      - RESOLVING
      - RESOLVED
      - CANCELLED
      - EXPIRED
    MarketsResponse:
      type: object
      required:
      - serverTime
      - hasMore
      - markets
      properties:
        hasMore:
          type: boolean
          description: Whether more pages follow.
        markets:
          type: array
          items:
            $ref: '#/components/schemas/MarketDto'
          description: Markets matching the request.
        nextCursor:
          type:
          - string
          - 'null'
          description: |-
            Pagination cursor for the next page. `null` when `hasMore` is
            `false`.
        serverTime:
          type: integer
          format: int64
          description: |-
            Unix seconds. All timestamps in this response are unix seconds
            unless stated otherwise.
    MarketsSort:
      type: string
      description: |-
        Sort order for `GET /api/v1/prediction/markets`: `resultStart` ascending
        (default) or `createdAt` descending.
      enum:
      - resultStart
      - createdAt
    OracleDto:
      type: object
      properties:
        address:
          type:
          - string
          - 'null'
          description: Oracle contract address.
        fee:
          type:
          - string
          - 'null'
          description: Oracle fee for this confirmation, as a uint128 decimal string.
        name:
          type:
          - string
          - 'null'
          description: |-
            Oracle name. `null` if the oracle row has not been reconciled
            yet.
    OracleEntryDto:
      type: object
      required:
      - name
      - address
      - eventLists
      properties:
        address:
          type: string
        eventLists:
          type: array
          items:
            $ref: '#/components/schemas/OracleEventListDto'
        name:
          type: string
    OracleEventDto:
      type: object
      required:
      - eventId
      - eventName
      - oracleFee
      - deadline
      - outcomes
      properties:
        deadline:
          type: integer
          format: int64
        description:
          type:
          - string
          - 'null'
        eventId:
          type: string
        eventName:
          type: string
        oracleFee:
          $ref: '#/components/schemas/OracleFeeDto'
        outcomes:
          type: array
          items:
            $ref: '#/components/schemas/OracleOutcomeDto'
        trustAddress:
          type:
          - string
          - 'null'
    OracleEventListDto:
      type: object
      required:
      - index
      - address
      - description
      - events
      properties:
        address:
          type: string
        description:
          type: string
        events:
          type: array
          items:
            $ref: '#/components/schemas/OracleEventDto'
        index:
          type: integer
          format: int64
    OracleFeeDto:
      type: object
      required:
      - asset
      - amount
      properties:
        amount:
          type: string
        asset:
          type: string
    OracleOutcomeDto:
      type: object
      required:
      - outcomeId
      - outcomeName
      properties:
        outcomeId:
          type: integer
          format: int32
          minimum: 0.0
        outcomeName:
          type: string
    OraclesResponse:
      type: object
      required:
      - serverTime
      - hasMore
      - oracles
      properties:
        hasMore:
          type: boolean
        nextCursor:
          type:
          - string
          - 'null'
        oracles:
          type: array
          items:
            $ref: '#/components/schemas/OracleEntryDto'
        serverTime:
          type: integer
          format: int64
    OrderResponse:
      type: object
      required:
      - predictionMarketAddress
      - symbol
      - orderId
      - clientOrderId
      - price
      - origQty
      - executedQty
      - status
      - timeInForce
      - type
      - side
      - time
      - updateTime
      properties:
        clientOrderId:
          type: string
          description: Client-supplied id, or an empty string if absent.
        executedQty:
          type: string
          description: |-
            Filled quantity. Can be `> 0` for `CANCELED` orders that filled
            partially before cancellation.
        orderId:
          type: string
          description: |-
            Chain-side order id, u64 as a decimal string. Empty string for
            `REJECTED` orders.
        origQty:
          type: string
          description: |-
            Original order quantity, scaled by the outcome quantity
            precision.
        predictionMarketAddress:
          type: string
          description: Market address.
        price:
          type: string
          description: Limit price, scaled by the outcome price precision.
        side:
          $ref: '#/components/schemas/OrderSide'
        status:
          $ref: '#/components/schemas/OrderStatus'
        symbol:
          type: string
          description: Outcome-token symbol.
        time:
          type: integer
          format: int64
          description: Unix milliseconds. On-chain order creation time.
        timeInForce:
          $ref: '#/components/schemas/TimeInForce'
        type:
          $ref: '#/components/schemas/OrderType'
        updateTime:
          type: integer
          format: int64
          description: |-
            Unix milliseconds. On-chain time of the most recent book event
            that touched the order.
    OrderSide:
      type: string
      description: Order side.
      enum:
      - BUY
      - SELL
    OrderStatus:
      type: string
      description: |-
        Order lifecycle status. `PENDING_NEW` / `PENDING_CANCEL` are
        write-side acceptance states: they appear only in synchronous
        POST/DELETE responses, never in `GET /api/v1/prediction/orders` rows.
      enum:
      - PENDING_NEW
      - NEW
      - PARTIALLY_FILLED
      - PENDING_CANCEL
      - FILLED
      - CANCELED
      - REJECTED
    OrderType:
      type: string
      description: Order type. Defaults to `LIMIT` when omitted on order placement.
      enum:
      - LIMIT
      - MARKET
    OrdersPageResponse:
      type: object
      required:
      - orders
      properties:
        nextCursor:
          type:
          - string
          - 'null'
          description: |-
            Opaque pagination cursor. Pass back verbatim to fetch the next
            page; `null` when the last page has been returned.
        orders:
          type: array
          items:
            $ref: '#/components/schemas/OrderResponse'
          description: Orders matching the filter, most recently placed first.
    OutcomeBalanceItem:
      type: object
      required:
      - outcomeId
      - symbol
      - free
      - lockedInOrders
      properties:
        free:
          type: string
          description: Spendable outcome-token amount, as a decimal string.
        lockedInOrders:
          type: string
          description: Amount locked in open orders, as a decimal string.
        outcomeId:
          type: integer
          format: int32
          description: Stable outcome ID.
          minimum: 0.0
        symbol:
          type: string
          description: Outcome-token symbol.
    OutcomeDto:
      type: object
      required:
      - outcomeId
      - outcomeName
      - symbol
      - pricePrecision
      - quantityPrecision
      - tickSize
      - stepSize
      - minNotional
      - maxBatchSize
      properties:
        maxBatchSize:
          type: integer
          format: int32
          description: Maximum number of orders accepted in a single batch request.
          minimum: 0.0
        minNotional:
          type: string
          description: Minimum accepted notional value for an order.
        outcomeId:
          type: integer
          format: int32
          description: |-
            Stable outcome ID. Clients MUST use this field, not the array
            index.
          minimum: 0.0
        outcomeName:
          type: string
          description: Human-readable outcome name.
        pricePrecision:
          type: integer
          format: int32
          description: Maximum number of decimal places accepted for order prices.
          minimum: 0.0
        quantityPrecision:
          type: integer
          format: int32
          description: Maximum number of decimal places accepted for order quantities.
          minimum: 0.0
        stepSize:
          type: string
          description: Minimum quantity increment.
        symbol:
          type: string
          description: Outcome-token symbol used in trading and order-book requests.
        tickSize:
          type: string
          description: Minimum price increment.
    QueryableOrderStatus:
      type: string
      description: |-
        Order statuses accepted by the `GET /api/v1/prediction/orders` `status` filter.
        Excludes the write-side acceptance states `PENDING_NEW` /
        `PENDING_CANCEL`, which never appear in stored rows.
      enum:
      - NEW
      - PARTIALLY_FILLED
      - FILLED
      - CANCELED
      - REJECTED
    RegisterAccountResponse:
      type: object
      required:
      - accountId
      - pnAddress
      - apiKey
      - apiSecret
      - permissions
      properties:
        accountId:
          type: string
          description: UUID of the created account.
        apiKey:
          type: string
          description: Value for the `X-DODEX-APIKEY` header.
        apiSecret:
          type: string
          description: |-
            HMAC-SHA256 signing secret, hex. Returned once; never retrievable
            again.
        permissions:
          type: array
          items:
            type: string
          description: Granted permissions — `["USER_DATA", "TRADE"]`.
        pnAddress:
          type: string
          description: Echo of the registered PrivateNote address.
    ResolvesFromDto:
      type: object
      description: Inference-settlement linkage for a numeric range (token-price) market.
      required:
      - inferenceOrderBookAddress
      - metric
      properties:
        inferenceOrderBookAddress:
          type: string
          description: The `InferenceOrderBook` whose weekly-median price settles the outcome.
        metric:
          type: string
          description: Reference-price metric; currently always `WEEKLY_MEDIAN_PRICE`.
        model:
          type:
          - string
          - 'null'
          description: |-
            Model ref (`producer--model--version`); `null` until the inference book
            is reconciled (the market is not hidden on that account).
    TerminalDto:
      type: object
      description: |-
        How the market ended. The market's `terminal` is `null` while the
        market is alive and populated for the terminal statuses `RESOLVED`,
        `CANCELLED`, `EXPIRED`.
      required:
      - kind
      - at
      properties:
        at:
          type: integer
          format: int64
          description: Unix seconds. When the market entered the terminal state.
        cancelReason:
          allOf:
          - type: 'null'
          - $ref: '#/components/schemas/CancelReason'
        kind:
          $ref: '#/components/schemas/TerminalKind'
        resolvedOutcomeId:
          type:
          - integer
          - 'null'
          format: int32
          description: |-
            The winning outcome's `outcomeId`. Present only when `kind` is
            `RESOLVED`; `null` otherwise.
          minimum: 0.0
    TerminalKind:
      type: string
      description: How a market ended. Mirrors the terminal subset of `MarketStatus`.
      enum:
      - RESOLVED
      - CANCELLED
      - EXPIRED
    TimeInForce:
      type: string
      description: |-
        Time-in-force. Applies to `LIMIT` orders only; defaults to `GTC`
        when omitted on order placement.
      enum:
      - GTC
      - IOC
      - FOK
      - POST_ONLY
    TimingsDto:
      type: object
      description: |-
        Market lifecycle timestamps, all unix seconds. The market's
        `timings` is `null` while `status` is `PENDING`.
      required:
      - stakeStart
      - stakeEnd
      - resultStart
      - resultEnd
      properties:
        frozenAt:
          type:
          - integer
          - 'null'
          format: int64
          description: '`null` before the order book is active.'
        resultEnd:
          type: integer
          format: int64
        resultStart:
          type: integer
          format: int64
        stakeEnd:
          type: integer
          format: int64
        stakeStart:
          type: integer
          format: int64
    TradeResponse:
      type: object
      description: |-
        One public trade in the `GET /api/v1/prediction/trades` tape. The endpoint returns a
        bare JSON array of these, newest first.
      required:
      - tradeId
      - price
      - qty
      - quoteQty
      - time
      - isBuyerMaker
      properties:
        isBuyerMaker:
          type: boolean
          description: |-
            `true` when the resting (maker) side was the buy order and the taker
            sold (downtick); `false` when the taker bought.
        price:
          type: string
          description: Match (clearing) price, scaled by the outcome price precision.
        qty:
          type: string
          description: Matched quantity, scaled by the outcome quantity precision.
        quoteQty:
          type: string
          description: |-
            Quote-asset notional (`price × qty`), scaled by the quote asset's
            on-chain `decimals`.
        time:
          type: integer
          format: int64
          description: Unix milliseconds. On-chain match time.
        tradeId:
          type: string
          description: |-
            Opaque, lex-comparable id for the match. The `orderUpdate` stream is
            specified to surface this value as its `t` field (docs/api-spec.md).
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-DODEX-APIKEY
      description: API key issued by the Dodex backend. Signed requests also carry `timestamp`, `signature`, and an optional `recvWindow` as query parameters.