suix_queryObjects

Extended API

Return the list of queried objects. Note that this is an enhanced full node only api.

Parameters

• query · ObjectResponseQuery · requiredthe objects query criteria.

  • filter · SuiObjectDataFilter or null · optionalIf None, no filter will be applied
  • options · ObjectDataOptions or null · optionalconfig which fields to include in the response, by default only digest is included

• cursor · CheckpointedObjectID · optionalAn 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.

  • atCheckpoint · BigInt<u64> or null · optional
  • objectId · ObjectID · required

• limit · integer (uint) · optionalMax number of items returned per page, default to [QUERY_MAX_RESULT_LIMIT] if not specified.

Result

• QueryObjectsPage · Page<SuiObjectResponse, CheckpointedObjectID>

  • data · SuiObjectResponse[] · required
  • hasNextPage · boolean · required
  • nextCursor · CheckpointedObjectID or null · optional

Example

Replace each <param> with a value of the type listed under Parameters.

Request

curl https://mainnet-api.inodra.com/v1/jsonrpc \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY' \
  -d '{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "suix_queryObjects",
  "params": [
    "<query>"
  ]
}'