suix_getBalance RPC Method

Parameters

owner

string

REQUIRED

The owner's Sui address

coinType

string

The type names for the coin. The default is set to 0x2::sui::SUI if not specified

Returns

result

array

The list of coin types and their respective balances

coinType

string

The type of the coin (e.g., SUI token)

coinObjectCount

integer

Indicates the number of coin objects associated with the queried address

totalBalance

string

Shows the total balance of the coin in its smallest unit (mist)

lockedBalance

object

Represents any portion of the balance that is currently locked

Request

1
curl --location 'https://docs-demo.sui-mainnet.quiknode.pro/' \
2
--header 'Content-Type: application/json' \
3
--data '{
4
  "jsonrpc": "2.0",
5
  "id": 1,
6
  "method": "suix_getBalance",
7
  "params": [
8
    "0xac5bceec1b789ff840d7d4e6ce4ce61c90d190a7f8c4f4ddf0bff6ee2413c33c"
9
  ]
10
}'

Don't have an account yet?

Create your QuickNode endpoint in seconds and start building

Get started for free

suix_getBalance RPC Method

Return the total coin balance for one coin type, owned by the address owner.

Parameters

Returns