Get Account Risk Metrics

GET https://api.sfox.com/v1/post-trade-settlement

Returns your account's current Post-Trade Settlement risk metrics

Response Body

Key	Description
exposure	Current USD value of credit used
available_exposure	USD value of credit available
exposure_limit	Credit limit
equity	Current USD value of your holdings
equity_for_withdrawals	The USD value of your portfolio that is available for withdrawals

Responses

200

{
    "exposure": 1000378.13,
    "available_exposure":1999489.96,
    "exposure_limit":2000000.00,
    "equity": 100221.12,
    "equity_for_withdrawals":8000.42
}

403: Forbidden

//Your account does not have access to Post-Trade Settlement
{
    "error": "post trade settlement disabled"
}

Example Requests

Shell

curl -H 'Authorization: Bearer <API_TOKEN>' \
https://api.sfox.com/v1/post-trade-settlement

NodeJS

const axios = require('axios');

axios({
  method: 'get',
  url: 'https://api.sfox.com/v1/post-trade-settlement',
  headers: {
    'Authorization': 'Bearer <API_KEY>'
  }
}).then(response => {
  console.log(response)
}).catch(err => {
  console.error(err)
});

Python

import requests

data = requests.get(
  "https://api.sfox.com/v1/post-trade-settlement",
  headers={
    "Authorization": "Bearer <API_KEY>",
  }
)
print(data)