Console

gRPCGetEpoch

sui-mainnet.nodit.io:443 sui.rpc.v2.LedgerService/GetEpochunary

Retrieves the information of the specified epoch. Returns the current epoch if no epoch is specified.

TransportgRPC

Request and response messages are identical for both transports. Only the wire protocol, headers, and client library differ.

Protocol
Native gRPC over HTTP/2 with TLS. Suited to server-side clients and grpcurl.
Content-Type
application/grpc
Headers
x-api-key
Streaming
Server, client, and bidirectional streaming are all supported.
Errors
grpc-status and grpc-message are delivered as HTTP/2 trailers.
Request Body
epochinteger

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

pathsstring[]

The set of field mask paths (e.g. "object_id", "version", "digest").

Responses
epochinteger

Epoch number.

committeeobject

Validator committee for the epoch.

epochinteger

The epoch where this committee governs.

membersobject[]

The committee members.

public_keystring

The 96-byte Bls12381 public key for this validator.

weightinteger

Voting weight this validator possesses.

system_stateobject

Snapshot of the system state.

versioninteger

Version of the data structure.

epochinteger

Current epoch.

protocol_versioninteger

Current protocol version.

validatorsobject

The validator set.

total_stakeinteger

Total stake across the set.

active_validatorsobject[]

Currently active validators.

namestring

Human-readable name.

addressstring

Sui address of the validator.

descriptionstring

Description of the validator.

image_urlstring

Image URL.

project_urlstring

Project URL.

protocol_public_keystring

Protocol public key.

proof_of_possessionstring

Proof of possession.

network_public_keystring

Network public key.

worker_public_keystring

Worker public key.

network_addressstring

Network address.

p2p_addressstring

P2P address.

primary_addressstring

Primary address.

worker_addressstring

Worker address.

next_epoch_protocol_public_keystring

Next-epoch protocol public key.

next_epoch_proof_of_possessionstring

Next-epoch proof of possession.

next_epoch_network_public_keystring

Next-epoch network public key.

next_epoch_worker_public_keystring

Next-epoch worker public key.

next_epoch_network_addressstring

Next-epoch network address.

next_epoch_p2p_addressstring

Next-epoch P2P address.

next_epoch_primary_addressstring

Next-epoch primary address.

next_epoch_worker_addressstring

Next-epoch worker address.

metadata_extra_fieldsobject

Additional metadata fields.

voting_powerinteger

Voting power of the validator.

operation_cap_idstring

Operation capability ObjectId.

gas_priceinteger

Gas price set by the validator.

staking_poolobject

The validator's staking pool.

commission_rateinteger

Commission rate in basis points.

next_epoch_stakeinteger

Stake for the next epoch.

next_epoch_gas_priceinteger

Gas price for the next epoch.

next_epoch_commission_rateinteger

Commission rate for the next epoch.

extra_fieldsobject

Additional extensible fields.

pending_active_validatorsobject

Validators pending activation.

idstring

UID of the Table or Bag.

sizeinteger

Number of key-value pairs.

pending_removalsinteger[]

Indices of validators pending removal.

staking_pool_mappingsobject

Mapping of staking pools.

idstring

UID of the Table or Bag.

sizeinteger

Number of key-value pairs.

inactive_validatorsobject

Inactive validators.

idstring

UID of the Table or Bag.

sizeinteger

Number of key-value pairs.

validator_candidatesobject

Validator candidates.

idstring

UID of the Table or Bag.

sizeinteger

Number of key-value pairs.

at_risk_validatorsobject[]

At-risk validators.

keystring

Address of the at-risk validator.

valueinteger

Number of epochs at risk.

extra_fieldsobject

Additional extensible fields.

idstring

UID of the Table or Bag.

sizeinteger

Number of key-value pairs.

storage_fundobject

The storage fund.

total_object_storage_rebatesinteger

Total object storage rebates.

non_refundable_balanceinteger

Non-refundable balance.

parametersobject

System parameters.

epoch_duration_msinteger

Epoch duration in milliseconds.

stake_subsidy_start_epochinteger

Epoch at which stake subsidy starts.

min_validator_countinteger

Minimum number of validators.

max_validator_countinteger

Maximum number of validators.

min_validator_joining_stakeinteger

Deprecated. Minimum stake required to join.

validator_low_stake_thresholdinteger

Deprecated. Low stake threshold.

validator_very_low_stake_thresholdinteger

Deprecated. Very low stake threshold.

validator_low_stake_grace_periodinteger

Grace period for low-stake validators.

extra_fieldsobject

Additional extensible fields.

idstring

UID of the Table or Bag.

sizeinteger

Number of key-value pairs.

reference_gas_priceinteger

Reference gas price.

validator_report_recordsobject[]

Validator report records.

reportedstring

Address of the reported validator.

reportersstring[]

Addresses of the reporting validators.

stake_subsidyobject

Stake subsidy information.

balanceinteger

Reserved SUI balance for subsidies.

distribution_counterinteger

Number of distributions made.

current_distribution_amountinteger

Current distribution amount.

stake_subsidy_period_lengthinteger

Length of a subsidy period.

stake_subsidy_decrease_rateinteger

Decrease rate in basis points.

extra_fieldsobject

Additional extensible fields.

idstring

UID of the Table or Bag.

sizeinteger

Number of key-value pairs.

safe_modeboolean

Whether the system is in safe mode.

safe_mode_storage_rewardsinteger

Storage rewards accrued in safe mode.

safe_mode_computation_rewardsinteger

Computation rewards accrued in safe mode.

safe_mode_storage_rebatesinteger

Storage rebates accrued in safe mode.

safe_mode_non_refundable_storage_feeinteger

Non-refundable storage fee accrued in safe mode.

epoch_start_timestamp_msinteger

Epoch start timestamp in milliseconds.

extra_fieldsobject

Additional extensible fields.

idstring

UID of the Table or Bag.

sizeinteger

Number of key-value pairs.

first_checkpointinteger

First checkpoint of the epoch.

last_checkpointinteger

Last checkpoint of the epoch.

startstring

Start timestamp of the epoch.

endstring

End timestamp of the epoch.

reference_gas_priceinteger

Reference gas price, denominated in MIST.

protocol_configobject

Protocol configuration for the epoch.

protocol_versioninteger

Protocol version.

feature_flagsobject[]

Feature flag toggles.

keystring

Flag name.

valueboolean

Whether the flag is enabled.

attributesobject[]

Configuration attributes.

keystring

Attribute key.

valuestring

Attribute value.

X-API-KEY
RequestCU20
grpcurl
grpcurl \
  -import-path . -proto sui/rpc/v2/ledger_service.proto \
  -H "X-API-KEY: {YOUR_API_KEY}" \
  -d '{
  "epoch": 100,
  "read_mask": {
    "paths": []
  }
}' \
  sui-mainnet.nodit.io:443 sui.rpc.v2.LedgerService/GetEpoch
Response
Example · 200
{
  "epoch": {}
}

Last updated