List Wallets
This endpoint returns a list of all wallets available to the authenticated user, providing a unified view of all wallet resources.
GET
/wallets
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Maximum number of wallets to return (default: 20, max: 100) |
offset | integer | No | Number of wallets to skip (for pagination, default: 0) |
Authentication
This endpoint requires authentication using one of the following methods:
| Authentication Type | Header | Description |
|---|---|---|
| OAuth 2.0 | Authorization | Bearer your_access_token |
| API Key | X-API-Key | your_api_key |
Response
A successful response returns a list of wallet objects, each with the following properties:
| Field | Type | Description |
|---|---|---|
id | string | Unique wallet identifier |
name | string | User-defined name for the wallet |
blockchain | string | Blockchain type (ETH, BSC, TRX, SOL) |
address | string | Blockchain address for the wallet |
is_cold_wallet | boolean | Whether this is a cold wallet |
balance | number | Current balance of the wallet |
token | string | Token type, typically USDT |
last_check | string | ISO 8601 timestamp of the last balance check |
created_at | string | ISO 8601 timestamp of wallet creation |
updated_at | string | ISO 8601 timestamp of last wallet update |
Example Request
GET /wallets?limit=10&offset=0
X-API-Key: your_api_key
Example Response
[
{
"id": "b5f1e5a0-6a7b-4c3d-8a2e-7f8d9e0b1c2d",
"name": "ETH Hot Wallet",
"blockchain": "ETH",
"address": "0x1234567890abcdef1234567890abcdef12345678",
"is_cold_wallet": false,
"balance": 1000.0,
"token": "USDT",
"last_check": "2025-04-19T12:34:56.789Z",
"created_at": "2025-01-01T00:00:00.000Z",
"updated_at": "2025-04-19T12:34:56.789Z"
},
{
"id": "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",
"name": "ETH Storage Wallet",
"blockchain": "ETH",
"address": "0xabcdef1234567890abcdef1234567890abcdef12",
"is_cold_wallet": false,
"balance": 500.0,
"token": "USDT",
"last_check": "2025-04-19T12:34:56.789Z",
"created_at": "2025-01-02T00:00:00.000Z",
"updated_at": "2025-04-19T12:34:56.789Z"
}
]
Error Codes
| Status Code | Error Code | Description |
|---|---|---|
| 401 | unauthorized | Authentication failed |
| 403 | forbidden | User doesn't have required permissions |
| 500 | server_error | Internal server error |
Notes
- Each wallet is uniquely identified by its ID.
- Wallet balances are updated periodically via blockchain synchronization.
- Use pagination parameters (limit and offset) for efficient retrieving of large wallet lists.
- Cold wallets are typically used for long-term storage with enhanced security measures.