API References

List derived wallets for an EVM keyring

get
https://app.bitgo-test.com/api/v2/wallet//derivedwallets

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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

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

Query Params
id
array of strings

Filter by ID

id
coin
array of strings

Filter by coin

coin
enterprise
array of strings

Filter by enterprise.

enterprise
type
array of strings

Filter by wallet type

type
subType
array of strings

Filter by wallet sub-type

subType
boolean

Filter by deleted state

string

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

string

Filter by label substring.

boolean
Defaults to false

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

boolean
boolean
boolean

Whether linked custodial wallets should be expanded inline

boolean
boolean
Defaults to false

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

string
Defaults to 25

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

string
Defaults to 0

Number of documents to skip for offset-based pagination.

boolean
Defaults to false

Do not add "receiveAddress" to each wallet

string
enum

Return only wallets for which the user has the given permission

Allowed:
string
enum

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

Allowed:
string
enum

Return only wallets belong to the BitGo trust org

boolean
Defaults to false

Skip unsupported coins instead of returning an error

boolean

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

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.

string

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

string

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

Responses

Updated about 1 month ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago