Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Wallet

Get wallet by address

Get one wallet by its coin and receive address. Multiple receive addresses can map to one walletId.

get/api/v2/{coin}/wallet/address/{address}

Path parameters

coinstring required

A cryptocurrency or token ticker symbol.

Example:btc
addressstring required
Example:2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS

Response

OK

allowBackupKeySigningboolean
approvalsRequiredinteger required
balanceStringstring
coinstring required

A cryptocurrency or token ticker symbol.

custodialWalletobject

The associated custodial wallet object

custodialWalletIdstring
deletedboolean required
disableTransactionNotificationsboolean required
enterprisestring
idstring required
isColdboolean
keysId[]
labelstring required
minteger

Number of signatures required. This value must be 2 for hot wallets, 1 for ofc wallets, and not specified for custodial wallets.

ninteger

Number of keys provided. This value must be 3 for hot wallets, 1 for ofc wallets, and not specified for custodial wallets.

nodeIdstring
recoverableboolean
tagsId[]
spendableBalanceStringstring
unspentCountnumber

Number of unspent outputs present in the wallet

startDatestring date-time
type'cold' | 'custodial' | 'custodialPaired' | 'hot' | 'trading' | 'distributedCustody' | 'advanced'

The type describes who owns the keys to the wallet and how they are stored. cold wallets are wallets where the private key of the user key is stored exclusively outside of BitGo's system. custodial means that this wallet is a cold wallet where BitGo owns the keys. Only customers of the BitGo Trust can create this kind of wallet. custodialPaired means that this is a hot wallet that is owned by the customer but it will be linked to a cold (custodial) wallet where BitGo owns the keys. This option is only available to customers of BitGo Inc. BitGo stores an encrypted private key for the user key of hot wallets. trading wallets are trading accounts where the coin is ofc. distributedCustody means You manage one key and another key agent manages the second key. BitGo manages the third key

multisigType'onchain' | 'tss'
multisigTypeVersion'MPCv2'

Example response

{
  "admin": {
    "policy": {
      "id": "59cd72485007a239fb00282ed480da1f",
      "rules": [
        {
          "coin": "btc",
          "condition": {
            "amountString": "2000000"
          },
          "action": {
            "userIds": [
              "59cd72485007a239fb00282ed480da1f"
            ]
          }
        }
      ]
    }
  },
  "approvalsRequired": 1,
  "balanceString": "2000000",
  "buildDefaults": {
    "minFeeRate": 12000,
    "maxFeeRate": 18000,
    "feeMultiplier": 1.2,
    "changeAddressType": "p2wsh",
    "txFormat": "psbt",
    "autoReserveUnspentsOnBuildMins": 60
  },
  "coin": "btc",
  "coinSpecific": {
    "creationFailure": [
      "b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26"
    ]
  },
  "custodialWalletId": "59cd72485007a239fb00282ed480da1f",
  "enterprise": "59cd72485007a239fb00282ed480da1f",
  "id": "59cd72485007a239fb00282ed480da1f",
  "keys": [
    "585951a5df8380e0e304a553",
    "585951a5df8380e0e30d645c",
    "585951a5df8380e0e30b6147"
  ],
  "label": "My Wallet",
  "m": 2,
  "n": 3,
  "nodeId": "59cd72485007a239fb00282ed480da1f",
  "receiveAddress": {
    "id": "59cd72485007a239fb00282ed480da1f",
    "address": "2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS",
    "chain": 1,
    "wallet": "59cd72485007a239fb00282ed480da1f",
    "coinSpecific": {
      "xlm": {
        "memoId": "1",
        "rootAddress": "GCTTCPH4IIDK7P72FFAEJ3ZFN6WDHJH6GGMRPHPM56ZWGIQ7B3XTIJAM"
      },
      "txlm": {
        "memoId": "1",
        "rootAddress": "GCTTCPH4IIDK7P72FFAEJ3ZFN6WDHJH6GGMRPHPM56ZWGIQ7B3XTIJAM"
      }
    },
    "balance": {
      "balance": 50000,
      "balanceString": "50000",
      "confirmedBalanceString": "40000",
      "spendableBalanceString": "40000"
    },
    "label": "Bob's Hot Wallet Address",
    "addressType": "p2sh"
  },
  "tags": [
    "59cd72485007a239fb00282ed480da1f"
  ],
  "spendableBalanceString": "2000000",
  "unspentCount": 100,
  "users": [
    {
      "user": "55e8a1a5df8380e0e30e20c6",
      "permissions": [
        "admin",
        "view",
        "spend"
      ]
    }
  ]
}