ListBalances - Sui

ListBalances. Returns the balances of all coin types owned by an address.

ListBalances - sui [Value: 20CU]
Returns the balances of all coin types owned by an address, with pagination.
gRPC: sui.rpc.v2.StateService/ListBalances
Use cases

Use cases

  • Show full wallet portfolio
  • Discover tokens held by address
  • Paginate large token lists
Constraints

Constraints

  • Owner is required
  • Default 50, maximum 1000 entries
  • Same params when paginating
Get started
Unlock Access to 100+ chains
Boost your app's speed and reliability with dRPC - get your access API key

Language

Request
Examples
grpcurl \
  -H "x-drpc-key: {API-KEY}" \
  -H "x-drpc-chain: sui" \
  -d '{
  "owner": "0x94096a6a54129234237759c66e6ef1037224fb3102a0ae29d33b490281c8e4d5",
  "page_size": 10
}' \
  grpc.drpc.live:443 \
  sui.rpc.v2.StateService/ListBalances
Copy
Response
200
{
  "balances": [
    {
      "coin_type": "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",
      "balance": "1035000074",
      "address_balance": "0",
      "coin_balance": "1035000074"
    },
    {
      "coin_type": "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC",
      "balance": "25000000",
      "address_balance": "0",
      "coin_balance": "25000000"
    }
  ]
}
Copy

Request params

Parametersobject
object
ownerstring
Required. The owner's Sui address.
page_sizeinteger
Optional. Maximum number of entries to return. Defaults to 50, maximum 1000.
page_tokenstring
Optional. Page token (bytes, base64) from a previous call's `next_page_token`. Other parameters must match that call.

Response

200
Returns the balances of all coin types owned by an address, with pagination.

Response params

object
balancesarray_of_objects
Coin types and their balances.
object
coin_typestring
The coin type, for example `0x2::sui::SUI`.
balancestring
Total balance in the smallest unit: `address_balance` + `coin_balance`.
address_balancestring
Balance held in the address balance (`Balance<T>`).
coin_balancestring
Balance of all `Coin<T>` objects owned by the address.
next_page_tokenstring
Token (bytes, base64) for the next page. Omitted when there are no more pages.
GetBalanceListOwnedObjects