SubscribeCheckpoints - Sui

SubscribeCheckpoints. Streams new checkpoints in real time.

SubscribeCheckpoints - sui [Value: 20CU]
Server-streaming subscription. Streams checkpoints as they are executed, starting from the latest checkpoint, optionally filtered by contained transactions.
gRPC: sui.rpc.v2.SubscriptionService/SubscribeCheckpoints
Use cases

Use cases

  • Follow the chain tip in real time
  • Trigger indexers on new checkpoints
  • Stream checkpoints touching an address
Constraints

Constraints

  • Starts at the current tip
  • No resumption, replay with ListCheckpoints
  • Runs until cancelled
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 '{
  "read_mask": "sequenceNumber,digest,summary.timestamp"
}' \
  grpc.drpc.live:443 \
  sui.rpc.v2.SubscriptionService/SubscribeCheckpoints
Copy
Response
200
{
  "cursor": "260411497",
  "checkpoint": {
    "sequence_number": "260411497",
    "digest": "5q8vR2tY7wZ3xC6bN9mK4jH1gF8dS5aP2oI7uE3yT6rW",
    "summary": { "timestamp": "2026-04-01T13:35:11.019Z" }
  }
}
{
  "cursor": "260411498",
  "checkpoint": {
    "sequence_number": "260411498",
    "digest": "8yU1iO4pA7sD0fG3hJ6kL9zX2cV5bN8mQ1wE4rT7yU0i",
    "summary": { "timestamp": "2026-04-01T13:35:11.287Z" }
  }
}
...
Copy

Request params

Parametersobject
object
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.
filterobject
Optional. Filter in disjunctive normal form: `terms` (OR) of `literals` (AND). Each literal sets one predicate: `sender`, `affected_address`, `affected_object`, `move_call`, `emit_module`, `event_type`, `event_stream_head` or `package_write`, and optional `negated`.

Response

200
An unbounded stream of frames, one per checkpoint (or progress frame on filtered streams).

Response params

object
cursorstring
Checkpoint sequence number the stream has fully covered (inclusive). Present on every frame.
checkpointobject
The matching checkpoint. Not set on progress-only frames of filtered streams.
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`.
Subscription ServiceSubscribeTransactions