Skip to main content

GraphQL for Sui RPC

GraphQL for the Sui RPC is a public service that enables interacting with the Sui network.

To get started with GraphQL for the Sui RPC, check out the Getting Started guide. If you'd like to learn more about the concepts used in the GraphQL service, check out the GraphQL for Sui RPC concepts page.

Key Types

All GraphQL API elements are accessible via the left sidebar, the following are good starting points to explore from.

  • "Queries" lists all top-level queries for reading the chain state, from reading details about addresses and objects to dryRunTransactionBlock, which has an execution-like interface but does not modify the chain.
  • "Mutations" lists operations that can modify chain state, like executeTransactionBlock.
  • Object is the type representing all on-chain objects (Move values and packages).
  • Address corresponds to account addresses (derived from the public keys of signatures that sign transactions) and can be used to query the objects owned by these accounts and the transactions they have signed or been affected by.
  • Owner represents any entity that can own a MoveObject to handle cases where it is not known whether the owner is an Object or an Address (for example, from the perspective of a Move object looking at its owner).
  • GraphQL migration: Migrating to GraphQL guides you through migrating Sui RPC projects from JSON-RPC to GraphQL.
  • GraphQL quick-start: Querying Sui RPC with GraphQL gets you started using GraphQL to query the Sui RPC for on-chain data.
  • GraphQL concepts: GraphQL for Sui RPC examines the elements of GraphQL that you should know to get the most from the service.