Home

Get epoch

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

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Returns epoch information.

If no epoch is provided, the current epoch is returned.

gRPC method: sui.rpc.v2.LedgerService.GetEpoch (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.GetEpoch

Body

application/json
epochstring<uint64>

The requested epoch. If no epoch is provided the current epoch will be returned.

readMaskobject

Mask specifying which fields to read. If no mask is specified, defaults to epoch. 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.