suix_getAllBalances

POST

/{apiKey}

Deprecation notice

Action required: Support for Sui JSON-RPC will end on September 25, 2026. Please migrate to Sui gRPC before then to avoid disruption. You can find our migration guide here.

Returns the total balance for each coin type owned by the specified address, including the number of coin objects and any locked amounts.

Path Parameters

stringrequireddefaults to docs-demo

For higher throughput, create your own API key

Request

stringrequired

The owner's Sui address.

Responses

200

A list of balance entries, one for each coin type the address owns.

POST/v2/{apiKey}

curl --request POST \  --url https://sui-mainnet.g.alchemy.com/v2/docs-demo \  --header 'Content-Type: application/json' \  --data '{  "jsonrpc": "2.0",  "id": 1,  "method": "suix_getAllBalances",  "params": [    "0xe883a1df96561884e46d8e29cfb4e127bb6fd2719c33af1c16239a25a469e0a6"  ]}'

200Success

{  "jsonrpc": "2.0",  "id": 1,  "result": [    {      "coinType": "0x2::sui::SUI",      "coinObjectCount": 5,      "totalBalance": "5000000000",      "lockedBalance": {}    }  ]}

Was this page helpful?