Get Token Balances - Validation Cloud

GET

/

api

/

v1

/

tokens

/

{tokenId}

/

balances

List token balances

curl --request GET \
  --url https://{network}.hedera.validationcloud.io/v1/{API_KEY}/api/v1/tokens/{tokenId}/balances

const options = {method: 'GET'};

fetch('https://{network}.hedera.validationcloud.io/v1/{API_KEY}/api/v1/tokens/{tokenId}/balances', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{network}.hedera.validationcloud.io/v1/{API_KEY}/api/v1/tokens/{tokenId}/balances",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{network}.hedera.validationcloud.io/v1/{API_KEY}/api/v1/tokens/{tokenId}/balances"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{network}.hedera.validationcloud.io/v1/{API_KEY}/api/v1/tokens/{tokenId}/balances")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "timestamp": "1586567700.453054000",
  "balances": [
    {
      "account": "0.15.2",
      "balance": 1000
    }
  ],
  "links": {
    "next": "/api/v1/transactions?timestamp=lt:1657598275.517984411"
  }
}

{
  "_status": {
    "messages": [
      {
        "message": "Invalid parameter: account.id"
      },
      {
        "message": "Invalid Transaction id. Please use \\shard.realm.num-sss-nnn\\ format where sss are seconds and nnn are nanoseconds"
      }
    ]
  }
}

List token balances. This method will use 20 Compute Units.

Path Parameters

tokenId

string | null

required

Token id Network entity ID in the format of shard.realm.num

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

Example:

"0.1.2"

Query Parameters

account.balance

string

The optional balance value to compare against

Pattern: ^((gte?|lte?|eq|ne)\:)?\d{1,10}$

account.id

string

The ID of the account to return information for

Pattern: ^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$

account.publickey

string

The account's public key to compare against

limit

integer<int32>

default:25

The maximum number of items to return

Required range: 1 <= x <= 100

order

enum<string>

default:asc

The order in which items are listed

Available options:

asc,

desc

timestamp

string[]

The consensus timestamp in seconds.nanoseconds format with an optional comparison operator

Pattern: ^((eq|gt|gte|lt|lte|ne):)?\d{1,10}(.\d{1,9})?$

Response

OK

timestamp

string | null

Pattern: ^\d{1,10}(\.\d{1,9})?$

Example:

"1586567700.453054000"

balances

object[]

Show child attributes

Example:

[{ "account": "0.15.2", "balance": 1000 }]

links

object

Show child attributes

List token balances

curl --request GET \
  --url https://{network}.hedera.validationcloud.io/v1/{API_KEY}/api/v1/tokens/{tokenId}/balances

const options = {method: 'GET'};

fetch('https://{network}.hedera.validationcloud.io/v1/{API_KEY}/api/v1/tokens/{tokenId}/balances', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{network}.hedera.validationcloud.io/v1/{API_KEY}/api/v1/tokens/{tokenId}/balances",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{network}.hedera.validationcloud.io/v1/{API_KEY}/api/v1/tokens/{tokenId}/balances"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{network}.hedera.validationcloud.io/v1/{API_KEY}/api/v1/tokens/{tokenId}/balances")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "timestamp": "1586567700.453054000",
  "balances": [
    {
      "account": "0.15.2",
      "balance": 1000
    }
  ],
  "links": {
    "next": "/api/v1/transactions?timestamp=lt:1657598275.517984411"
  }
}

{
  "_status": {
    "messages": [
      {
        "message": "Invalid parameter: account.id"
      },
      {
        "message": "Invalid Transaction id. Please use \\shard.realm.num-sss-nnn\\ format where sss are seconds and nnn are nanoseconds"
      }
    ]
  }
}