suix_getOwnedObjects

Extended API

Return the list of objects owned by an address. Note that if the address owns more than QUERY_MAX_RESULT_LIMIT objects, the pagination is not accurate, because previous page may have been updated when the next page is fetched. Please use suix_queryObjects if this is a concern.

Parameters

KeyRequiredTypeDetail
addressSuiAddressthe owner's Sui address
queryObjectResponseQuerythe objects query criteria.
cursorObjectIDAn optional paging cursor. If provided, the query will start from the next item after the specified cursor. Default to start from the first item if not specified.
limituintMaximum item returned per page, default to [QUERY_MAX_RESULT_LIMIT] if not specified.
"params": [
  "0x9f279c8467608d6aa55c9514135bb4921a5faf0c6335e3b3e5096ac7cb1cd251",
  {
    "filter": {
      "StructType": "0x2::coin::Coin<0x2::sui::SUI>"
    },
    "options": {
      "showType": true,
      "showOwner": true,
      "showPreviousTransaction": true,
      "showDisplay": false,
      "showContent": false,
      "showBcs": false,
      "showStorageRebate": false
    }
  }
]

Result

ObjectsPage: <Page_for_SuiObjectResponse_and_ObjectID>

Example

Request

curl <your-endpoint> \
    -X POST \
    -H "Content-Type: application/json" \
    -d '
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "suix_getOwnedObjects",
  "params": [
    "0x9f279c8467608d6aa55c9514135bb4921a5faf0c6335e3b3e5096ac7cb1cd251",
    {
      "filter": {
        "StructType": "0x2::coin::Coin<0x2::sui::SUI>"
      },
      "options": {
        "showType": true,
        "showOwner": true,
        "showPreviousTransaction": true,
        "showDisplay": false,
        "showContent": false,
        "showBcs": false,
        "showStorageRebate": false
      }
    }
  ]
}
'

Response

{
    "jsonrpc": "2.0",
    "result": {
        "data": [
            {
                "data": {
                    "objectId": "0x02a74273ef4c2da87ee4b5a98947ff85afd7e88f43f6c3286d54546cf5328930",
                    "version": "2537088",
                    "digest": "2hrMypHS2Tg651p4eJdrGk59RMJ21GCoSW7nTqLChsMy",
                    "type": "0x2::coin::Coin<0x2::sui::SUI>",
                    "owner": {
                        "AddressOwner": "0x9f279c8467608d6aa55c9514135bb4921a5faf0c6335e3b3e5096ac7cb1cd251"
                    },
                    "previousTransaction": "FRYvYZ6211de3Q5npA9cRDeK9S7eJiCXxu6Ad66Z94mQ"
                }
            },
            {
                "data": {
                    "objectId": "0xa32e6a053f583eef1910834d5743ddc4386bc4c5077e20cf46634c3f2a37bf57",
                    "version": "2537088",
                    "digest": "9yUgFNMWuJ21Jp9pMxakrXUiXHrcWZ5JoPxbffW6Mhvk",
                    "type": "0x2::coin::Coin<0x2::sui::SUI>",
                    "owner": {
                        "AddressOwner": "0x9f279c8467608d6aa55c9514135bb4921a5faf0c6335e3b3e5096ac7cb1cd251"
                    },
                    "previousTransaction": "FRYvYZ6211de3Q5npA9cRDeK9S7eJiCXxu6Ad66Z94mQ"
                }
            }
        ],
        "nextCursor": "0xa32e6a053f583eef1910834d5743ddc4386bc4c5077e20cf46634c3f2a37bf57",
        "hasNextPage": false
    },
    "id": 1
}
Language
Click Try It! to start a request and see the response here!