How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Sui Extended API API

Extended query methods (suix_ prefix)

Sui Extended 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 Extended API. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 9 paths, and defines 91 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.

9 operations 9 paths 91 schemas 9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.74.0
Base URL
https://fullnode.mainnet.sui.io:443
License
Resource Areas
1

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 9 POST. Each is listed below with its method, path, parameters, and response codes.

Extended API 9

Extended query methods (suix prefix)

POST
/#suix_getDynamicFieldObject
suixgetDynamicFieldObject
suix_getDynamicFieldObject body → 200
POST
/#suix_getDynamicFields
suixgetDynamicFields
suix_getDynamicFields body → 200
POST
/#suix_getOwnedObjects
suixgetOwnedObjects
suix_getOwnedObjects body → 200
POST
/#suix_queryEvents
suixqueryEvents
suix_queryEvents body → 200
POST
/#suix_queryTransactionBlocks
suixqueryTransactionBlocks
suix_queryTransactionBlocks body → 200
POST
/#suix_resolveNameServiceAddress
suixresolveNameServiceAddress
suix_resolveNameServiceAddress body → 200
POST
/#suix_resolveNameServiceNames
suixresolveNameServiceNames
suix_resolveNameServiceNames body → 200
POST
/#suix_subscribeEvent
suixsubscribeEvent
suix_subscribeEvent body → 200
POST
/#suix_subscribeTransaction
suixsubscribeTransaction
suix_subscribeTransaction body → 200

Schemas 91

The contract defines 91 schemas that model the data the API accepts and returns. The most detailed are TransactionBlockResponse (12 properties), ObjectData (10 properties), Event (7 properties), DynamicFieldInfo (6 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
TypeOrigin
object
Identifies a struct and the module it was defined in
3 properties 3 required
TransactionBlockData
ConsensusDeterminedVersionAssignments
Secp256r1SuiSignature
ZkLoginInputs
object
All inputs required for the zk login proof verification and other public inputs.
4 properties 4 required
SuiAddress
TransactionBlockResponse
object
12 properties 1 required
MultiSigLegacy
object
Deprecated, use [struct MultiSig] instead. The struct that contains signatures and public keys necessary for authenticating a MultiSigLegacy.
3 properties 3 required
MultiSig
object
The struct that contains signatures and public keys necessary for authenticating a MultiSig.
3 properties 3 required
PasskeyAuthenticator
object
An passkey authenticator with parsed fields. See field defition below. Can be initialized from [struct RawPasskeyAuthenticator].
2 properties 2 required
EventID
object
Unique ID of a Sui Event, the ID is a combination of transaction digest and event seq number.
2 properties 2 required
ObjectData
object
10 properties 3 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 properties 4 required
TransactionBlock
object
2 properties 2 required
SuiJsonValue
Event
object
7 properties 6 required
ExecutionStatus
SuiActiveJwk
object
3 properties 3 required
Page_for_SuiObjectResponse_and_ObjectID
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 properties 2 required
TransactionEventsDigest
CompressedSignature
Unlike [enum Signature], [enum CompressedSignature] does not contain public key.
DynamicFieldInfo
object
6 properties 6 required
MoveValue
Page_for_Event_and_EventID
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 properties 2 required
DynamicFieldName
object
2 properties 2 required
SuiReservation
SuiArgument
An argument to a transaction in a programmable transaction block
Digest
A representation of a 32 byte digest
AccumulatorEvent
object
5 properties 5 required
Page_for_String_and_ObjectID
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 properties 2 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 properties 3 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 properties 2 required
MultiSigPublicKeyLegacy
object
Deprecated, use [struct MultiSigPublicKey] instead. The struct that contains the public key used for authenticating a MultiSig.
2 properties 2 required
PublicKey
BigInt_for_uint64
string
RawData
TypeTag
string
SuiJWK
object
4 properties 4 required
ZkLoginAuthenticator
object
An zk login authenticator with all the necessary fields.
3 properties 3 required
AccumulatorOperation
string
SuiWithdrawFrom
string
Claim
object
A claim consists of value and indexmod4.
2 properties 2 required
SuiAuthenticatorStateExpire
object
1 property 1 required
Bn254FrElement
string
A struct that stores a Bn254 Fr field element as 32 bytes.
MoveVariant
object
3 properties 3 required
ObjectDigest
Base64
string
Base64 encoding
MultiSigPublicKey
object
The struct that contains the public key used for authenticating a MultiSig.
2 properties 2 required
ObjectRef
object
3 properties 3 required
SuiWithdrawalTypeArg
SuiChangeEpoch
object
5 properties 5 required
Page_for_DynamicFieldInfo_and_ObjectID
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 properties 2 required
CheckpointDigest
Representation of a Checkpoint's digest
UpgradeInfo
object
Upgraded package info for the linkage table
2 properties 2 required
Page_for_TransactionBlockResponse_and_TransactionDigest
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 properties 2 required
SequenceNumber
integer
GasData
object
4 properties 4 required
TransactionBlockEffects
AccumulatorValue
ZkLoginAuthenticatorAsBytes
DynamicFieldType
string
TransactionBlockEffectsModifiedAtVersions
object
2 properties 2 required
Owner
ObjectChange
ObjectChange are derived from the object mutations in the TransactionEffect to provide richer object information.
SuiEndOfEpochTransactionKind
DisplayFieldsResponse
object
2 properties
Hex
string
Hex string encoding.
Secp256k1SuiSignature
Base58
string
SuiMoveAbort
object
4 properties
ObjectID
SuiCallArg
ZkLoginProof
object
The struct for zk login proof.
3 properties 3 required
Signature
SequenceNumber2
ZkLoginPublicIdentifier
A wrapper struct to retrofit in [enum PublicKey] for zkLogin. Useful to construct [struct MultiSigPublicKey].
BalanceChange
object
3 properties 3 required
MoveStruct
ObjectResponseError
SuiObjectResponse
object
2 properties
Data
TransactionBlockKind
OwnedObjectRef
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sui-extended-api-api-openapi.yml Raw ↑

Other APIs Sui publishes across the network.

Sui GraphQL RPC
Sui JSON-RPC API (Deprecated)
Sui Coin Query API API
Sui Governance Read API API
Sui Move Utils API
Sui PubSub API
Sui Read API API
Sui Transaction Builder API API
Sui Websocket API
Sui Write API API
Where this information came from

This is an independent, third-party profile of Sui Extended 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.