Skip to main content

Wallets

Wallets are blockchain wallets belonging to an account. Each wallet is associated with a chain and can be assigned to one or more networks. Wallets hold balances in native and token currencies.

Wallet Model

FieldTypeDescription
idstring (UUID)Unique wallet identifier
namestringWallet name
account_idstring (UUID)Parent account ID
chain_idstring (UUID)Chain this wallet operates on
addressstringBlockchain address
custody_wallet_idstring (UUID)Internal custody wallet reference
typestringWallet type (see below)
statusintegerWallet status (see below)
created_atstring (ISO 8601)Creation timestamp
updated_atstring (ISO 8601)Last update timestamp
deleted_atstring (ISO 8601) | nullSoft deletion timestamp

Wallet Types

ValueDescription
hotHot wallet -- connected to the network, used for frequent transactions
coldCold wallet -- offline storage, used for long-term asset security

Wallet Statuses

ValueLabel
1Active
2Passive

Wallet with Networks

When listing wallets, each wallet includes its assigned networks with balance information:

{
"id": "...",
"name": "My Wallet",
"networks": [
{
"id": "...",
"name": "Ethereum Mainnet",
"network_id": 1,
"chain_id": "...",
"native_currency": {
"id": "...",
"name": "ETH",
"symbol": "ETH",
"decimals": 18,
"address": null,
"logo_url": null,
"balance": "1.5"
}
}
]
}

Wallet Detail

When fetching a single wallet, the response includes full balance details for all currencies on each network:

{
"id": "...",
"name": "My Wallet",
"networks": [
{
"id": "...",
"name": "Ethereum Mainnet",
"network_id": 1,
"chain_id": "...",
"native_currency": {
"id": "...",
"name": "ETH",
"symbol": "ETH",
"decimals": 18,
"balance": "1.5"
},
"currencies": [
{
"id": "...",
"name": "USD Coin",
"symbol": "USDC",
"decimals": 6,
"address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"logo_url": "https://example.com/usdc.png",
"balance": "1000.00"
}
]
}
]
}

Endpoints

MethodPathDescription
POST/v1/wallets/{account_id}Create a new wallet
GET/v1/wallets/{account_id}List wallets by account
GET/v1/wallets/{account_id}/{wallet_id}Get wallet detail
POST/v1/wallets/{wallet_id}/networks/{network_id}Assign network to wallet
POST/v1/wallets/{wallet_id}/withdrawWithdraw from wallet