Get the total balances for the tenant, for each asset

GET

https://your-protect-instance.example.com/api/rest/v1/balances

GET

/api/rest/v1/balances

curl https://your-protect-instance.example.com/api/rest/v1/balances \
     -H "Authorization: Bearer <token>"

{
  "balances": [
    {
      "asset": {
        "currency": "string",
        "kind": "string",
        "nft": {
          "tokenid": "string"
        },
        "unknown": {
          "blockchain": "string",
          "arg1": "string",
          "arg2": "string",
          "network": "string"
        },
        "currencyInfo": {
          "name": "string",
          "symbol": "string",
          "coinTypeIndex": "string",
          "blockchain": "string",
          "isToken": true,
          "isERC20": true,
          "decimals": "string",
          "contractAddress": "string",
          "hasStaking": true,
          "isUTXOBased": true,
          "isAccountBased": true,
          "isFiat": true,
          "isFA12": true,
          "isFA20": true,
          "isNFT": true,
          "enabled": true,
          "id": "string",
          "displayName": "string",
          "type": "string",
          "wlcaId": "string",
          "network": "string",
          "tokenID": "string",
          "logo": "string"
        }
      },
      "balance": {
        "totalConfirmed": "1500000000000000000",
        "totalUnconfirmed": "100000",
        "availableConfirmed": "1500000000000000000",
        "availableUnconfirmed": "100000"
      }
    }
  ],
  "total": "string",
  "next": "string",
  "cursor": {
    "currentPage": "string",
    "hasPrevious": true,
    "hasNext": true
  }
}

Get the total balances for the tenant, for each asset An asset is identified by a full triplet of attributes blockchain, arg1, arg2 (typically blockchain, contract number, and token ID)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

currencystringOptional

Filter on ID or symbol of the currency

limitstringOptionalformat: "uint64"

cursorstringOptionalformat: "byte"

tokenIdstringOptional

requestCursor.currentPagestringOptional

Base64-encoded string representing the current window of data

requestCursor.pageRequeststringOptional

The page to request, w.r.t the current page. Can be one of FIRST, PREVIOUS, NEXT, LAST

requestCursor.pageSizestringOptionalformat: "uint64"

The size of the page requested. The handling service should impose a hard limit on this

Response

A successful response.

balanceslist of objectsOptional

totalstringOptionalformat: "uint64"

nextstringOptionalformat: "byte"

cursorobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error