suix_getBalance | Alchemy Docs

Returns the total coin balance for a single coin type owned by the specified address. If no coin type is specified, defaults to the native SUI coin type.

⚠ This endpoint is only available with Blast access.

Path parameters

apiKeystringRequired

Request

This endpoint expects an object.

ownerstringRequired

The owner's Sui address.

coin_typestringOptional

Fully qualified type name of the coin. If omitted, defaults to 0x2::sui::SUI.

Response

The balance data for the requested coin type.

coinTypestring or null

The coin type queried.

coinObjectCountinteger or null

Number of coin objects owned of the specified type.

totalBalancestring or null

Total balance in base units of the coin.

lockedBalanceobject or null

Object describing any locked funds, if applicable.

1	curl -X POST https://sui-mainnet.alchemy-blast.com/v2/{apiKey} \
2	-H "Content-Type: application/json" \
3	-d '{
4	"jsonrpc": "2.0",
5	"method": "suix_getBalance",
6	"params": [
7	"0xe883a1df96561884e46d8e29cfb4e127bb6fd2719c33af1c16239a25a469e0a6",
8	"0x2::sui::SUI"
9	],
10	"id": 1
11	}'

1	{
2	"jsonrpc": "2.0",
3	"id": "1",
4	"result": {
5	"coinType": "0x2::sui::SUI",
6	"coinObjectCount": 5,
7	"totalBalance": "5000000000",
8	"lockedBalance": {}
9	}
10	}