ListOwnedObjects - Sui

ListOwnedObjects. Lists objects owned by an address, with an optional type filter.

ListOwnedObjects - sui [Value: 20CU]
Lists objects owned by an address, optionally filtered by object type, with pagination.
gRPC: sui.rpc.v2.StateService/ListOwnedObjects
Use cases

Use cases

  • List NFTs owned by a wallet
  • Find coin objects for gas
  • Filter objects by Move type
Constraints

Constraints

  • Owner is required
  • Default 50, maximum 1000 entries
  • Default mask: id, version, type
Get started
Unlock Access to 100+ chains
Boost your app's speed and reliability with dRPC - get your access API key

Language

Request
Examples
grpcurl \
  -H "x-drpc-key: {API-KEY}" \
  -H "x-drpc-chain: sui" \
  -d '{
  "owner": "0x94096a6a54129234237759c66e6ef1037224fb3102a0ae29d33b490281c8e4d5"
}' \
  grpc.drpc.live:443 \
  sui.rpc.v2.StateService/ListOwnedObjects
Copy
Response
200
{
  "objects": [
    {
      "object_id": "0x1e2d3c4b5a69788796a5b4c3d2e1f00f1e2d3c4b5a69788796a5b4c3d2e1f00f",
      "version": "748390211",
      "object_type": "0x2::coin::Coin<0x2::sui::SUI>"
    },
    {
      "object_id": "0x6f5e4d3c2b1a09f8e7d6c5b4a39281706f5e4d3c2b1a09f8e7d6c5b4a3928170",
      "version": "701455862",
      "object_type": "0x2::kiosk::KioskOwnerCap"
    }
  ],
  "next_page_token": "CiBvXk08KxoJ+OfWxbSjkoFwb15NPCsaCfjn1sW0o5KBcA=="
}
Copy

Request params

Parametersobject
object
ownerstring
Required. Address of the account that owns the objects.
page_sizeinteger
Optional. Maximum number of entries to return. Defaults to 50, maximum 1000. A page is also cut at about 512 KiB.
page_tokenstring
Optional. Page token (bytes, base64) from a previous call's `next_page_token`. Other parameters must match that call.
read_maskstring
Optional. google.protobuf.FieldMask with the fields to return, as comma-separated paths. Defaults to `object_id,version,object_type`. Use `*` to return all fields.
object_typestring
Optional. Type filter. `0x2::coin::Coin` matches any type parameter, `0x2::coin::Coin<0x2::sui::SUI>` matches only SUI coins.

Response

200
Lists objects owned by an address, optionally filtered by object type, with pagination.

Response params

object
objectsarray_of_objects
Page of owned objects.
object
object_idstring
The object id.
versionstring
Version of the object.
digeststring
Digest of the object.
ownerobject
Owner of the object.
object
kindstring
Ownership kind: `ADDRESS`, `OBJECT`, `SHARED`, `IMMUTABLE` or `CONSENSUS_ADDRESS`.
addressstring
Owning address or object id (for `ADDRESS`, `OBJECT` and `CONSENSUS_ADDRESS` kinds).
versionstring
Initial shared version (for `SHARED`) or start version (for `CONSENSUS_ADDRESS`).
object_typestring
Type of the object: a StructTag for Move structs, or `package` for packages.
has_public_transferboolean
Deprecated. Only set for Move structs.
contentsobject
BCS bytes of the Move struct value (`name`, `value`). Only set for Move structs.
packageobject
Package information, for Move packages.
previous_transactionstring
Digest of the transaction that created or last mutated this object.
storage_rebatestring
Amount of SUI rebated if this object is deleted. Recalculated each time the object is mutated.
jsonobject
JSON rendering of the object.
balancestring
Current balance, if the object is a `0x2::coin::Coin<T>`.
displayobject
JSON rendering based on the type's on-chain `Display` template. Not set if the type has no template.
bcsobject
The object serialized as BCS (`name`, `value`).
next_page_tokenstring
Token (bytes, base64) for the next page. Omitted when there are no more pages.
ListBalancesGetCoinInfo