Skip to main content
GET
/
api
/
v1
/
accounts
/
balance
curl -X GET "https://api.roxom.com/api/v1/accounts/balance" \
  -H "X-API-Key: your_api_key_here" \
  -H "X-API-Signature: your_rsa_signature_here"

{
  "data": {
    "available": "0.00125000",
    "balance": "0.00150000",
    "currency": "BTC"
  },
  "error": false
}

​
Get Account Balance

Retrieve current account balance including available balance and margin information.

​
Endpoint

GET /api/v1/accounts/balance

​
Parameters

​
X-API-Key
string
required
RSA public key identifier for authentication
​
X-API-Signature
string
required
Base64-encoded RSA signature of the request payload. Payload format: GET:/api/v1/accounts/balance
​
unit
string
Units for response values. Either “btc” or “sats”.
Default: sats

​
Example Request

curl -X GET "https://api.roxom.com/api/v1/accounts/balance" \
  -H "X-API-Key: your_api_key_here" \
  -H "X-API-Signature: your_rsa_signature_here"

​
Response

{
  "data": {
    "available": "0.00125000",
    "balance": "0.00150000",
    "currency": "BTC"
  },
  "error": false
}

​
Response Fields

​
data
object
Account balance information
​
error
boolean
Indicates if the request failed

​
Notes

  • All balance values are returned as strings to preserve precision
  • When unit=sats, values are in satoshis (1 BTC = 100,000,000 sats)
  • When unit=btc, values are in BTC decimal format
  • Available balance is the amount available for placing new orders
  • Total balance includes both available balance and margin used by open positions
⌘I