Links

suix_getBalance

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

Parameters

  • owner : <SuiAddress> - the owner's Sui address
  • coin_type : <string> - optional fully qualified type names for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC), default to 0x2::sui::SUI if not specified.

Returns

Balance : <Balance>
  • coinObjectCount : <uint>
  • coinType : <string>
  • lockedBalance : <object>
  • totalBalance : <BigInt_for_uint128>

Example Request and Result for suix_getBalance

Request
curl --location 'https://sui-testnet.blastapi.io/b2382197-29ea-4428-a562-742328e27ab0' \
--header 'Content-Type: application/json' \
--data '{
"jsonrpc": "2.0",
"id": 1,
"method": "suix_getBalance",
"params": [
"0xe883a1df96561884e46d8e29cfb4e127bb6fd2719c33af1c16239a25a469e0a6",
"0x2::sui::SUI"
]
}'
Result
{
"jsonrpc": "2.0",
"result": {
"coinType": "0x2::sui::SUI",
"coinObjectCount": 1,
"totalBalance": "1000000000",
"lockedBalance": {}
},
"id": 1
}