Get All Balances

GET https://api.sfox.com/v1/user/balance

Retrieve your account balances by currency. Results include an array of objects, each of which has details for a single currency.

Rate Limit: 5 requests per 10 seconds

sFOX recommends using the Balances WebSocket feed instead, which allows you to receive all balance changes in real-time, and does not count towards your request limit.

Response Body

Key	Description
currency	The currency
balance	The total balance of this currency in your account across all wallets outlined below
available	The portion of the balance that is available for trading or withdrawals
held	Potion of the balance that is currently on hold and unavailable for trading or withdrawals (i.e. an ACH deposit that has yet to settle)
borrow_wallet	Amount of the currency , represented as the borrow wallet balance
collateral_wallet	Amount of the current being held as collateral in your collateral wallet
lending_wallet	Amount of the currency in your lending wallet
trading_wallet	Amount of the currency in your trading wallet

Responses

200

[
  {
    "currency":"btc",
    "balance": 1,
    "available": 1,
    "held": 0,
    "borrow_wallet": 0,
    "collateral_wallet": 0,
    "lending_wallet": 0,
    "trading_wallet": 1
  },
  {
    "currency":"usd",
    "balance": 100,
    "available": 90,
    "held": 10,
    "borrow_wallet": 0,
    "collateral_wallet": 0,
    "lending_wallet": 0,
    "trading_wallet": 100
  }
]

Example Requests

Shell

curl -H 'Authorization: Bearer <API_TOKEN>' 
-H 'Content-Type: application/json' \
-X GET \
'https://api.sfox.com/v1/user/balance'

NodeJS

const axios = require('axios');

axios({
  method: 'get',
  url: 'https://api.sfox.com/v1/user/balance',
  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/user/balance",
  headers={
    "Authorization": "Bearer <API_KEY>",
  }
)
print(data)