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.

ObjectKey

Identifies a specific version of an object.

The address field must be specified, as well as at most one of version, rootVersion, or atCheckpoint. If none are provided, the object is fetched at the current checkpoint.

See Query.object for more details.

input ObjectKey {
  address: SuiAddress!
  version: UInt53
  rootVersion: UInt53
  atCheckpoint: UInt53
}

Fields​

ObjectKey.address ● SuiAddress! non-null scalar​

The object's ID.

ObjectKey.version ● UInt53 scalar​

If specified, tries to fetch the object at this exact version.

ObjectKey.rootVersion ● UInt53 scalar​

If specified, tries to fetch the latest version of the object 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.

ObjectKey.atCheckpoint ● UInt53 scalar​

If specified, tries to fetch the latest version as of this checkpoint. Fails if the checkpoint is later than the RPC's latest checkpoint.

Member Of​

multiGetObjects query