Skip to main content
⚠️ This is the beta version of the Sui GraphQL schema. The beta schema will replace the alpha GraphQL schema upon its official release.

object

Fetch an object by its address.

If version is specified, the object will be fetched at that exact version.

If rootVersion is specified, the object will be fetched at the latest version at or before this version. This can be used to fetch a child or ancestor object bounded by its root object's version. For any wrapped or child (object-owned) object, its root object can be defined recursively as:

  • The root object of the object it is wrapped in, if it is wrapped.
  • The root object of its owner, if it is owned by another object.
  • The object itself, if it is not object-owned or wrapped.

If atCheckpoint is specified, the object will be fetched at the latest version as of this checkpoint. This will fail if the provided checkpoint is after the RPC's latest checkpoint.

If none of the above are specified, the object is fetched at the latest checkpoint.

It is an error to specify more than one of version, rootVersion, or atCheckpoint.

Returns null if an object cannot be found that meets this criteria.

object(
  address: SuiAddress!
  version: UInt53
  rootVersion: UInt53
  atCheckpoint: UInt53
): Object

Arguments​

object.address ● SuiAddress! non-null scalar​

object.version ● UInt53 scalar​

object.rootVersion ● UInt53 scalar​

object.atCheckpoint ● UInt53 scalar​

Type​

Object object​

An Object on Sui is either a typed value (a Move Object) or a Package (modules containing functions and types).

Every object on Sui is identified by a unique address, and has a version number that increases with every modification. Objects also hold metadata detailing their current owner (who can sign for access to the object and whether that access can modify and/or delete the object), and the digest of the last transaction that modified the object.