Post-Trade Settlement

Real-time streaming account post-trade settlement credit and risk updates

WebSocket feed streaming real-time updates to your account's post-trade settlement credit and risk metrics. Initial snapshot will provide a list of all post trade settlement data and then any updates to the data list will be sent.

This WebSocket feed is only applicable if your account has post-trade settlement enabled

Subscription Instructions

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

Feed Name
private.user.post-trade-settlement

Payload Details

Key	Description
enabled	Boolean whether post-trade settlement is enabled for your account
equity	Current USD value of your account balances
equity_for_withdrawals	Current USD value of the portion of equity that may be withdrawn from the platform
exposure	Current USD value of the amount borrowed (USD value of negative balances)

Example Code & Post-Trade Settlement Message

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 balances feed
const subscribeMsg = {
  type: 'subscribe',
  feeds: ['private.user.post-trade-settlement']
}

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
        await ws.send(json.dumps({
            "type": "subscribe",
            "feeds": ["private.user.post-trade-settlement"]
        }))
        async for msg in ws:
            print(msg)


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

Example Message

{
  "sequence": 5,
  "recipient": "private.user.post-trade-settlement",
  "timestamp": 1649904683386939438,
  "payload": {
    "enabled": true,
    "equity": "1490.6565764794957288",
    "equity_for_withdrawals": "0",
    "exposure": "1602.79628688",
    "available_exposure": "3397.20371312",
    "exposure_limit": "5000"
  }
}