Ctrl+K

List v1 wallets

get/api/v1/wallet

Get a list of all v1 wallets for which you have permission.

Query Parameters

  • enterpriseIdstring
    Filter by enterprise ID.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • getbalancesbooleanDefault: false
    Add "balanceString" and "spendableBalanceString" to each wallet
  • limitintegerDefault: 25
    Maximum number of results to return. If the result set is truncated, use the `nextBatchPrevId` value to get the next batch.
    Minimum: >= 1
    Maximum: <= 500
  • prevIdstring
    Return the next batch of results, based on the `nextBatchPrevId` value from the previous batch.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

200 Response

wallets array[object]
id string
id of the wallet (also the first receiving address)
Max length: <= 250 characters
Example: 2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS
label string
the wallet label, as shown in the UI
Example: My Wallet
isActive boolean
Wallet is not deleted
Example: true
type string
Wallet type
Example: safehd
freeze object
Wallet is frozen
adminCount integer
Number of admins on the wallet
Example: 1
disableTransactionNotifications boolean
Flag for disabling wallet transaction notifications
Example: false
private object
contains summarised version of keychains
canSendInstant boolean
boolean indicating if wallet is eligible to send instant transactions backed by BitGo’s guarantee against double spends
Example: true
permissions string
user's permissions on this wallet
Example: admin,spend,view
admin object
policy information on the wallet's administrators
tags array[string]
Example: 59cd72485007a239fb00282ed480da1f
approvalsRequired integer
Minimum: >= 1
Example: 1
spendingAccount boolean
Example: true
pendingApprovals array[object]
balance integer
the balance, including transactions with 0 confirmations
Example: 39564772124
spendableConfirmedBalance integer
Example: 39564772124
confirmedBalance integer
the confirmed balance
Example: 39564772124
spendableBalance integer
Example: 39564772124
sent integer
Example: 0
received integer
Example: 39564772124
unconfirmedSends integer
Example: 0
unconfirmedReceives integer
Example: 0
nextBatchPrevId string <uuid>
When a result set is truncated, this field returns the id of the last object in the previous batch. To get the next batch of results, pass this value via the `prevId` query parameter.
Example: 585951a5df8380e0e3063e9f

400 Response

allOf All of
object
error string required
Human-readable error message
requestId string required
Client request id
object
context object
Properties that apply to a specific error name
name string required
Error code