Overview
Sui gRPC API provides high-performance access to network data through gRPC interfaces. It serves as a powerful tool for developers who need to:
- Access blockchain data with low latency
- Monitor on-chain activities and state changes
- Query account and object states efficiently
- Execute transactions with minimal overhead
Access
You can access Sui gRPC directly through your existing QuickNode Sui endpoint—no additional add-ons are needed. The gRPC services are available on port 9000, a dedicated and secure channel for gRPC communication.
Endpoint and Token Configuration
When connecting to Sui gRPC services, the port must be specified in the URL:
- Endpoint: The name of your endpoint followed by
.sui-mainnet.quiknode.pro
and the port number9000
(e.g.,https://docs-demo.sui-mainnet.quiknode.pro:9000
) - Token: The alphanumeric string that follows the endpoint name in the URL
For example, if your endpoint looks like this: https://docs-demo.sui-mainnet.quiknode.pro/123456789/
, then your authentication credentials would be:
- Endpoint:
https://docs-demo.sui-mainnet.quiknode.pro:9000
- Token:
123456789
Supported Services
Sui gRPC API includes the following services:
Ledger Service
- BatchGetObjects: Retrieves multiple objects in a single request
- BatchGetTransactions: Retrieves multiple transactions in a single request
- GetCheckpoint: Retrieves checkpoint information
- GetEpoch: Retrieves epoch information
- GetObject: Retrieves a single object
- GetServiceInfo: Retrieves service information
- GetTransaction: Retrieves a single transaction
Transaction Execution Service
- ExecuteTransaction: Executes a transaction on the Sui network
Making Sui gRPC Requests
To make requests to Sui gRPC using different languages, check out the method-specific documentation for each service. Each method includes examples in:
We ❤️ Feedback!
If you have any feedback or questions about this documentation, let us know. We'd love to hear from you!