Retrieving Wallets
Retrieve a user's wallets, look up a wallet ID by currency, or fetch one wallet's details.
This guide explains how to retrieve wallet information using three key endpoints. These endpoints allow you to get an overview of all user wallets, search for wallet IDs by currency, or retrieve detailed information about specific wallets. They are ideal for integrating with financial dashboards, managing wallets in systems, or supporting automated trading and analytics tools.
Endpoint overview
| Endpoint | Description |
|---|---|
GET /public/accounts | Retrieve a list of all wallets, including empty ones, with optional pagination and filtering. |
GET /public/accounts/ids | Fetch the wallet IDs associated with a specific currencyCode. |
GET /public/accounts/{id} | Retrieve detailed information about a specific wallet using its unique system-generated id. |
Retrieve a List of Accounts
This endpoint retrieves a list of user wallets. By default, it returns all wallets, including empty ones. You can customize the response using optional query parameters (see Pagination). For example, you can specify the query params paged=true and currencyCode=EUR to filter results.
Request
GET /public/accounts/?paged=true¤cyCode=BTCResponse
{
"content": [
{
"id": "a7fa2a73-25ec-4023-9585-d76edce81020",
"currencyCode": "EUR",
"label": null,
"hideBalance": false,
"hideIfEmpty": false,
"ibanInfo": {
"iban": "DE89370400440532013000",
"institutionAddress": "1234 Bank Street, Berlin, Germany",
"institutionName": "Bank of Ethereum",
"status": "ACTIVE",
"swiftCode": "DEUTDEFF"
},
"availableBalance": "10.00000000000000000",
"reservedBalance": "0.000000000000000000",
"totalBalance": "10.00000000000000000",
"sortIndex": 0,
"isCurrencyNewlySupported": false
}
],
"pageable": {
"sort": {
"sorted": false,
"empty": true,
"unsorted": true
},
"pageSize": 20,
"pageNumber": 0,
"offset": 0,
"paged": true,
"unpaged": false
},
"totalPages": 1,
"totalElements": 1,
"last": true,
"number": 0,
"size": 20,
"numberOfElements": 1,
"sort": {
"sorted": false,
"empty": true,
"unsorted": true
},
"first": true,
"empty": false
}Response will contain ibanInfo if the corresponding wallet currencyCode is EUR and the account has an associated IBAN (otherwise ibanInfo will be null). The "status": "ACTIVE" is applied after the client claims the IBAN. The status changes to "CLOSED" if the client requests to close the IBAN.
IBAN (International Bank Account Number)It is an international format used to identify accounts at financial institutions. With a personal IBAN account, users can make deposits to and withdrawals from their accounts. Read more about IBANs.
Retrieve Wallet ID by Currency Code
ID by Currency CodeUse this endpoint to fetch the id or ids of wallets associated with a specific currencyCode. This is a lightweight alternative to the /public/accounts endpoint when only the wallet id is needed.
Request:
GET /api/public/accounts/ids?currencyCode=BTCResponse:
[
"df0cbbec-1e98-495e-9543-08a3c2e343ed"
]If an incorrect or unsupported currencyCode is specified, the response will be an empty array [].
Retrieve Wallet Details by Unique ID
This endpoint retrieves detailed information about a specific wallet using its unique system-generated id. You can obtain this id from the previous two endpoints.
Request:
GET /public/accounts/df0cbbec-1e98-495e-9543-08a3c2e343edResponse:
{
"id": "df0cbbec-1e98-495e-9543-08a3c2e343ed",
"currencyCode": "BTC",
"label": null,
"hideBalance": false,
"hideIfEmpty": false,
"ibanInfo": null,
"availableBalance": "2.01034093",
"reservedBalance": "0",
"totalBalance": "2.01034093",
"sortIndex": 0,
"isCurrencyNewlySupported": false
}Updated about 1 hour ago