sFOX API
Sign InOpen Account
sFOX API
sFOX API
  • Introduction
    • Welcome
    • Getting Started
    • Systems & Operations
    • Rate Limits
  • REST API
    • REST Endpoints
    • Authentication
    • Rate Limits
    • Account Management
      • Get All Balances
      • Get All Currencies
      • Get All Currency Pairs
      • Get All Transactions
      • Get Fees
    • Orders
      • Order Types
      • Create Order
      • Cancel Order
      • Cancel Multiple Orders
      • Cancel All Orders
      • Amend Order
      • Get Single Order
      • Get All Open Orders
      • Get All Done Orders
      • Get All Trades
    • Request for Quote (RFQ)
    • Post-Trade Settlement (PTS)
      • Get Account Risk Metrics
      • Get All Positions
      • Get All Funding Transactions
      • Get All Funding Rates
      • Get All Risk Modes
      • Create Transfer
    • Shorting
      • Get Account Risk Metrics
      • Get All Positions
    • Transfers
      • Get All Deposit Addresses
      • Get Single Deposit Address
      • Create Deposit Address
      • Deposit From Bank Account
      • Withdraw From Account
      • Get Single Withdrawal Fee
      • Create Transfer
    • Custody (sFOX SAFE)
      • Get Whitelisted Addresses
      • Add Whitelisted Address
      • Delete Whitelisted Address
      • Get Approval Rules
      • Create Approval Rule
      • Edit Approval Rule
      • Get Approval Requests
      • Respond to Approval Request
    • Staking
      • Get Staking Currencies
      • Get All Staking Transactions
      • Create Stake
      • Cancel Stake
      • Unstake
    • Market Data
      • Get Candlesticks
      • Get Volume Analytics
      • Get Order Estimate
      • Get Order Book
    • Reporting
      • Get Orders Report
      • Get Monthly Summary
      • Get Portfolio Valuation
      • Get All Transactions
  • WebSocket API
    • Introduction
    • Connecting
    • Rate Limits
    • Authentication
    • Subscribing & Unsubscribing
    • Message Format
    • Market Data
      • Order Book
      • Trades
      • Ticker
    • Orders & Account Data
      • Orders
      • Trades
      • Balances
      • Post-Trade Settlement
  • FIX API
    • FIX Order Entry
    • FIX Market Data
    • QuickFIX Guide
  • Errors
    • Error Codes
Powered by GitBook
On this page
  • Subscribing
  • Post-Trade Settlement Message
  • Example Code & Post-Trade Settlement Message
  1. WebSocket API
  2. Orders & Account Data

Post-Trade Settlement

PreviousBalancesNextFIX Order Entry

Last updated 7 months ago

Receive real-time updates to your account's credit and risk metrics.

Refer to the for more information regarding risk management and risk metrics for Post-Trade Settlement (note: you may be asked to sign in to your sFOX account before being redirected to the support center)

Subscribing

Feed name

private.user.post-trade-settlement

// Request -> post-trade settlement feed
{
    "type": "subscribe", 
    "feeds": ["private.user.post-trade-settlement"]
}

The initial response payload will include a snapshot of your account's current credit and risk metric data.

Post-Trade Settlement Message

Messages are only sent when a transaction is executed. However, please note that asset price changes may impact your risk metrics.

Post-Trade Settlement Object

Key
Type
Description

enabled

boolean

Boolean whether post-trade settlement is enabled for your account

equity

string

Collateralization–The "liquidation value" of your portfolio–the USD value of your assets if all of your holdings were converted to USD.

equity_for_withdrawals

string

Your "Free Equity." The portion of your Equity that could be removed from your account (e.g. for a withdrawal) without triggering liquidation.

exposure

string

Your current total net open position (NOP) across currencies/markets–the USD value of your positions pending settlement.

available_exposure

string

Credit available before hitting your Exposure Limit.

exposure_limit

string

The maximum USD value of your total net open positions (NOPs) across currencies/markets.

liquidation_level

string

If your Equity Level drops below this level, your positions will be partially settled automatically.

Post-Trade Settlement Message

// Post-trade settlement message
{
    "sequence": 3,
    "recipient": "private.user.post-trade-settlement",
    "timestamp": 1727392002153041890,
    "payload": {
        "enabled": true,
        "equity": "81306152.88083515",
        "equity_for_withdrawals": "81286273.68856692",
        "exposure": "0",
        "available_exposure": "250000",
        "exposure_limit": "250000",
        "liquidation_level": "0.1"
    }
}

Example Code & Post-Trade Settlement Message

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))
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"))
Support Center