/api/v2/wallets
Get a list of all wallets for which you have permission. To narrow your search, use the List wallets parameters below or call List wallets by coin, Get Wallet (by "coin" and "walletId") or Get wallet by address (by "coin" and "address").
Compare the List/Get wallet APIs:
API | URL |
---|---|
List wallets | {{baseUrl}}/api/v2/wallets?coin={coin}&enterprise={enterpriseid}&id={walletId}&expandBalance=true |
List wallets by coin | {{baseUrl}}/api/v2/{coin}/wallet?enterprise={enterpriseid}&searchLabel={wallet name} |
Get wallet | {{baseUrl}}/api/v2/{coin}/wallet/{walletId} |
Get wallet by address | {{baseUrl}}/api/v2/{coin}/wallet/address/{address} |
coin
array[string]"btc"
deleted
array[boolean]enterprise
array[string]"59cd72485007a239fb00282ed480da1f"
^[0-9a-f]{32}$
enterpriseIsNull
booleanskipReceiveAddress
booleanDefault: false
expandBalance
booleanDefault: false
id
array[string]"59cd72485007a239fb00282ed480da1f"
^[0-9a-f]{32}$
labelContains
stringlimit
integerDefault: 25
offset
integerprevId
string"59cd72485007a239fb00282ed480da1f"
^[0-9a-f]{32}$
type
array[string]cold
custodial
custodialPaired
hot
trading
expandCustodialWallet
booleanwallets
array[object] required admin
object allowBackupKeySigning
boolean approvalsRequired
integer required >= 1
1
balanceString
string 2000000
^-?\d+$
buildDefaults
object coin
string required btc
coinSpecific
One ofcustodialWallet
object custodialWalletId
string 59cd72485007a239fb00282ed480da1f
^[0-9a-f]{32}$
deleted
boolean required disableTransactionNotifications
boolean required enterprise
string 59cd72485007a239fb00282ed480da1f
^[0-9a-f]{32}$
freeze
object id
string required 59cd72485007a239fb00282ed480da1f
^[0-9a-f]{32}$
isCold
boolean keys
array[string] ["585951a5df8380e0e304a553","585951a5df8380e0e30d645c","585951a5df8380e0e30b6147"]
label
string required My Wallet
m
integer 2
n
integer 3
nodeId
string 59cd72485007a239fb00282ed480da1f
^[0-9a-f]{32}$
receiveAddress
object recoverable
boolean tags
array[string] spendableBalanceString
string 2000000
^-?\d+$
unspentCount
number 100
startDate
string <date-time>
{}
type
string cold
custodial
custodialPaired
hot
trading
users
array[object] customChangeKeySignatures
object multisigType
string onchain
tss
blsdkg
nextBatchPrevId
string <uuid>
585951a5df8380e0e3063e9f
totalCount
integer error
string required requestId
string required context
object name
string required