Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Wallet

List derived wallets for an EVM keyring

Lists all child wallets derived from an EVM keyring parent wallet. This endpoint accepts either a parent wallet ID or a child wallet ID:

  • If given a parent wallet ID (wallet with isParent=true), returns all child wallets
  • If given a child wallet ID (wallet with evmKeyRingReferenceWalletId), returns all sibling child wallets that share the same parent

Child wallets are identified by having the evmKeyRingReferenceWalletId field set to the parent wallet's ID. Child wallets can be on different chains (e.g., BSC, Polygon, Arbitrum) but share the same key material from the parent wallet.

Returns wallets with the same structure as the normal list wallet API, including:

  • Balance information (balance, confirmedBalance, spendableBalance)
  • Token balances for all tokens on each chain
  • Staking balances (if includeStakingBalances is set)
  • Receive addresses (unless skipReceiveAddress is set)
  • Policy information (if expandPolicy is set)
  • All other wallet properties
get/api/v2/wallet/{walletId}/derivedwallets

Path parameters

walletIdstring required
Example:59cd72485007a239fb00282ed480da1f

The wallet ID - can be either a parent wallet ID or a child wallet ID

Query parameters

idstring[]

Filter by ID

[
  "\"59cd72485007a239fb00282ed480da1f\""
]
coinstring[]

Filter by coin

[
  "\"btc\""
]
enterprisestring[]

Filter by enterprise.

[
  "\"59cd72485007a239fb00282ed480da1f\""
]
typestring[]

Filter by wallet type

subTypestring[]

Filter by wallet sub-type

deletedboolean

Filter by deleted state

prevIdstring
Example:59cd72485007a239fb00282ed480da1f

Return the next batch of results, based on the "nextBatchPrevId" value from the previous batch.

labelContainsstring

Filter by label substring.

expandBalanceboolean

Add "balanceString", "confirmedBalanceString" and "spendableBalanceString" to each wallet

excludeSpendableBalanceboolean
expandPolicyboolean
expandCustodialWalletboolean

Whether linked custodial wallets should be expanded inline

ignoreErrorsboolean
includeStakingBalancesboolean

Include stakingBalanceString and rewardBalanceString properties for each staking wallet. Requires expandBalance to be set to true.

limitstring number

Maximum number of results to return. If the result set is truncated, use the "nextBatchPrevId" value to get the next batch.

offsetstring number

Number of documents to skip for offset-based pagination.

skipReceiveAddressboolean

Do not add "receiveAddress" to each wallet

permission'admin' | 'view' | 'spend'

Return only wallets for which the user has the given permission

pinnedWallets'pinnedOnly' | 'pinnedExcluded'

Return only pinned wallets ("pinnedOnly") or only unpinned wallets ("pinnedExcluded"), exclude to return both

bitgoOrg'BitGo Trust' | 'BitGo New York' | 'BitGo Germany' | 'BitGo Switzerland' | 'BitGo Europe ApS' | 'Frankfurt DE Trust' | 'BitGo Singapore' | 'BitGo Korea' | 'BitGo Custody MENA FZE' | 'BitGo India' | 'BitGo Sister Trust 1'

Return only wallets belong to the BitGo trust org

skipUnsupportedCoinsboolean

Skip unsupported coins instead of returning an error

customTagsstring[]

Filter wallets by applied tags (OR semantics). Provide one or more tag values; returns wallets that match any of the supplied tags. Tag matching is case-insensitive — ?customTags=Warm matches stored "warm".

[
  "\"warm\""
]
frozenboolean

Filter derived wallets by freeze status.

  • true: Return only frozen wallets (freeze.expires >= current time)
  • false: Return only non-frozen wallets (no freeze or freeze expired) If not specified, returns all derived wallets regardless of freeze status.
hasSendManyTokensboolean

When true, return only derived wallets that have at least one token in the sendManyTokens array on at least one chain (includes both pending and active token states). When false or not specified, returns all derived wallets.

coinContainsstring

Filter by coin or display name (case-insensitive substring). E.g. "bsc", "Polygon", "Arbitrum".

sendManyTokenContainsstring

Filter to wallets that have a sendMany token matching this string (case-insensitive). E.g. "usdc", "busd", "link".

Response

OK

nextBatchPrevIdstring 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.

totalCountnumber