The Wallets API enables viewing system-wide wallet stats, listing all system wallets, managing external wallets for users, and creating new wallets.
Returns the total balances of all system wallets (HOT, COLD, CUSTODIAL), grouped by network and currency.
Wallet stats retrieved successfully
{- "api_message": "WALLET_GET_STATS_SUCCESS",
- "api_data": {
- "timestamp": 1750236930535,
- "data": {
- "property1": {
- "property1": {
- "HOT": 0,
- "COLD": 0,
- "CUSTODIAL": 0
}, - "property2": {
- "HOT": 0,
- "COLD": 0,
- "CUSTODIAL": 0
}
}, - "property2": {
- "property1": {
- "HOT": 0,
- "COLD": 0,
- "CUSTODIAL": 0
}, - "property2": {
- "HOT": 0,
- "COLD": 0,
- "CUSTODIAL": 0
}
}
}
}
}Retrieves a list of all system-level wallets by network and currency.
Wallets retrieved successfully
{- "api_message": "WALLET_GET_LIST_SUCCESS",
- "api_data": {
- "timestamp": 0,
- "data": {
- "property1": [
- {
- "id": "string",
- "label": "string",
- "currency": "string",
- "network": "string",
- "mainnet": true,
- "type": "string",
- "address": "string",
- "balance": {
- "total": "string",
- "spendable": "string"
}, - "tokens": [
- null
]
}
], - "property2": [
- {
- "id": "string",
- "label": "string",
- "currency": "string",
- "network": "string",
- "mainnet": true,
- "type": "string",
- "address": "string",
- "balance": {
- "total": "string",
- "spendable": "string"
}, - "tokens": [
- null
]
}
]
}
}
}Creates a new external wallet for a user.
Wallet created successfully
{- "account_id": "string",
- "address": "bc1q3aqj5aye9ktg7a2hslyuzu5szv4j32cnr67yhh",
- "name": "bit",
- "currency": "BTC",
- "currency_id": "eGFCV203K3VSOGM9",
- "description": "_"
}{- "api_message": "WALLET_POST_SUCCESS",
- "api_data": {
- "wallet": {
- "id": "string",
- "address": "string",
- "name": "string",
- "currency": "string",
- "currency_id": "string",
- "description": "string",
- "user_id": "string",
- "ip": "string",
- "created_by_id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}Retrieves a list of wallets associated with the authenticated user.
User wallets retrieved successfully
{- "api_message": "WALLET_GET_LIST_SUCCESS",
- "api_data": {
- "wallets": [
- {
- "id": "string",
- "user_id": "string",
- "provider_id": "string",
- "external_wallet_id": "string",
- "address": "string",
- "name": "string",
- "description": "string",
- "protocol": "string",
- "currency": "string",
- "currency_id": "string",
- "ip": "string",
- "created_by_id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}