(UTXO only) Wallet-level minimum fee rate that must be greater than or equal to the default of 1000 satoshis/kvByte. Per transaction, you can override "minFeeRate" with the "feeRate" parameter.
Minimum: >= 1000
Example: 12000
clientFlagsarray[object]
namestring
valueboolean
configobject
nodeId
custodialWalletIdstring
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
customChangeKeySignaturesobject
userstring
backupstring
bitgostring
customerWalletIdstring
enterprisestring
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
evmKeyRingReferenceWalletIdstring
Reference wallet ID for EVM keyring wallets (child wallets only)
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
isParentboolean
Indicates if this wallet is a parent wallet in an EVM keyring setup
Example: true
enabledChildChainsarray[string]
Array of enabled child chain names for parent EVM keyring wallets
Number of signatures required. This value must be 2 for hot wallets, 1 for **ofc** wallets, and not specified for custodial wallets.
Example: 2
migratedFromstring
multisigTypestring
Allowed values: onchaintssblsdkg
multisigTypeVersionstring
Allowed value: MPCv2
nnumber
Number of keys provided. This value must be 3 for hot wallets, 1 for **ofc** wallets, and not specified for custodial wallets.
Example: 3
recoverableboolean
tagsarray[string]
typestring
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
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`.
balancenumber
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`.
confirmedBalanceStringstring
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.
confirmedBalancenumber
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`.
spendableBalanceStringstring
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`.
spendableBalancenumber
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`.
stakingBalanceStringstring
The staked balance in base units.
Guaranteed to not lose precision.
The is only returned if the `includeStakingBalances` query parameter is set to `true`.
rewardBalanceStringstring
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`.
offchainobject
Lightning Balances
inboundBalancestringrequired
Inbound balance in millisatoshis (remote balance)
inboundPendingBalancestringrequired
Pending inbound balance in millisatoshis (pending open remote balance)
inboundUnsettledBalancestringrequired
Unsettled inbound balance in millisatoshis (unsettled remote balance)
outboundBalancestringrequired
Outbound balance in millisatoshis (local balance)
outboundPendingBalancestringrequired
Pending outbound balance in millisatoshis (pending open local balance)
outboundUnsettledBalancestringrequired
Unsettled outbound balance in millisatoshis (unsettled local balance)
outboundLockedBalancestringrequired
Locked (from pending force closed channels) outbound balance in millisatoshis (locked local balance)
outboundReservedBalancestringrequired
Total outbound reserved balance in millisatoshis (reserved local balance)
outboundSpendableBalancestringrequired
Total outbound spendable balance in millisatoshis (spendable local balance)
usersarray[object]
needsRecoveryboolean
permissionsarray[string]required
This type represents the permissions that can be assigned to a user when adding them to a wallet
1. 'admin': add/remove wallet policies, add/remove wallet users, approve/reject wallet pending approvals, withdraw assets from wallet, generate new receive addresses, view all balances and transactions
2. 'spend': withdraw assets from wallet, generate new receive addresses, view all balances and transactions
3. 'view': generate new receive addresses, view all balances and transactions
4. 'freeze':
5. 'trade': trade on a wallet - applicable only for trading wallets
6. 'dapp': connect to third-party dApps and provide them access to wallet operations