Skip to content

Commit 598156d

Browse files
feat: update bitgo-api-docs
This commit updates the BitGo API.
1 parent 1e40603 commit 598156d

File tree

1 file changed

+105
-0
lines changed

1 file changed

+105
-0
lines changed

api.yaml

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32569,6 +32569,111 @@ paths:
3256932569
application/json:
3257032570
schema:
3257132571
$ref: '#/components/schemas/PlatformError'
32572+
/api/v2/wallet/{walletId}/address/{address}/crosschainbalances:
32573+
get:
32574+
summary: Get cross-chain address balances
32575+
description: |-
32576+
Gets balance information for a specific address across all enabled EVM keyring chains
32577+
32578+
For EVM keyring wallets, this endpoint returns the balance of a specific receive address
32579+
across all derived child wallets on different chains (e.g., ETH, Polygon, BSC).
32580+
The same address exists on multiple chains due to shared key material.
32581+
operationId: v2.wallet.address.crosschainbalances
32582+
tags:
32583+
- Address
32584+
parameters:
32585+
- name: walletId
32586+
in: path
32587+
required: true
32588+
schema:
32589+
$ref: '#/components/schemas/WalletIdString'
32590+
- name: address
32591+
description: The address to check across chains
32592+
in: path
32593+
required: true
32594+
schema:
32595+
allOf:
32596+
- $ref: '#/components/schemas/AddressString'
32597+
example: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb'
32598+
responses:
32599+
'200':
32600+
description: OK
32601+
content:
32602+
application/json:
32603+
schema:
32604+
type: object
32605+
properties:
32606+
addresses:
32607+
type: array
32608+
items:
32609+
type: object
32610+
description: List of addresses across all chains in the EVM keyring with their balances
32611+
properties:
32612+
id:
32613+
type: string
32614+
description: Platform public ID for the address
32615+
example: 59cd72485007a239fb00282ed480da1f
32616+
pattern: ^[0-9a-f]{32}$
32617+
coin:
32618+
allOf:
32619+
- $ref: '#/components/schemas/CoinString'
32620+
description: The coin/chain for this address
32621+
example: eth
32622+
wallet:
32623+
type: string
32624+
description: Wallet ID containing this address
32625+
example: 59cd72485007a239fb00282ed480da1f
32626+
pattern: ^[0-9a-f]{32}$
32627+
address:
32628+
allOf:
32629+
- $ref: '#/components/schemas/AddressString'
32630+
description: The address string (same across chains in an EVM keyring)
32631+
example: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb'
32632+
chain:
32633+
allOf:
32634+
- $ref: '#/components/schemas/AddressChain'
32635+
description: Chain index (0 for receive addresses)
32636+
index:
32637+
type: number
32638+
description: Address index within the chain
32639+
label:
32640+
allOf:
32641+
- $ref: '#/components/schemas/AddressLabelString'
32642+
description: User-defined label for this address
32643+
maxLength: 250
32644+
token:
32645+
type: string
32646+
description: Token identifier if this is a token address
32647+
example: usdc
32648+
balance:
32649+
allOf:
32650+
- $ref: '#/components/schemas/TrimmedBalance'
32651+
description: Balance information for this address
32652+
required:
32653+
- id
32654+
- coin
32655+
- wallet
32656+
- address
32657+
- chain
32658+
- index
32659+
count:
32660+
type: number
32661+
description: Total count of addresses returned
32662+
required:
32663+
- addresses
32664+
- count
32665+
'400':
32666+
description: Bad Request
32667+
content:
32668+
application/json:
32669+
schema:
32670+
$ref: '#/components/schemas/PlatformError'
32671+
'404':
32672+
description: Not Found
32673+
content:
32674+
application/json:
32675+
schema:
32676+
$ref: '#/components/schemas/PlatformError'
3257232677
/api/v2/wallet/{walletId}/derivedwallets:
3257332678
get:
3257432679
summary: List derived wallets for an EVM keyring

0 commit comments

Comments
 (0)