Orders

Real-time streaming updates to your open orders

Receive real-time streaming updates regarding open orders in your account through the WebSocket API.

• Authentication required. Please refer to the WebSocket Authentication page here for more details.

• Updates are inclusive of ALL open order changes including order acceptance, partial fills, changes to status (i.e. Filled or Canceled) and amendments.

Subscription Instructions

Feed Name
private.user.open-orders

Order Status Values

Value	Description
Started	The order is open on the marketplace waiting for fills
Cancel Pending	The order is in the process of being cancelled
Canceled	The order was successfully canceled
Filled	The order was partially filled
Done	The order was completed successfully

Example Code & Order Message

Message payload will contain a list of one or more order objects that contain the latest information on the order.

NodeJS

const WebSocket = require('ws')

const ws = new WebSocket('wss://ws.sfox.com/ws')

ws.on('open', function() {
  const authMessage = {
   type: 'authenticate',
   apiKey: '<API_KEY>',
  }
  
  ws.send(JSON.stringify(authMessage))
})

// After successful authentication, subscribe to open orders feed
const subscribeMsg = {
  type: 'subscribe',
  feeds: ['private.user.open-orders']
}

ws.send(JSON.stringify(subscribeMsg))

Python

import asyncio
import json

import websockets


async def main(uri):
    async with websockets.connect(uri) as ws:
        await ws.send(json.dumps({
            "type": "authenticate",
            "apiKey": "<API_KEY>"
        }))

        # After successful authentication message, subscribe to the open orders feed
        await ws.send(json.dumps({
            "type": "subscribe",
            "feeds": ["private.user.open-orders"]
        }))
        async for msg in ws:
            print(msg)


asyncio.run(main("wss://ws.sfox.com/ws"))

Example Message

{
  "sequence": 5,
  "recipient": "private.user.open-orders",
  "timestamp": 1649903305545835513,
  "payload": [{
    "id": 693291242,
    "client_order_id": "577ab261-9dfc-415a-ba61-a54a18c1942c",
    "date_added": "2023-11-14T22:08:53.000Z",
    "status": "Started",
    "filled": "0.00035333",
    "filled_amount": "14.61628778",
    "vwap": "41367.24246455",
    "price": "37227.82",
    "quantity": "0.05",
    "pair": "btcusd",
    "action": "Sell",
    "type": "TWAP",
    "algorithm_id": 307,
    "fees": "0.02850176"
  }]
}