GET

Get enterprise asset balances — aggregated by asset across all permitted accounts

Returns the latest balance per asset (genericAsset) summed across all permitted accounts in the enterprise. One entry per asset; no per-account breakdown.

Path Params

enterpriseId string required

Your enterprise id.

at least 1 characters · matches ^[0-9a-f]{32}$

Query Params

accountIds array of strings

Optional list of account IDs. When provided, returns aggregated balances only for these accounts and their sub-accounts; when omitted, returns balances for all permitted accounts.

Header Params

user-id string required

User id of the user making the request.

at least 1 characters

Responses

200

Response Body

object

Response for GET enterprise asset balances — one entry per asset, aggregated across all accounts.

balances array of objects required
balances object
- rawAsset string required
  
  at least 1 characters
- genericAsset string
  
  at least 1 characters
- displayAsset string required
  
  at least 1 characters
- asset string
  
  at least 1 characters
- network string
  
  at least 1 characters
- available string required
- locked string required
  
  at least 1 characters
- total string required
  
  at least 1 characters

400

Bad Request

No response body

401

Unauthorized

Response Body

object

errorName string required
error string required

403

Forbidden

Response Body

object

errorName string required
error string required

500

Internal Server Error

Response Body

object

errorName string required
error string required

curl --request GET \ --url 'https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/assets/balances&accountIds=' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'user-id: string'

const url = 'https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/assets/balances&accountIds='; const options = {method: 'GET', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'user-id': 'string'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/assets/balances&accountIds=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["user-id"] = 'string' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/assets/balances&accountIds=', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'user-id' => 'string', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/assets/balances&accountIds=" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "user-id": "string" } response = requests.get(url, headers=headers) print(response.text)

{ "balances": [ { "rawAsset": "string", "genericAsset": "string", "displayAsset": "string", "asset": "string", "network": "string", "available": "string", "locked": "string", "total": "string" } ] }