GetCheckpoint - Sui

GetCheckpoint. Returns a checkpoint by sequence number or digest, or the latest one.

GetCheckpoint - sui [Value: 20CU]
Returns a checkpoint by sequence number or digest. Returns the latest checkpoint if neither is set.
gRPC: sui.rpc.v2.LedgerService/GetCheckpoint
Use cases

Use cases

  • Read the latest checkpoint
  • Fetch checkpoint transactions
  • Read checkpoint summary
Constraints

Constraints

  • Set sequence_number or digest, not both
  • Default mask: sequence_number, digest
  • Old checkpoints may be pruned
Get started
Unlock Access to 100+ chains
Boost your app's speed and reliability with dRPC - get your access API key

Language

Request
Examples
grpcurl \
  -H "x-drpc-key: {API-KEY}" \
  -H "x-drpc-chain: sui" \
  -d '{
  "sequence_number": "164329987",
  "read_mask": "transactions"
}' \
  grpc.drpc.live:443 \
  sui.rpc.v2.LedgerService/GetCheckpoint
Copy
Response
200
{
  "checkpoint": {
    "transactions": [
      {
        "digest": "J4NvV5iQZQFm1xKPYv9ffDCCPW6cZ4yFKsCqFUiDX5L4",
        "transaction": { ... },
        "signatures": [ ... ],
        "effects": { ... },
        "events": { ... },
        "checkpoint": "164329987",
        "timestamp": "2025-07-14T10:21:37.512Z"
      },
      ...
    ]
  }
}
Copy

Request params

Parametersobject
object
sequence_numberstring
Optional. Sequence number of the checkpoint. Mutually exclusive with `digest`.
digeststring
Optional. Digest of the checkpoint. Mutually exclusive with `sequence_number`.
read_maskstring
Optional. google.protobuf.FieldMask with the fields to return, as comma-separated paths. Defaults to `sequence_number,digest`. Use `*` to return all fields.

Response

200
Returns a checkpoint by sequence number or digest. Returns the latest checkpoint if neither is set.

Response params

object
checkpointobject
The checkpoint. Only fields included in `read_mask` are populated.
object
sequence_numberstring
The checkpoint sequence number.
digeststring
Digest of the checkpoint summary.
summaryobject
Checkpoint summary.
object
epochstring
Epoch of the checkpoint.
sequence_numberstring
Sequence number of the checkpoint.
total_network_transactionsstring
Total number of transactions committed since genesis, including this checkpoint.
content_digeststring
Digest of the checkpoint contents.
previous_digeststring
Digest of the previous checkpoint.
epoch_rolling_gas_cost_summaryobject
Running total of gas costs in the epoch.
timestampstring
Timestamp of the checkpoint (RFC 3339).
end_of_epoch_dataobject
Only present in the final checkpoint of an epoch.
signatureobject
Aggregated quorum signature from the validator committee that certified the checkpoint.
contentsobject
Checkpoint contents: the set of transactions committed to in the checkpoint.
transactionsarray_of_objects
Transactions included in the checkpoint.
objectsobject
Objects referenced as inputs or produced as outputs by the checkpoint's transactions. When requested, objects appear here and not in `transactions.objects`.
BatchGetTransactionsGetEpoch