suix_getCoins

Coin Query API

Return all <coin_type>objects owned by an address.

Parameters

KeyRequiredTypeDetail
ownerSuiAddressthe owner's Sui address
coin_typeStringtype name for the coin, default to 0x2::sui::SUI if not specified.
cursorObjectIDoptional paging cursor
limituintmaximum number of items per page
"params": [
  "0x04658c48392301596b700ec6799dbbb333097b300c164a491fee0522fc6f5ddd",
  "0x2::sui::SUI"
]

Result

CoinPage: <Page_for_Coin_and_ObjectID>

Example

Request

curl <your-endpoint> \
    -X POST \
    -H "Content-Type: application/json" \
    -d '
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "suix_getCoins",
  "params": [
    "0x04658c48392301596b700ec6799dbbb333097b300c164a491fee0522fc6f5ddd",
    "0x2::sui::SUI"
  ]
}
'

Response

{
    "jsonrpc": "2.0",
    "result": {
        "data": [
            {
                "coinType": "0x2::sui::SUI",
                "coinObjectId": "0x090ef9c05eaf4af5c3c347f17ae4e93e4081d1deb4ef3ec02f9ae46b26f54a6e",
                "version": "2546793",
                "digest": "9zes4tToZ8KJEPwqY59sUPH9FKQoFckhbw9BJm3q8Ky8",
                "balance": "500477723525",
                "previousTransaction": "7Lk15VcM6oAQUMTt7RF8UHSmmDBgY3uUm6RaqS1PJi65"
            }
        ],
        "nextCursor": "0x090ef9c05eaf4af5c3c347f17ae4e93e4081d1deb4ef3ec02f9ae46b26f54a6e",
        "hasNextPage": false
    },
    "id": 1
}
Language
Click Try It! to start a request and see the response here!