List balances

POST

https://sui-grpc.nownodes.io/sui.rpc.v2.StateService/ListBalances

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Lists all coin balances owned by an address.

gRPC method: sui.rpc.v2.StateService.ListBalances (unary).

This is a gRPC method (HTTP/2, Protocol Buffers), not a REST endpoint. The request and response bodies below are shown in the proto3 JSON form that tools such as grpcurl and Postman accept and print. Pass your NOWNodes API key as the api-key gRPC metadata header. Proto files: sui/rpc/v2/state_service.proto.

Example grpcurl request:

Copied!

grpcurl \
  -insecure \
  -H 'api-key: YOUR_API_KEY' \
  -emit-defaults \
  -proto './sui-apis-grpc/proto/sui/rpc/v2/state_service.proto' \
  -import-path './sui-apis-grpc/proto' \
  -d '{"owner": "0xOWNER_ADDRESS", "pageSize": 50}' \
  'sui-grpc.nownodes.io' \
  sui.rpc.v2.StateService.ListBalances

Body

application/json

Request message for LiveDataService.ListBalances.

ownerstring

Required. The owner's Sui address.

pageSizeinteger<uint32>

The maximum number of balance entries to return. The service may return fewer than this value. If unspecified, at most 50 entries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageTokenstring<byte>

A page token, received from a previous ListBalances call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListBalances must match the call that provided the page token. Base64-encoded bytes.

Response

200OK

Successful response.

default

gRPC error. The status code (e.g. UNAUTHENTICATED, INVALID_ARGUMENT, NOT_FOUND) is returned in the grpc-status trailer, details in grpc-message.

List balances

curl -X POST 'https://sui-grpc.nownodes.io/sui.rpc.v2.StateService/ListBalances' \
  -H 'Content-Type: application/json' \
  -d '{
    "owner": "string",
    "pageSize": 0,
    "pageToken": "dGVzdA=="
  }'

const response = await fetch('https://sui-grpc.nownodes.io/sui.rpc.v2.StateService/ListBalances', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "owner": "string",
      "pageSize": 0,
      "pageToken": "dGVzdA=="
    }),
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://sui-grpc.nownodes.io/sui.rpc.v2.StateService/ListBalances')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "owner": "string",
    "pageSize": 0,
    "pageToken": "dGVzdA=="
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

import requests

payload = {
  "owner": "string",
  "pageSize": 0,
  "pageToken": "dGVzdA=="
}

response = requests.post('https://sui-grpc.nownodes.io/sui.rpc.v2.StateService/ListBalances', json=payload)
data = response.json()

const response = await fetch('https://sui-grpc.nownodes.io/sui.rpc.v2.StateService/ListBalances', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "owner": "string",
      "pageSize": 0,
      "pageToken": "dGVzdA=="
    }),
});

const data = await response.json();

const endpoint = "https://sui-grpc.nownodes.io/sui.rpc.v2.StateService/ListBalances";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest({
    "owner": "string",
    "pageSize": 0,
    "pageToken": "dGVzdA=="
  });
console.log(result);

const response = await fetch('https://sui-grpc.nownodes.io/sui.rpc.v2.StateService/ListBalances', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "owner": "string",
      "pageSize": 0,
      "pageToken": "dGVzdA=="
    }),
});

const data = await response.json();

import requests

payload = {
  "owner": "string",
  "pageSize": 0,
  "pageToken": "dGVzdA=="
}

response = requests.post('https://sui-grpc.nownodes.io/sui.rpc.v2.StateService/ListBalances', json=payload)
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://sui-grpc.nownodes.io/sui.rpc.v2.StateService/ListBalances')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "owner": "string",
    "pageSize": 0,
    "pageToken": "dGVzdA=="
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

Request Body

{
  "owner": "0xOWNER_ADDRESS",
  "pageSize": 50
}

200

{
  "balances": [
    {
      "coinType": "string",
      "balance": "string",
      "addressBalance": "string",
      "coinBalance": "string"
    }
  ],
  "nextPageToken": "dGVzdA=="
}