Skip to main content

List Balances

This endpoint allows to list balances.

Authorization:

bearer

HTTP: bearer

HTTP Authorization Scheme: bearer

Headers:
Authorization: APIKey {YOUR_API_KEY}

Endpoint

GET

/api/v2/balances

Query parameters​

  • page (integer): The page number to retrieve. Default is 1.
  • limit (integer): The number of records to retrieve per page. Default is 10.
  • accountId (string): Account Id.
  • coin (string): , usd, btc, eth, ltc, xrp, usdt, usdc.

Responses​

{
"data": [
{
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"accountId": "00000000-0000-0000-0000-000000000000",
"coin": "usd",
"available": 1250.75,
"incomingPending": 500.00,
"outgoingPending": 100.25,
"createdAt": "2025-04-07T15:32:01.411Z",
"updatedAt": "2025-04-07T15:32:01.411Z"
},
{
"id": "aaaaaaaa-bbbb-cccc-dddd-ffffffffffff",
"accountId": "00000000-0000-0000-0000-000000000000",
"coin": "btc",
"available": 0.05432100,
"incomingPending": 0.00000000,
"outgoingPending": 0.01000000,
"createdAt": "2025-04-07T15:32:01.411Z",
"updatedAt": "2025-04-07T15:32:01.411Z"
}
],
"page": 1,
"limit": 10,
"total": 4
}

Response Schema​

FieldTypeDescription
pageintCurrent page number.
limitintNumber of items per page.
totalintTotal number of balances.
dataarrayList of balances.
data[].idstring (uuid)Unique balance ID.
data[].accountIdstring (uuid)Account ID.
data[].coinstringCoin identifier (e.g., btc, usd, usdc).
data[].availabledecimalAvailable balance.
data[].incomingPendingdecimalIncoming pending balance.
data[].outgoingPendingdecimalOutgoing pending balance.
data[].createdAtstring (datetime)Timestamp of creation (ISO 8601).
data[].updatedAtstring (datetime)Timestamp of last update (ISO 8601).

Support and Resources​

If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.

Stay Updated​

Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:

We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!