WhiteBit Place Margin Stop-BBO Order

asyncapi: 3.0.0
info:
  title: WhiteBit Place Margin Stop-BBO Order
  version: 1.0.0
  description: |
    Place a margin or futures stop order that becomes a BBO order.

    The order waits as `type` `9` with `price` `"0"`, then prices itself from the order book
    when the trigger fires.
  x-auth-required: true
  x-rate-limits:
    connections-per-minute: 1000
    order-placements-per-10-seconds: 10000
  x-error-codes:
    - code: 19
      message: market is not margin market
      description: "The method was called on a spot-only market. Use the spot `order_*` equivalent there."
    - code: 1
      message: bbo role must be an integer in range 1..2
      description: "The `bbo_role` value is outside `1`–`2`, or is not an integer."
    - code: 101
      message: activation price should not be equal to the last price
      description: "The activation price equals the current last price. Move the trigger to either side of it."
    - code: 251
      message: activation price is out of bands
      description: "The activation price falls outside the market price bands."
    - code: 12
      message: not enough traders
      description: "The order book has no quote on the required side at activation, so the order cannot be priced and is dropped."
    - code: 116
      message: margin order with reduce only is rejected
      description: "The order carries `reduce_only` but nothing is open on that side."
    - code: 114
      message: order's position side does not match user's setting
      description: "`position_side` was sent (as non-`BOTH`) without hedge mode enabled, or was omitted or sent as `BOTH` while hedge mode is enabled, or otherwise does not match the account setting."

servers:
  production:
    host: wss.whitebit.com
    protocol: wss
    description: WhiteBIT Global Server
  eu:
    host: api.whitebit.eu
    protocol: wss
    description: WhiteBIT EU Server

channels:
  /ws:
    address: /ws
    description: Margin and futures stop-BBO order placement channel
    messages:
      collateralOrderStopBboPlaceRequest:
        $ref: '#/components/messages/collateralOrderStopBboPlaceRequest'
      collateralOrderStopBboPlaceResponse:
        $ref: '#/components/messages/collateralOrderStopBboPlaceResponse'

operations:
  sendCollateralOrderStopBboPlaceRequest:
    action: receive
    channel:
      $ref: '#/channels/~1ws'
    messages:
      - $ref: '#/channels/~1ws/messages/collateralOrderStopBboPlaceRequest'

  receiveCollateralOrderStopBboPlaceResponse:
    action: send
    channel:
      $ref: '#/channels/~1ws'
    messages:
      - $ref: '#/channels/~1ws/messages/collateralOrderStopBboPlaceResponse'

components:
  messages:
    collateralOrderStopBboPlaceRequest:
      name: CollateralOrderStopBboPlaceRequest
      title: Place margin stop-BBO order
      summary: Place a margin or futures stop order that becomes a BBO order
      payload:
        $ref: '#/components/schemas/CollateralOrderStopBboPlaceRequest'
      examples:
        - name: collateralOrderStopBboPlaceMakerSell
          summary: |
            Place a maker-role sell stop order with parameters:
            - params[0]: order object with market, side, amount, activation_price, and bbo_role
          payload:
            id: 500015
            method: collateral_order_stop_bbo_place
            params:
              - market: BTC_PERP
                side: sell
                amount: "0.001"
                activation_price: "63385.76"
                bbo_role: 1
                stp: "no"

    collateralOrderStopBboPlaceResponse:
      name: CollateralOrderStopBboPlaceResponse
      title: Place Margin Stop-BBO Order Response
      summary: Accepted conditional order, price resolved on activation
      payload:
        $ref: '#/components/schemas/CollateralOrderStopBboPlaceResponse'
      examples:
        - name: collateralOrderStopBboPlaceAccepted
          summary: Order waiting for the trigger with price "0" and post_only set by the maker role
          payload:
            id: 500015
            result:
              id: 2423735891508
              market: BTC_PERP
              type: 9
              side: 1
              post_only: true
              ioc: false
              reduce_only: false
              position_side: BOTH
              ctime: 1786452692.6124389
              mtime: 1786452692.6124389
              activation_price: "63385.76"
              activation_condition: lte
              activated: 0
              price: "0"
              amount: "0.001"
              left: "0.001"
              deal_stock: "0"
              deal_money: "0"
              deal_fee: "0"
              client_order_id: ""
              stp: "no"
              status: OPEN
            error: null

  schemas:
    CollateralOrderStopBboPlaceRequest:
      type: object
      required:
        - id
        - method
        - params
      properties:
        id:
          type: integer
          description: Unique request identifier. The response echoes this value.
        method:
          type: string
          const: collateral_order_stop_bbo_place
          description: "Method name. Fixed value: `collateral_order_stop_bbo_place`."
        params:
          type: array
          minItems: 1
          maxItems: 1
          items:
            $ref: '#/components/schemas/CollateralOrderStopBboPlaceParams'
          description: Array containing exactly one order parameter object

    CollateralOrderStopBboPlaceParams:
      type: object
      required:
        - market
        - side
        - amount
        - activation_price
        - bbo_role
      properties:
        market:
          type: string
          description: "Margin or futures market name. A spot-only market is rejected with error `19`."
          example: BTC_PERP
        side:
          type: string
          enum: ["buy", "sell"]
          description: "Order side. The response reports the side numerically: `1` for sell, `2` for buy."
        amount:
          type: string
          description: "Order size in stock, at the market stock precision."
          example: "0.001"
        activation_price:
          type: string
          description: "Trigger price, validated against the market price bands. Outside them the call returns error `251`."
          example: "63385.76"
        bbo_role:
          type: integer
          enum: [1, 2]
          description: "Pricing role applied at activation. `1` maker — price at the own-side best and set `post_only`. `2` taker — price at the opposite-side best."
        reduce_only:
          type: boolean
          description: "Restrict the order to shrinking an existing position."
        position_side:
          type: string
          enum: ["BOTH", "LONG", "SHORT"]
          description: "Position leg in hedge mode; futures markets only. `BOTH` in one-way mode. Optional at the request layer but functionally required in hedge mode — omitting it, or sending `BOTH`, is rejected with error `114`."
        client_order_id:
          type: string
          description: "Custom client order id, echoed on the response. Must be unique among active orders — a collision returns error `43`."
        stp:
          type: string
          enum: ["no", "co", "cn", "cb"]
          description: "Self-trade prevention mode applied to the order created on activation. Defaults to `no` when omitted."

    CollateralOrderStopBboPlaceResponse:
      type: object
      required:
        - id
        - result
        - error
      properties:
        id:
          type: integer
          description: Request identifier matching the request
        result:
          type: object
          description: "Accepted conditional order reporting `type` `9` with `price` `\"0\"`, because the price is resolved from the order book only when the trigger fires."
        error:
          type: "null"
          description: Error object (null on success)