Ctrl+K

Internal get wallet by address

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

Get one wallet by its coin and one of its address.

Path Parameters

  • coinstringRequired
    A cryptocurrency symbol or token ticker symbol
    Example: btc
    Min length: >= 1 characters
  • walletAddressstringRequired
    An address
    Example: 2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS
    Min length: >= 1 characters

200 Response

wallet object required
allowBackupKeySigning boolean required
approvalsRequired number required
Minimum: >= 1
Example: 1
coin string required
A cryptocurrency symbol or token ticker symbol
Example: btc
coinSpecificOne ofrequired
deleted boolean required
disableTransactionNotifications boolean required
hasLargeNumberOfAddresses
boolean or null
required
id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
isCold boolean required
label string required
Example: My Wallet
startDate string <date-time>required
Wallet creation time
admin object
billingEnterprise string
buildDefaults object
clientFlags array[object]
config object
custodialWalletId string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
customChangeKeySignatures object
customerWalletId string
enterprise string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
evmKeyRingReferenceWalletId string
Reference wallet ID for EVM keyring wallets (child wallets only)
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
isParent boolean
Indicates if this wallet is a parent wallet in an EVM keyring setup
Example: true
enabledChildChains array[string]
Array of enabled child chain names for parent EVM keyring wallets
Example: ["tbsc","tpolygon"]
organization string
bitgoOrg string
freeze object
instantProvider string
keys array[string]
Example: ["585951a5df8380e0e304a553","585951a5df8380e0e30d645c","585951a5df8380e0e30b6147"]
keySignatures object
m number
Number of signatures required. This value must be 2 for hot wallets, 1 for **ofc** wallets, and not specified for custodial wallets.
Example: 2
migratedFrom string
multisigType string
Allowed values: onchain tss blsdkg
multisigTypeVersion string
Allowed value: MPCv2
n number
Number of keys provided. This value must be 3 for hot wallets, 1 for **ofc** wallets, and not specified for custodial wallets.
Example: 3
recoverable boolean
tags array[string]
type string
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
Allowed values: backing cold custodial custodialPaired hot advanced trading
subType string
Allowed values: distributedCustody pairedCustodial custodialHot custodialCold lightningCustody lightningSelfCustody onPrem
balanceString string
The cleared balance of the address in base units (e.g. Satoshis). Guaranteed to not lose precision. The is only returned if the `expandBalance` query parameter is set to `true`.
balance number
The cleared balance of the address in base units (e.g. Satoshis). The is only returned if the `expandBalance` query parameter is set to `true`.
confirmedBalanceString string
The total balance of confirmed transactions in base units (e.g. Satoshis). The is only returned if the `expandBalance` query parameter is set to `true`. Guaranteed to not lose precision.
confirmedBalance number
The total balance of confirmed transactions in base units (e.g. Satoshis). The is only returned if the `expandBalance` query parameter is set to `true`.
spendableBalanceString string
The total balance in base units (e.g. Satoshis) which may be used as inputs for creating new transactions in string representation. Guaranteed to not lose precision. The is only returned if the `expandBalance` query parameter is set to `true`.
spendableBalance number
The total balance in base units (e.g. Satoshis) which may be used as inputs for creating new transactions in string representation. The is only returned if the `expandBalance` query parameter is set to `true`.
stakingBalanceString string
The staked balance in base units. Guaranteed to not lose precision. The is only returned if the `includeStakingBalances` query parameter is set to `true`.
rewardBalanceString string
The staking reward balance in base units. Guaranteed to not lose precision. The is only returned if the `includeStakingBalances` query parameter is set to `true`.
offchain object
Lightning Balances
users array[object]
walletFlags array[object]
receiveAddress object