Sui Read API API is one of 11 APIs that Sui publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Read API. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
14 operations
across 14 paths,
and defines 97 schemas.
It is described by OpenAPI 3.2.0, at version 1.74.0.
Requests are made against 4 base URLs: https://fullnode.mainnet.sui.io:443, https://fullnode.testnet.sui.io:443, https://fullnode.devnet.sui.io:443, http://localhost:9000.
14 operations14 paths97 schemas14 POST
Metadata
The identity and technical contract details declared by the specification.
Across 14 paths, the API surfaces 14 operations — 14 POST. Each is listed below with its method, path, parameters, and response codes.
Read API 14
Methods for reading blockchain state
POST
/#sui_getChainIdentifier
suigetChainIdentifier
sui_getChainIdentifierbody→ 200
POST
/#sui_getCheckpoint
suigetCheckpoint
sui_getCheckpointbody→ 200
POST
/#sui_getCheckpoints
suigetCheckpoints
sui_getCheckpointsbody→ 200
POST
/#sui_getEvents
suigetEvents
sui_getEventsbody→ 200
POST
/#sui_getLatestCheckpointSequenceNumber
suigetLatestCheckpointSequenceNumber
sui_getLatestCheckpointSequenceNumberbody→ 200
POST
/#sui_getObject
suigetObject
sui_getObjectbody→ 200
POST
/#sui_getProtocolConfig
suigetProtocolConfig
sui_getProtocolConfigbody→ 200
POST
/#sui_getTotalTransactionBlocks
suigetTotalTransactionBlocks
sui_getTotalTransactionBlocksbody→ 200
POST
/#sui_getTransactionBlock
suigetTransactionBlock
sui_getTransactionBlockbody→ 200
POST
/#sui_multiGetObjects
suimultiGetObjects
sui_multiGetObjectsbody→ 200
POST
/#sui_multiGetTransactionBlocks
suimultiGetTransactionBlocks
sui_multiGetTransactionBlocksbody→ 200
POST
/#sui_tryGetPastObject
suitryGetPastObject
sui_tryGetPastObjectbody→ 200
POST
/#sui_tryMultiGetPastObjects
suitryMultiGetPastObjects
sui_tryMultiGetPastObjectsbody→ 200
POST
/#sui_verifyZkLoginSignature
suiverifyZkLoginSignature
sui_verifyZkLoginSignaturebody→ 200
Schemas 97
The contract defines 97 schemas that model the data the API accepts and returns. The most detailed are TransactionBlockResponse (12 properties), Checkpoint (11 properties), ObjectData (10 properties), Event (7 properties). Each schema is shown below with its type and property counts.
AdditionalConsensusStateDigest
TransactionDigest
A transaction will have a (unique) digest.
SuiTransaction
A single transaction in a programmable transaction block.
ConsensusCommitDigest
CheckpointArtifactsDigest
TypeOrigin
object
Identifies a struct and the module it was defined in
3 properties3 required
TransactionBlockData
ConsensusDeterminedVersionAssignments
Secp256r1SuiSignature
ZkLoginInputs
object
All inputs required for the zk login proof verification and other public inputs.
4 properties4 required
SuiAddress
ProtocolConfig
object
5 properties5 required
TransactionBlockResponse
object
12 properties1 required
MultiSigLegacy
object
Deprecated, use [struct MultiSig] instead. The struct that contains signatures and public keys necessary for authenticating a MultiSigLegacy.
3 properties3 required
MultiSig
object
The struct that contains signatures and public keys necessary for authenticating a MultiSig.
3 properties3 required
PasskeyAuthenticator
object
An passkey authenticator with parsed fields. See field defition below. Can be initialized from [struct RawPasskeyAuthenticator].
2 properties2 required
EventID
object
Unique ID of a Sui Event, the ID is a combination of transaction digest and event seq number.
2 properties2 required
ObjectData
object
10 properties3 required
GasCostSummary
object
Summary of the charges in a transaction. Storage is charged independently of computation. There are 3 parts to the storage charges: storagecost: it is the char…
4 properties4 required
TransactionBlock
object
2 properties2 required
SuiJsonValue
Event
object
7 properties6 required
ExecutionStatus
SuiActiveJwk
object
3 properties3 required
TransactionEventsDigest
CompressedSignature
Unlike [enum Signature], [enum CompressedSignature] does not contain public key.
MoveValue
CheckpointCommitment
ObjectRead
ZkLoginVerifyResult
object
2 properties2 required
BigInt_for_uint32
string
SuiReservation
SuiArgument
An argument to a transaction in a programmable transaction block
Digest
A representation of a 32 byte digest
AccumulatorEvent
object
5 properties5 required
PasskeyAuthenticatorAsBytes
Ed25519SuiSignature
SuiProgrammableMoveCall
object
The transaction for calling a Move function, either an entry function or a public function (which cannot return references).
5 properties3 required
GenericSignature
Due to the incompatibility of [enum Signature] (which dispatches a trait that assumes signature and pubkey bytes for verification), here we add a wrapper enum…
Bn254FqElement
string
A struct that stores a Bn254 Fq field element as 32 bytes.
SuiJwkId
object
2 properties2 required
MultiSigPublicKeyLegacy
object
Deprecated, use [struct MultiSigPublicKey] instead. The struct that contains the public key used for authenticating a MultiSig.
2 properties2 required
PublicKey
AuthorityPublicKeyBytes
Defines the compressed version of the public key that we pass around in Sui
BigInt_for_uint64
string
RawData
TypeTag
string
SuiJWK
object
4 properties4 required
ZkLoginAuthenticator
object
An zk login authenticator with all the necessary fields.
3 properties3 required
AccumulatorOperation
string
Claim
object
A claim consists of value and indexmod4.
2 properties2 required
Bn254FrElement
string
A struct that stores a Bn254 Fr field element as 32 bytes.
SuiAuthenticatorStateExpire
object
1 property1 required
SuiWithdrawFrom
string
MoveVariant
object
3 properties3 required
ObjectDigest
Base64
string
Base64 encoding
MultiSigPublicKey
object
The struct that contains the public key used for authenticating a MultiSig.
2 properties2 required
ObjectRef
object
3 properties3 required
SuiWithdrawalTypeArg
SuiChangeEpoch
object
5 properties5 required
CheckpointDigest
Representation of a Checkpoint's digest
UpgradeInfo
object
Upgraded package info for the linkage table
2 properties2 required
ProtocolConfigValue
GasData
object
4 properties4 required
SequenceNumber
integer
TransactionBlockEffects
AccumulatorValue
ZkLoginAuthenticatorAsBytes
TransactionBlockEffectsModifiedAtVersions
object
2 properties2 required
Owner
ObjectChange
ObjectChange are derived from the object mutations in the TransactionEffect to provide richer object information.
SuiEndOfEpochTransactionKind
Checkpoint
object
11 properties9 required
DisplayFieldsResponse
object
2 properties
Hex
string
Hex string encoding.
ProtocolVersion
Secp256k1SuiSignature
ECMHLiveObjectSetDigest
object
The Sha256 digest of an EllipticCurveMultisetHash committing to the live object set.
1 property1 required
Base58
string
SuiMoveAbort
object
4 properties
ObjectID
SuiCallArg
ZkLoginProof
object
The struct for zk login proof.
3 properties3 required
Signature
SequenceNumber2
BigInt_for_uint16
string
ZkLoginPublicIdentifier
A wrapper struct to retrofit in [enum PublicKey] for zkLogin. Useful to construct [struct MultiSigPublicKey].
BalanceChange
object
3 properties3 required
MoveStruct
Page_for_Checkpoint_and_BigInt_for_uint64
object
nextcursor points to the last item in the page; Reading with nextcursor will start from the next item after nextcursor if nextcursor is Some, otherwise it will…
3 properties2 required
ObjectResponseError
SuiObjectResponse
object
2 properties
Data
EndOfEpochData
object
3 properties3 required
TransactionBlockKind
OwnedObjectRef
object
2 properties2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Sui Read API API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
