Hedera · Example Payload

Getbalances

Returns a list of account and token balances on the network. The latest balance information is returned when there is no timestamp query parameter, otherwise, the information is retrieved from snapshots with 15-minute granularity. This information is limited to at most 50 token balances per account as outlined in HIP-367. As such, it's not recommended for general use and we instead recommend using either `/api/v1/accounts/{id}/tokens` or `/api/v1/tokens/{id}/balances` to obtain the current token balance information and `/api/v1/accounts/{id}` to return the current account balance.

balances

Getbalances is an example object payload from Hedera, with 8 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummarydescriptiontagsparametersresponses

Example Payload

Raw ↑
{
  "operationId": "getBalances",
  "method": "GET",
  "path": "/api/v1/balances",
  "summary": "List account balances",
  "description": "Returns a list of account and token balances on the network. The latest balance information is returned when there is no timestamp query parameter, otherwise, the information is retrieved from snapshots with 15-minute granularity. This information is limited to at most 50 token balances per account as outlined in HIP-367. As such, it's not recommended for general use and we instead recommend using either `/api/v1/accounts/{id}/tokens` or `/api/v1/tokens/{id}/balances` to obtain the current token balance information and `/api/v1/accounts/{id}` to return the current account balance.",
  "tags": [
    "balances"
  ],
  "parameters": [
    {
      "name": "account.id",
      "in": "query",
      "description": "Account id or account alias with no shard realm or evm address with no shard realm",
      "required": false
    },
    {
      "name": "account.balance",
      "in": "query",
      "description": "The optional balance value to compare against",
      "required": false
    },
    {
      "name": "account.publickey",
      "in": "query",
      "description": "The account's public key to compare against",
      "required": false
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of items to return",
      "required": false
    },
    {
      "name": "order",
      "in": "query",
      "description": "The order in which items are listed",
      "required": false
    },
    {
      "name": "timestamp",
      "in": "query",
      "description": "The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time.",
      "required": false
    }
  ],
  "responses": {
    "200": "OK",
    "400": "Invalid parameter"
  }
}