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,
"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
}
},
{
"id": "bc47154b-a313-43d2-a0b2-87631174c117",
"address": "0x584376B6E1aA5e6194e2c8f56535eDdfB8Ab9b5a",
"walletType": "API_WALLET",
"secretType": "MATIC",
"createdAt": "2024-01-08T11:36:42.05778",
"archived": false,
"description": "Waste Wallet",
"primary": false,
"hasCustomPin": false,
"userId": "0c18cd73-bbc7-4c88-9f31-67387a7749c6",
"custodial": false,
"balance": {
"available": true,
"secretType": "MATIC",
"balance": 0,
"gasBalance": 0,
"symbol": "MATIC",
"gasSymbol": "MATIC",
"rawBalance": "0",
"rawGasBalance": "0",
"decimals": 18
}
},
{
"id": "aef4eb80-6cfd-4e11-8de9-0282c9a203ba",
"address": "0x6531b2fc27b5115540113E0e06b4654f5DbD4c98",
"walletType": "API_WALLET",
"secretType": "BSC",
"createdAt": "2024-01-08T12:01:28.558292",
"archived": false,
"description": "Waste Wallet",
"primary": false,
"hasCustomPin": false,
"userId": "0c18cd73-bbc7-4c88-9f31-67387a7749c6",
"custodial": false,
"balance": {
"available": true,
"secretType": "BSC",
"balance": 0,
"gasBalance": 0,
"symbol": "BNB",
"gasSymbol": "BNB",
"rawBalance": "0",
"rawGasBalance": "0",
"decimals": 18
}
},
{
"id": "e9115c09-2d9c-49b9-a1d4-1923e59aeac0",
"address": "0.0.7477648",
"walletType": "API_WALLET",
"secretType": "HEDERA",
"createdAt": "2024-01-08T12:01:38.796353",
"archived": false,
"description": "Waste Wallet",
"primary": false,
"hasCustomPin": false,
"userId": "0c18cd73-bbc7-4c88-9f31-67387a7749c6",
"custodial": false,
"balance": {
"available": true,
"secretType": "HEDERA",
"balance": 0,
"gasBalance": 0,
"symbol": "HBAR",
"gasSymbol": "HBAR",
"rawBalance": "0",
"rawGasBalance": "0",
"decimals": 8
}
},
{
"id": "250332c2-6d74-48bb-ac2b-03ade04ed20f",
"address": "0xe7Ddf6f4Ae122CdBdDFb465bBDC203fef91d0B66",
"walletType": "API_WALLET",
"secretType": "ETHEREUM",
"createdAt": "2024-01-09T10:55:17.798769",
"archived": false,
"description": "Waste Wallet",
"primary": false,
"hasCustomPin": false,
"userId": "0c18cd73-bbc7-4c88-9f31-67387a7749c6",
"custodial": false,
"balance": {
"available": true,
"secretType": "ETHEREUM",
"balance": 0,
"gasBalance": 0,
"symbol": "ETH",
"gasSymbol": "ETH",
"rawBalance": "0",
"rawGasBalance": "0",
"decimals": 18
}
}
]
}
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 6 months ago