ListOwnedObjects

gRPC

RPC Methodsui.rpc.v2.StateService/ListOwnedObjects

Retrieves the list of objects owned by the specified address.

Proto files required

Running the examples below requires the official Sui proto files. Download the proto files, then set the example's -import-path relative to the proto root (the -proto path in the examples is relative to the proto root).

github.com/MystenLabs/sui-apis/tree/main/proto

Request Message

ownerstringrequired

Required. The address of the account that owns the objects.

page_sizeinteger

The maximum number of entries to return. The service may return fewer than this value. If unspecified, at most 50 entries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_tokenstring

A page token, received from a previous ListOwnedObjects call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListOwnedObjects must match the call that provided the page token.

read_maskobject

Mask specifying which fields to read.

pathsarray

The set of field mask paths (e.g. "object_id", "version", "digest").

object_typestring

Optional type filter to limit the types of objects listed. Providing an object type with no type params will return objects of that type with any type parameter. For example, 0x2::coin::Coin returns all Coin<T> objects regardless of T. Providing a type with type params restricts results accordingly, e.g. 0x2::coin::Coin<0x2::sui::SUI> only returns Coin<SUI> objects.

Response Message

Page of objects owned by the specified address.

This Object serialized as BCS.

namestring

Name that identifies the type of the serialized value.

valuestring

Bytes of a BCS serialized value.

object_idstring

ObjectId of the object.

versioninteger

Version of the object.

digeststring

The digest of this Object.

Owner of the object.

kindstring

Kind of ownership.

addressstring

Address or ObjectId of the owner.

versioninteger

The initial_shared_version if kind is SHARED or start_version if kind is CONSENSUS_ADDRESS.

object_typestring

Type of the object.

has_public_transferboolean

DEPRECATED. Whether the object has public transfer.

BCS bytes of a Move struct value. Only set for Move structs.

namestring

Name that identifies the type of the serialized value.

valuestring

Bytes of a BCS serialized value.

Package data if the object is a package.

storage_idstring

Package ObjectId (storage ID).

original_idstring

ID of the first published version.

versioninteger

Version of the package.

Modules in the package.

namestring

Name of the module.

contentsstring

Serialized bytecode.

Datatypes defined in the module.

type_namestring

Fully qualified type name.

defining_idstring

Package storage ID that defines the type.

modulestring

Module name.

namestring

Datatype name.

abilitiesarray

Abilities of the datatype.

Generic type parameters.

constraintsarray

Ability constraints on the parameter.

is_phantomboolean

Whether the parameter is phantom.

kindstring

Whether it is a struct or enum.

Fields of the datatype.

namestring

Name of the field.

positioninteger

Position in definition order.

Type of the field.

typeobject

The type.

type_namestring

Fully qualified datatype name.

type_parameter_instantiationarray

Instantiation of type parameters.

type_parameterinteger

Type parameter position.

Variants if the datatype is an enum.

namestring

Name of the variant.

positioninteger

Position in definition order.

Fields of the variant.

namestring

Name of the field.

positioninteger

Position in definition order.

Type of the field.

typeobject

The type.

type_namestring

Fully qualified datatype name.

type_parameter_instantiationarray

Instantiation of type parameters.

type_parameterinteger

Type parameter position.

Functions defined in the module.

namestring

Name of the function.

visibilitystring

Visibility (public/private/public(friend)).

is_entryboolean

Whether the function is an entry function.

Generic type parameters.

constraintsarray

Ability constraints on the parameter.

is_phantomboolean

Whether the parameter is phantom.

Parameter types.

referenceobject

Reference kind, if the type is a reference.

The signature body.

typeobject

The type.

type_namestring

Fully qualified datatype name.

type_parameter_instantiationarray

Instantiation of type parameters.

type_parameterinteger

Type parameter position.

Return types.

referenceobject

Reference kind, if the type is a reference.

The signature body.

typeobject

The type.

type_namestring

Fully qualified datatype name.

type_parameter_instantiationarray

Instantiation of type parameters.

type_parameterinteger

Type parameter position.

Type origins for the package's types.

module_namestring

Name of the defining module.

datatype_namestring

Name of the datatype.

package_idstring

Package ID where the type originated.

Transitive dependencies (linkage table).

original_idstring

Original package ID.

upgraded_idstring

Upgraded package ID.

upgraded_versioninteger

Upgraded package version.

previous_transactionstring

Digest of the transaction that created or last mutated this object.

storage_rebateinteger

Storage rebate for the object.

jsonobject

JSON rendering of the object.

balanceinteger

Current balance if this object is a 0x2::coin::Coin<T>.

Template-based display rendering.

outputobject

Substituted display fields.

errorsobject

Fields that failed to render.

next_page_tokenstring

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

X-API-KEY

grpcurl

grpcurl \
  -import-path . \
  -proto sui/rpc/v2/state_service.proto \
  -H 'X-API-KEY: nodit-demo' \
  -d '{
  "page_size": 50
}' \
  sui-mainnet.nodit.io:443 \
  sui.rpc.v2.StateService/ListOwnedObjects