Skip to main content

Get my balances

Retrieves all asset balances for the currently authenticated user.
This endpoint returns the balances of all assets (tokens) associated with the user's wallets.

⚠️ API key authentication is not supported

πŸ“˜ Learn more about natural units of measure and Sparks.

Request Endpoint:

GET /odata/v1.0/Balances/My

Parameters​

This method does not require parameters in the path or body.
You can optionally use OData query options to filter or paginate the results.

ParameterTypeDescription
$filterstringOptional. Filters the balances using supported operators (eq, in).
$skipintegerOptional. Skips a specified number of records (useful for pagination).

Example Request:​

GET /Balances/My?$filter=UniqueAssetId eq '0x7bc575105b40df19721a0001'&$skip=10

Response Body​

application/json β€” Returns a list of balances for the user’s addresses and assets.

ParameterDescription
AddressThe wallet address associated with the balance.
UniqueAssetIdThe unique identifier of the asset (token).
AmountThe amount of the specified asset held in the address.

Example Response Body:​

In EVM-compatible networks (e.g., Sparknet, Ethereum, and Polygon), the "Address" and is 42 characters long. In non-EVM networks, the address length may differ. For example, on Internet Computer, it is 63 characters.

[
{
"Address": "0xc873ba6a2b45f7b2cd733c3983bd53ec6e2a05df",
"UniqueAssetId": "0x7bc575105b40df19721a0001",
"Amount": "25000"
}
]

Response Codes​

CodeDescription
200Balances successfully retrieved.
401Unauthorized β€” user authentication required.