suix_getBalance

POST

/{apiKey}

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.

Path Parameters

stringrequireddefaults to docs-demo

For higher throughput, create your own API key

Request

stringrequired

The owner's Sui address.

stringoptional

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

Responses

200

The balance data for the requested coin type.

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_getBalance",  "params": [    "0xe883a1df96561884e46d8e29cfb4e127bb6fd2719c33af1c16239a25a469e0a6",    "0x2::sui::SUI"  ]}'

200Success

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

Was this page helpful?