Balances

Current project balances per available asset.

GET/project/balances

System information

API key: Required
Rate limit: ∞

curl "https://api.atomic.wallet/api/v1/project/balances" \
  -H "x-api-key: $API_KEY"

{
  "items": [
    {
      "coinCode": "USDT",
      "networkCode": "tron",
      "coinName": "Tether USD",
      "networkName": "TRON",
      "networkPrefix": "TRC-20",
      "decimals": 6,
      "image": "https://storage.example.com/coins/usdt.svg",
      "balanceAmount": "10.00000000",
      "availableAmount": "10.00000000",
      "confirmedAmount": "10.00000000",
      "pendingAmount": "0.00000000",
      "reservedAmount": "0.00000000"
    }
  ]
}

Response fields

Parameter	Type	Description
items	array	Balances by coin and network.
items[].coinCode	string	Cryptocurrency code.
items[].networkCode	string	Blockchain network code.
items[].coinName	string	Cryptocurrency name.
items[].networkName	string	Network name.
items[].networkPrefix	string	Token standard in the network, for example `TRC-20`.
items[].decimals	integer	Number of decimal places for amounts.
items[].image	string	Coin icon URL.
items[].balanceAmount	string	Total balance.
items[].availableAmount	string	Amount available for withdrawal.
items[].confirmedAmount	string	Confirmed balance.
items[].pendingAmount	string	Amount awaiting confirmations.
items[].reservedAmount	string	Amount reserved for withdrawals.

Field	Description
`coinCode`	Cryptocurrency code.
`networkCode`	Blockchain network code.
`coinName`	Cryptocurrency name.
`networkName`	Network name.
`networkPrefix`	Network label, for example `TRC-20`, `ERC-20`.
`decimals`	Number of decimal places.
`image`	Asset icon.
`balanceAmount`	Total balance.
`availableAmount`	Amount available for use.
`confirmedAmount`	Confirmed amount.
`pendingAmount`	Amount of pending operations.
`reservedAmount`	Reserved amount.

For debits, rely on availableAmount. If it is not enough for a withdrawal, the API returns WITHDRAWAL_BALANCE_INSUFFICIENT.

← PreviousProject details Next →Overview