Get wallet by address

Response Body

object

• admin object
  admin object

  • policy object
    policy object

    • id string required

      matches ^[0-9a-f]{32}$

    • date string date-time
    • label string
    • latest boolean required
    • rules array of objects required
      rules object

      • id string required
      • lockDate string date-time required
        The time at which this rule becomes immutable
      • mutabilityConstraint string enum

        Specifies whether a BitGo admin can change lockDate

        • managed - Not locked, but requires approval from a BitGo admin to change
        • permanent - lockDate cannot be changed
        managedpermanent
      • coin string
        A cryptocurrency or token ticker symbol.
      • type string enum required
        What causes this rule to trigger
        advancedWhitelistallTxbitcoinAddressWhitelistcoinAddressWhitelistcoinAddressBlacklisttransactionLimitvelocityLimitwebhook
      • condition object
        Parameters for the type

        ONE OF

        Velocity limit USD velocity limit Whitelist Advanced whitelist Webhook

        • amountString string

          matches ^-?\d+$

        • timeWindow integer
          Time window in seconds for a velocity limit, between 1 and a month

          >= 0 · <= 2.6784e+06

      • action object required
        What happens when this rule is triggered
        action object

        • type string enum required
          denygetApprovalgetFinalApprovalgetCustodianApprovalgetIdVerification
        • userIds array of strings
          For a final approver action, who can approve
    • version integer required
• allowBackupKeySigning boolean
• approvalsRequired integer required

  >= 1

• balanceString string
  Total balance in base units (e.g. Satoshis)
• buildDefaults object
  buildDefaults object

  • minFeeRate integer nullable

    (BTC only) The minimum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. Must be greater than or equal to the default of 1000 satoshis/kvByte.

    Note: The you can override minFeeRate on a per transaction basis with the feeRate parameter.

    >= 1000

  • maxFeeRate integer nullable

    (BTC only) The maximum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. The maxFeeRate limits the fee rate generated by both feeMultiplier and numBlocks.

    Note: The you can override maxFeeRate on a per transaction basis with the feeRate parameter.

    >= 1000

  • feeMultiplier number nullable

    (UTXO only) Custom multiplier to the feeRate. The resulting fee rate is limited by the maxFeeRate. For replace-by-fee (RBF) transactions (that include rbfTxIds), the feeMultiplier must be greater than 1, since it's an absolute fee multiplier to the transaction being replaced.

    Note: The maxFeeRate limits the fee rate generated by feeMultiplier.

    >= 1

  • changeAddressType string enum nullable
    (UTXO only) The default script type to use for change for this wallet. Per transaction, you override the default with the changeAddressType parameter. If default is provided, it will clear the changeAddressType default on the wallet. Note that each UTXO coin has different address types available. For example, Only BTC supports p2tr.
    p2shp2shP2wshp2wshp2trp2trMusig2default
  • txFormat string enum
    (UTXO only) The default transaction format to use for this wallet. Per transaction, you can override the default with the txFormat parameter.
    legacypsbtpsbt-lite
  • autoReserveUnspentsOnBuildMins number nullable
    (UTXO only) Automatically reserve unspents when building a transaction.

    >= 1

• coin string required
  A cryptocurrency or token ticker symbol.
• coinSpecific object

  ONE OF

  Wallet WalletCoinSpecificBtc WalletCoinSpecificCosmos WalletCoinSpecificOfc WalletCoinSpecificXlm

  • creationFailure array of strings
    Includes list of fail initialization txids
  • pendingChainInitialization boolean
    Whether the wallet needs to be initialized on the chain
• custodialWallet object
  The associated custodial wallet object
• custodialWalletId string

  matches ^[0-9a-f]{32}$

• deleted boolean required
• disableTransactionNotifications boolean required
• enterprise string

  matches ^[0-9a-f]{32}$

• freeze object
  freeze object

  • time string dateTime
  • expires string dateTime
  • reason string enum
    Reason why the wallet was frozen
    TxIntentMismatchTxIntentMismatchRecipientTxIntentMismatchContractTxIntentMismatchApprovalUserRequestAdminRequest
  • referenceId string
    Optional reference ID for tracking purposes
  • adminOrUserId string
    The user who froze the wallet
• id string required

  matches ^[0-9a-f]{32}$

• isCold boolean
• keys array of strings
• label string required
• m integer
  Number of signatures required. This value must be 2 for hot wallets, 1 for ofc wallets, and not specified for custodial wallets.
• n integer
  Number of keys provided. This value must be 3 for hot wallets, 1 for ofc wallets, and not specified for custodial wallets.
• nodeId string

  matches ^[0-9a-f]{32}$

• receiveAddress object
  receiveAddress object

  • id string
    platform public id for an address
  • address string

    up to 500 characters

  • chain integer enum
    011011202130314041
  • index integer
  • coin string
  • lastNonce integer

    Defaults to -1

  • wallet string
    The wallet which contains this address
  • coinSpecific object
    Properties which are specific to certain coin types
    coinSpecific object

    • xlm object
      xlm object

      • memoId string
        Latest memo id generated for the wallet
      • rootAddress string
        Root address of the wallet
    • txlm object
      txlm object

      • Same shape as AddressCoinSpecificXlm.
  • balance object
    Balance of the address. In case of Eth and Celo, if returnBalancesForToken is passed with includeBalances, then it will return token balance in the address object. This field will be present only when includeBalances query param is passed as true.
    balance object

    • updated string date-time
      The last time a transaction affected the balance of this address
    • balance integer
      The cleared balance of the address
    • balanceString string
      String representation of balance. Guaranteed to not lose precision.
    • totalReceived integer
      The total amount received on this address (in the chain's base unit)
    • totalSent integer
      The total amount send from this address (in the chain's base unit)
    • confirmedBalanceString string
      The total balance of confirmed transactions for the address (in the chain's base unit). Guaranteed to not lose precision.
    • spendableBalanceString string
      The total balance of the address (in the chain's base unit) which may be used as inputs for creating new transactions in string representation. Guaranteed to not lose precision.
  • label string nullable
    A human-readable label for the address.

    up to 250 characters

  • addressType string enum
    p2shp2shP2wshp2wshp2trp2trMusig2
• recoverable boolean
• tags array of strings
• spendableBalanceString string
  Spendable balance in base units (e.g. Satoshis)
• unspentCount number
  Number of unspent outputs present in the wallet
• startDate string date-time
  Wallet creation time
• type string enum
  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
  coldcustodialcustodialPairedhottradingdistributedCustodyadvanced
• users array of objects
  users object

  • user string

    matches ^[0-9a-f]{32}$

  • permissions array of string enums
    adminspendtradeview
• customChangeKeySignatures object

  Signatures for the keys which will be used to derive custom change addresses.

  Note: These signatures may only be set once for each wallet and are not modifiable after being set.

  customChangeKeySignatures object

  • user string
  • backup string
  • bitgo string
• multisigType string enum
  onchaintss
• multisigTypeVersion string enum
  MPCv2

Response Body

object

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