Wallets
The Wallets API allows you to manage digital wallets linked to users or companies. It supports creating, retrieving, and organizing wallet data across different asset types and blockchain networks. Use this API to track balances, transactions, and wallet configurations securely and efficiently.
Get Balances
Use Case
This endpoint retrieves your account balances across all supported currencies. It provides real-time visibility into your available funds, making it useful for dashboards and ensuring sufficient funds before initiating transactions.
Get Balances Response
This is the standard shape of a balances response returned by the API.
Indicates whether the API request was successful.
A human-readable message describing the result of the request.
The unique identifier of the company whose balances are being retrieved.
A list of account objects, each representing a balance for a specific currency.
A unique identifier for the currency-specific account.
The company account number shared across all currency accounts.
The currency of the account (e.g., USDT, USDC, BTC).
The total balance recorded on the ledger. Values are fixed to 6 decimal places for stablecoins (USDT, USDC) and 8 decimal places for BTC.
The balance available for use. Uses the same decimal precision rules as ledger_balance (6 decimals for stablecoins, 8 for BTC).
A human-readable version of the ledger balance including the currency symbol.
A human-readable version of the available balance including the currency symbol.
The ISO 8601 timestamp indicating when the account was created.
A unique identifier for this API request, useful for debugging and support.
The ISO 8601 timestamp showing when the response was generated.
Get Balance By Currency
Use Case
This endpoint retrieves your account balance for a specific currency. Use it to check available funds in a particular wallet (e.g., BTC, USD, USDT) before initiating transfers or for currency-specific reporting.
Path Parameters
The currency code to retrieve the balance for (e.g., 'BTC', 'USDT', 'USDC').
Get Balance By Currency Response
This is the standard shape of a single currency balance response returned by the API.
Indicates whether the API request was successful.
A human-readable message describing the result of the request.
The account number associated with your company.
The currency code for this balance (e.g., 'USDT', 'USDC', 'BTC').
The total balance in the account, including pending amounts.
The balance available for immediate use (total minus pending).
The amount currently held in pending transactions.
The timestamp (ISO 8601 format) indicating when this balance snapshot was taken.
The unique identifier of the company whose balance is being retrieved.
A unique identifier for this specific API request, useful for debugging and support.
The timestamp (ISO 8601 format) when the response was generated.