Skip to main content

GetObject gRPC Method

Retrieves a single object from the network by its object ID.

Updated on
Mar 26, 2026

Parameters

object_id
string
REQUIRED

The unique identifier (ObjectId) of the object to retrieve from the Sui blockchain.

read_mask
object

Field mask specifying which fields to include in the response.

paths
array

List of object fields to return (e.g., 'object_id', 'version', 'digest', 'owner', 'contents').

version
string

Request a specific version of the object. If no version is specified, and the object is live, then the latest version of the object is returned.

Returns

object
object

The object data containing all the requested fields.

bcs
object

The BCS (Binary Canonical Serialization) representation of the object.

name
string

The name of the BCS-serialized type.

value
string

Base64-encoded BCS-serialized content of the object.

objectId
string

The unique identifier of the object on-chain.

version
string

The version number of the object. Increments with each mutation.

digest
string

Cryptographic hash representing the object's current state.

owner
object

Ownership information of the object.

kind
string

Ownership type (e.g., 'SHARED', 'AddressOwner', 'ObjectOwner', 'Immutable').

version
string

Object version that defines shared ownership context.

objectType
string

Fully qualified Move type of the object (e.g., module::struct<type_args>).

hasPublicTransfer
boolean

Indicates whether the object supports public transfers without custom logic.

contents
object

Deserialized contents of the object in type-safe form.

name
string

Fully qualified name of the Move struct.

value
string

Base64-encoded raw value of the struct.

previousTransaction
string

Digest of the last transaction that mutated this object.

storageRebate
string

Amount of storage rebate (in MIST) that could be reclaimed by deleting this object.

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free