Balances Overview
Description
The Balances API group allows users to monitor and manage account balances in stablecoins like USDC and USDT across different blockchains. This group is essential for financial tracking, ensuring businesses have real-time visibility into available and pending funds for operational decisions.
API Endpoints
- Get Balance: Retrieves the balance details for a specific account and currency.
- List Balances: Returns a list of all balances associated with an account across chains and currencies.
API Endpoint Reference
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/balances/:id | Retrieves the balance details for a specific ID. |
| GET | /v1/balances | Lists all balances across chains and currencies. |
Attributes
| Attribute | Type | Description |
|---|---|---|
id | string | Unique identifier for the balance (e.g., bal_5). |
account_id | string | ID of the account associated with the balance. |
chain | string | Blockchain chain used (e.g., base). |
currency | string | Currency of the balance (e.g., USDC). |
available_balance | string | The amount of funds available for use (e.g., 1052.6). |
pending_balance | string | The amount of funds pending (e.g., 0.0). |
created_at | timestamp | Time when the balance record was created. |
updated_at | timestamp | Time when the balance record was last updated. |