Request schema
{
"type": "object",
"properties": {
"method": {
"type": "string",
"description": "JSON-RPC read method, e.g. sui_getObject",
"examples": [
"rpc.discover",
"sui_devInspectTransactionBlock",
"sui_dryRunTransactionBlock",
"sui_getChainIdentifier",
"sui_getCheckpoint",
"sui_getCheckpoints",
"sui_getEvents",
"sui_getLatestCheckpointSequenceNumber",
"sui_getMoveFunctionArgTypes",
"sui_getNormalizedMoveFunction",
"sui_getNormalizedMoveModule",
"sui_getNormalizedMoveModulesByPackage",
"sui_getNormalizedMoveStruct",
"sui_getObject",
"sui_getProtocolConfig",
"sui_getTotalTransactionBlocks",
"sui_getTransactionBlock",
"sui_multiGetObjects",
"sui_multiGetTransactionBlocks",
"sui_tryGetPastObject",
"sui_tryMultiGetPastObjects",
"suix_getAllBalances",
"suix_getAllCoins",
"suix_getBalance",
"suix_getCoinMetadata",
"suix_getCoins",
"suix_getCommitteeInfo",
"suix_getDynamicFieldObject",
"suix_getDynamicFields",
"suix_getLatestSuiSystemState",
"suix_getOwnedObjects",
"suix_getReferenceGasPrice",
"suix_getStakes",
"suix_getStakesByIds",
"suix_getTotalSupply",
"suix_getValidatorsApy",
"suix_queryEvents",
"suix_queryTransactionBlocks",
"suix_resolveNameServiceAddress",
"suix_resolveNameServiceNames"
]
},
"params": {
"description": "Parameters per the Sui JSON-RPC spec"
}
},
"required": [
"method"
]
}
Response schema
{
"type": "object",
"description": "JSON-RPC 2.0 response envelope. Exactly one of `result` or `error` is present. `result` takes the shape the called method defines per the Sui JSON-RPC specification; object and transaction reads return `data` with the fields the request's options asked for.",
"properties": {
"jsonrpc": {
"type": "string",
"description": "The protocol version, always \"2.0\""
},
"id": {
"type": [
"string",
"number",
"null"
],
"description": "The request id, echoed back"
},
"result": {
"description": "The method's result, in the shape the called method defines. Present when the call succeeded; absent when `error` is."
},
"error": {
"type": "object",
"description": "Present instead of `result` when the call failed",
"properties": {
"code": {
"type": "integer",
"description": "A JSON-RPC 2.0 error code"
},
"message": {
"type": "string"
},
"data": {
"description": "Method-specific detail, when the node supplies it"
}
}
}
},
"examples": [
{
"jsonrpc": "2.0",
"id": 1,
"result": "35834a8a"
}
]
}