OX.FUN
TradeSupport
  • 🏠OX.FUN
  • OX.FUN DOCS
    • 📈Perps
    • 📊Strategies
    • 🐂OX Coin
    • 🍂Seasons
    • 📩Referral
  • Page
  • API
    • ⚙️OX FUN API
    • 🔑API Key Management
    • ☁️Websocket API
      • Authentication
      • Session Keep Alive
      • Order Commands
        • Place Limit Order
        • Place Market Order
        • Place Stop Limit Order
        • Place Stop Market Order
        • Place Batch Market Order
        • Cancel Order
        • Cancel Batch Order
        • Modify Order
        • Modify Batch Orders
      • Subscriptions - Private
        • Balance Channel
        • Position Channel
        • Order Channel
          • Order Opened
          • Order Closed
          • Order Closed Failure
          • Order Modified
          • Order Modified Failure
          • Order Matched
      • Subscriptions - Public
        • Fixed Size Order Book
        • Full Order Book
        • Incremental Order Book
        • Best Bid/Ask
        • Trade
        • Ticker
        • Candles
        • Liquidation RFQ
        • Market
      • Other Responses
      • Error Codes
        • Curl Error Codes
    • 🔌REST API V3
      • Account & Wallet - Private
      • Deposits & Withdrawals - Private
      • Market Data - Public
      • Orders - Private
      • Trades - Private
  • 🔗External
    • 💧Aerodrome Pool
    • 🔵Trade on Uniswap (Base)
    • Trade on Solana
    • 🦎CoinGecko
    • API Code Examples
  • 🔗SOCIALS
    • 🐂OX.FUN
    • Discord
    • Twitter
Powered by GitBook
On this page
  1. API
  2. Websocket API
  3. Subscriptions - Private
  4. Order Channel

Order Matched

OrderMatched message format

{
  "table": "order", 
  "data": [
      {
          "accountId": "<Your account ID>",
          "clientOrderId": "1680044888401",
          "orderId": "1000021937814",
          "price": "27282.73",
          "quantity": "0.004",
          "amount": "0.0",
          "side": "BUY",
          "status": "FILLED", 
          "marketCode": "BTC-USD-SWAP-LIN",
          "timeInForce": "GTC",
          "timestamp": "1680044888565",
          "matchId": "300016799886154670",
          "matchPrice": "27279.39",
          "matchQuantity": "0.001",
          "orderMatchType": "TAKER",
          "remainQuantity": "0.0",
          "limitPrice": "27282.73",
          "notice": "OrderMatched",
          "orderType": "LIMIT",
          "fees": "0.019095573", 
          "feeInstrumentId": "USDT",
          "isTriggered": "false",
          "displayQuantity": "0.004"
      }
  ]
}

Channel Update Fields

Fields
Type
Required

table

STRING

order

data

LIST of dictionary

notice

STRING

OrderMatched

accountId

STRING

Account identifier

clientOrderId

STRING

Client assigned ID to help manage and identify orders with max value 9223372036854775807

orderId

STRING

Unique order ID from the exchange

price

STRING

Limit price submitted (only applicable for LIMIT order types)

stopPrice

STRING

Stop price submitted (only applicable for STOP order types)

limitPrice

STRING

Limit price submitted

quantity

STRING

Order quantity submitted

amount

STRING

"0.0" if not provided in the request

side

STRING

BUY or SELL

status

STRING

FILLED or PARTIAL_FILL

marketCode

STRING

Market code i.e. BTC-USD-SWAP-LIN

timeInForce

STRING

Client submitted time in force (only applicable for LIMIT and STOP LIMIT order types)

timestamp

STRING

Millisecond timestamp of order match

matchID

STRING

Exchange match ID

matchPrice

STRING

Match price of order from this match ID

matchQuantity

STRING

Match quantity of order from this match ID

orderMatchType

STRING

MAKER or TAKER

remainQuantity

STRING

Remaining order quantity

orderType

STRING

  • LIMIT

  • MARKET

triggered STOP_LIMIT and STOP_MARKET orders are converted to LIMIT and MARKET orders respectively

fees

STRING

Amount of fees paid from this match ID

feeInstrumentId

STRING

Instrument ID of fees paid from this match ID

isTriggered

STRING

False (or True for STOP order types)

triggerType

STRING

Stops are triggered on MARK_PRICE

displayQuantity

STRING

Quantity displayed in the book, primarily used for iceberg orders, otherwise echos the quantity field

PreviousOrder Modified FailureNextSubscriptions - Public

Last updated 6 months ago

☁️