Get checkpoint

POST

https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/GetCheckpoint

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Returns a checkpoint.

If neither sequenceNumber nor digest is provided, the latest checkpoint is returned.

gRPC method: sui.rpc.v2.LedgerService.GetCheckpoint (unary).

This is a gRPC method (HTTP/2, Protocol Buffers), not a REST endpoint. The request and response bodies below are shown in the proto3 JSON form that tools such as grpcurl and Postman accept and print. Pass your NOWNodes API key as the api-key gRPC metadata header. Proto files: sui/rpc/v2/ledger_service.proto.

Example grpcurl request:

Copied!

grpcurl \
  -insecure \
  -H 'api-key: YOUR_API_KEY' \
  -emit-defaults \
  -proto './sui-apis-grpc/proto/sui/rpc/v2/ledger_service.proto' \
  -import-path './sui-apis-grpc/proto' \
  -d '{}' \
  'sui-grpc.nownodes.io' \
  sui.rpc.v2.LedgerService.GetCheckpoint

Body

application/json

Only one of sequenceNumber, digest may be set.

sequenceNumberstring<uint64>

The sequence number of the requested checkpoint.

digeststring

The digest of the requested checkpoint.

readMaskobject

Mask specifying which fields to read. If no mask is specified, defaults to sequence_number,digest. Read mask: list of field paths to return, in snake_case (e.g. "object_id", "version", "digest"). Nested fields use dots (e.g. "effects.status").

Show child attributes

pathsArray<string>required

Field paths to return.

Response

200OK

Successful response.

default

gRPC error. The status code (e.g. UNAUTHENTICATED, INVALID_ARGUMENT, NOT_FOUND) is returned in the grpc-status trailer, details in grpc-message.

Get checkpoint

curl -X POST 'https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/GetCheckpoint' \
  -H 'Content-Type: application/json' \
  -d '{
    "sequenceNumber": "string",
    "digest": "string",
    "readMask": {
      "paths": [
        "string"
      ]
    }
  }'

const response = await fetch('https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/GetCheckpoint', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "sequenceNumber": "string",
      "digest": "string",
      "readMask": {
        "paths": [
          "string"
        ]
      }
    }),
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/GetCheckpoint')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "sequenceNumber": "string",
    "digest": "string",
    "readMask": {
      "paths": [
        "string"
      ]
    }
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

import requests

payload = {
  "sequenceNumber": "string",
  "digest": "string",
  "readMask": {
    "paths": [
      "string"
    ]
  }
}

response = requests.post('https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/GetCheckpoint', json=payload)
data = response.json()

const response = await fetch('https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/GetCheckpoint', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "sequenceNumber": "string",
      "digest": "string",
      "readMask": {
        "paths": [
          "string"
        ]
      }
    }),
});

const data = await response.json();

const endpoint = "https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/GetCheckpoint";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest({
    "sequenceNumber": "string",
    "digest": "string",
    "readMask": {
      "paths": [
        "string"
      ]
    }
  });
console.log(result);

const response = await fetch('https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/GetCheckpoint', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "sequenceNumber": "string",
      "digest": "string",
      "readMask": {
        "paths": [
          "string"
        ]
      }
    }),
});

const data = await response.json();

import requests

payload = {
  "sequenceNumber": "string",
  "digest": "string",
  "readMask": {
    "paths": [
      "string"
    ]
  }
}

response = requests.post('https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/GetCheckpoint', json=payload)
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/GetCheckpoint')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "sequenceNumber": "string",
    "digest": "string",
    "readMask": {
      "paths": [
        "string"
      ]
    }
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

Request Body

{}

{
  "sequenceNumber": "1000"
}

{
  "digest": "CHECKPOINT_DIGEST"
}

{
  "sequenceNumber": "1000",
  "readMask": {
    "paths": [
      "sequence_number",
      "digest",
      "timestamp"
    ]
  }
}