Retrieve wallet
Retrieve a single wallet using its unique id.
You can retrieve wallets in multiple ways:
- By wallet
ID- This will retrieve a specific wallet. - Retrieve all wallets - This will retrieve all wallets.
- By the
identifier- This will retrieve wallets by theidentifier - By the
userId- This will retrieve all wallets of a specific user.
1. Get a wallet by id
idRequest Endpoint: reference
GET /api/wallets/{id}
| Parameter | Param Type | Description | Data Type | Mandatory |
|---|---|---|---|---|
{id} | path | The wallet id | String | ✅ |
Response Body
{
"success": true,
"result": {
"id": "96d7f016-a062-4d29-9e37-94b9765bc08a",
"address": "0x40b8aDCbe02dfDEb032F55bEc278892c6397D4ca",
"walletType": "API_WALLET",
"secretType": "MATIC",
"createdAt": "2024-01-08T10:16:47.553371",
"archived": false,
"description": "Waste Wallet",
"primary": false,
"hasCustomPin": false,
"userId": "a69e4d35-b931-466b-a943-d1d0934bcf71",
"custodial": false,
"balance": {
"available": true,
"secretType": "MATIC",
"balance": 0,
"gasBalance": 0,
"symbol": "MATIC",
"gasSymbol": "MATIC",
"rawBalance": "0",
"rawGasBalance": "0",
"decimals": 18
}
}
}
2. Get all wallets
Request Endpoint: reference
GET /api/wallets
Response Body
{
"success": true,
"pagination": {
"pageNumber": 1,
"pageSize": 10,
"numberOfPages": 1,
"numberOfElements": 2,
"hasNextPage": true,
"hasPreviousPage": false
},
"result": [
{
"id": "5a65042e-26ad-44f3-bbd0-379bddd84df1",
"address": "0x19c5042aB91C9e4C0C92Cbb6DEEb959a3e13306f",
"walletType": "API_WALLET",
"secretType": "ETHEREUM",
"createdAt": "2024-08-27T12:40:35.393118",
"archived": false,
"description": "My Wallet",
"primary": false,
"hasCustomPin": false,
"userId": "c7d70857-61a2-4466-86bd-0f7eb70b7497",
"custodial": false,
"balance": {
"available": true,
"secretType": "ETHEREUM",
"balance": 0.022759964407303897,
"gasBalance": 0.022759964407303897,
"symbol": "ETH",
"gasSymbol": "ETH",
"rawBalance": "22759964407303897",
"rawGasBalance": "22759964407303897",
"decimals": 18,
"exchange": {
"usdPrice": 3245.2285830021005,
"usdBalanceValue": 73.86128704269306
}
}
},
{
"id": "a7185cb1-66ec-41c7-94e3-be7a7e17ee67",
"address": "0xF8e6A6F31DD0d8B907BfBB4237F69147AcAEFBE2",
"walletType": "API_WALLET",
"secretType": "MATIC",
"createdAt": "2024-08-26T12:19:07.846501",
"archived": false,
"description": "My Wallet",
"primary": false,
"hasCustomPin": false,
"userId": "c7d70857-61a2-4466-86bd-0f7eb70b7497",
"custodial": false,
"balance": {
"available": true,
"secretType": "MATIC",
"balance": 0.009474999998803,
"gasBalance": 0.009474999998803,
"symbol": "POL",
"gasSymbol": "POL",
"rawBalance": "9474999998803000",
"rawGasBalance": "9474999998803000",
"decimals": 18,
"exchange": {
"usdPrice": 0.4484462572346971,
"usdBalanceValue": 0.004249028286761965
}
}
}
]
}
3. Get wallets by identifier
identifierRequest Endpoint: reference
GET /api/wallets
| Parameter | Param Type | Description | Data Type | Mandatory |
|---|---|---|---|---|
identifier | Query | Identifier to fetch a single or group of wallets | String | ✅ |
Response Body
{
"success": true,
"result": [
{
"id": "96d7f016-a062-4d29-9e37-94b9765bc08a",
"address": "0x40b8aDCbe02dfDEb032F55bEc278892c6397D4ca",
"walletType": "API_WALLET",
"secretType": "MATIC",
"createdAt": "2024-01-08T10:16:47.553371",
"archived": false,
"description": "Waste Wallet",
"primary": false,
"hasCustomPin": false,
"userId": "a69e4d35-b931-466b-a943-d1d0934bcf71",
"custodial": false,
"balance": {
"available": true,
"secretType": "MATIC",
"balance": 0,
"gasBalance": 0,
"symbol": "MATIC",
"gasSymbol": "MATIC",
"rawBalance": "0",
"rawGasBalance": "0",
"decimals": 18
}
},
{
"id": "f21dc1e5-4253-487e-8927-3b5247437f99",
"address": "0x8fC378e105F80d340489B28519cfEDaF8ecE1944",
"walletType": "API_WALLET",
"secretType": "MATIC",
"createdAt": "2024-01-08T10:15:22.044877",
"archived": false,
"description": " NFT Wallet",
"primary": false,
"hasCustomPin": false,
"userId": "a69e4d35-b931-466b-a943-d1d0934bcf71",
"custodial": false,
"balance": {
"available": true,
"secretType": "MATIC",
"balance": 0.2,
"gasBalance": 0.2,
"symbol": "MATIC",
"gasSymbol": "MATIC",
"rawBalance": "200000000000000000",
"rawGasBalance": "200000000000000000",
"decimals": 18
}
}
]
}
4. Get wallets by userId
userIdRequest Endpoint: reference
GET /api/wallets
| Parameter | Param Type | Description | Data Type | Mandatory |
|---|---|---|---|---|
userId | Query | Filter wallets by user ID | String | ✅ |
Response Body
{
"success": true,
"result": [
{
"id": "96d7f016-a062-4d29-9e37-94b9765bc08a",
"address": "0x40b8aDCbe02dfDEb032F55bEc278892c6397D4ca",
"walletType": "API_WALLET",
"secretType": "MATIC",
"createdAt": "2024-01-08T10:16:47.553371",
"archived": false,
"description": "Waste Wallet",
"primary": false,
"hasCustomPin": false,
"userId": "a69e4d35-b931-466b-a943-d1d0934bcf71",
"custodial": false,
"balance": {
"available": true,
"secretType": "MATIC",
"balance": 0,
"gasBalance": 0,
"symbol": "MATIC",
"gasSymbol": "MATIC",
"rawBalance": "0",
"rawGasBalance": "0",
"decimals": 18
}
},
{
"id": "f21dc1e5-4253-487e-8927-3b5247437f99",
"address": "0x8fC378e105F80d340489B28519cfEDaF8ecE1944",
"walletType": "API_WALLET",
"secretType": "MATIC",
"createdAt": "2024-01-08T10:15:22.044877",
"archived": false,
"description": " NFT Wallet",
"primary": false,
"hasCustomPin": false,
"userId": "a69e4d35-b931-466b-a943-d1d0934bcf71",
"custodial": false,
"balance": {
"available": true,
"secretType": "MATIC",
"balance": 0.2,
"gasBalance": 0.2,
"symbol": "MATIC",
"gasSymbol": "MATIC",
"rawBalance": "200000000000000000",
"rawGasBalance": "200000000000000000",
"decimals": 18
}
}
]
}
Updated 11 days ago