Stats

This document details the Balance Custody v1 Stats API, providing an endpoint to retrieve general statistical data related to the custody platform.

• API URL

• Authentication

• API Endpoints

  • GET /api/v1/stats

API URL

You will receive your integration URL from your point of contact at Balance, and will look like:

YOUR_CUSTOM_SUBDOMAIN.balancecustody.ca

---

Authentication

Due to the nature of the information exposed, every endpoint in this API requires authentication.

For more information on authentication go to the Authentication doc.

---

API Endpoints

GET /api/v1/stats

List all available account-level statistics.

Request

curl https://your_custom_subdomain.balancecustody.ca/api/v1/stats

Response

Returns a JSON struct for all available statistics.

Status: 200

Data:

{
  "total_assets_in_custody": {
    "btc": {
      "offline": 0.78182549,
      "unit": "btc",
      "warm": 367.80627061
    },
    "bch": {
      "offline": 0.78182549,
      "unit": "bch",
      "warm": 367.80627061
    }
 }
}