Skip to main content

References

Reference documentation for the Sui platform, including API specifications (gRPC, GraphQL), CLI commands, Move framework modules, SDK guides, and IDE tooling.

What does Sui reference documentation cover?​

Sui reference documentation covers the low-level details you need when building on Sui. Use these references to look up exact method signatures, CLI flags, Move module definitions, and API schemas without reading through conceptual guides.

The reference documentation includes:

  • API specifications: gRPC and GraphQL RPC schemas for querying chain state, submitting transactions, and subscribing to events.
  • CLI commands: Full flag and argument listings for the Sui CLI, including client, keytool, move, and validator subcommands.
  • Move framework modules: Module-level documentation for the Sui Move framework, including types, functions, and constants defined in sui-framework and move-stdlib.
  • SDKs: GitHub repos for the Sui TypeScript SDK, Rust SDK, and Sui dApp Kit.
  • IDE tooling: Setup and configuration details for Move language support in editors such as VS Code.

How to use these references​

Find the section that matches your current task and go directly to the relevant entry.

For example, if you want to query owned objects for an address using the GraphQL RPC, you look up the address query in the GraphQL reference, check the available fields on the ObjectConnection type, and construct your query:

query {
  address(address: "0xYOUR_ADDRESS") {
    objects {
      nodes {
        objectId
        digest
        type {
          repr
        }
      }
    }
  }
}

If you want to publish a Move package from the CLI, you look up the client publish command to confirm required flags:

sui client publish --gas-budget 100000000

Which reference should you use?​

The right reference depends on how your application interacts with Sui:

  • Use the GraphQL RPC reference when querying historical or current chain state from a frontend or backend service.
  • Use the CLI reference when scripting deployments, managing keys, or running administrative commands.
  • Use the Move framework reference when writing smart contracts and looking up built-in types or functions.
  • Use the SDK reference when integrating Sui into a TypeScript or Rust application.