{ "openapi": "3.0.3", "info": { "title": "IOTA JSON-RPC API", "description": "IOTA JSON-RPC API for interaction with IOTA full node or indexer. All requests are HTTP POST to the node endpoint. Covers iota_ (Read, Write, Move Utils), iotax_ (Extended, Coin Query, Governance), and unsafe_ (Transaction Builder) method namespaces.", "version": "1.26.0-alpha", "contact": { "name": "IOTA Foundation", "email": "info@iota.org", "url": "https://docs.iota.org/" }, "license": { "name": "Apache-2.0", "url": "https://opensource.org/licenses/Apache-2.0" }, "x-openrpc-source": "https://raw.githubusercontent.com/iotaledger/iota/develop/crates/iota-open-rpc/spec/openrpc.json" }, "externalDocs": { "description": "IOTA API Reference", "url": "https://docs.iota.org/iota-api-ref" }, "servers": [ { "url": "https://api.mainnet.iota.cafe", "description": "IOTA Mainnet full node" }, { "url": "https://api.testnet.iota.cafe", "description": "IOTA Testnet full node" }, { "url": "https://api.devnet.iota.cafe", "description": "IOTA Devnet full node" }, { "url": "https://indexer.mainnet.iota.cafe", "description": "IOTA Mainnet indexer (iotax_ methods)" }, { "url": "https://indexer.testnet.iota.cafe", "description": "IOTA Testnet indexer (iotax_ methods)" } ], "tags": [ { "name": "Read", "description": "Core read operations: objects, checkpoints, transactions, events, protocol config" }, { "name": "Write", "description": "Transaction execution, dry run, and dev inspection" }, { "name": "Move Utils", "description": "Move smart contract introspection: modules, functions, structs" }, { "name": "Extended", "description": "Indexer-exclusive methods for advanced queries, events, dynamic fields, IOTA Names" }, { "name": "Coin Query", "description": "Coin and balance queries: balances, coins list, metadata, supply" }, { "name": "Governance", "description": "Governance, staking, validator, epoch, and system state queries" }, { "name": "Transaction Builder", "description": "Build unsigned transactions for transfers, staking, Move calls (unsafe_ prefix)" } ], "paths": { "/iota_devInspectTransactionBlock": { "post": { "operationId": "iota_devInspectTransactionBlock", "summary": "iota_devInspectTransactionBlock", "description": "Runs the transaction in dev-inspect mode. Which allows for nearly any transaction (or Move call) with any arguments. Detailed results are provided, including both the transaction effects and any return values.", "tags": [ "Write" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_devInspectTransactionBlock" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_devInspectTransactionBlock", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/DevInspectResults" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_dryRunTransactionBlock": { "post": { "operationId": "iota_dryRunTransactionBlock", "summary": "iota_dryRunTransactionBlock", "description": "Return transaction execution effects including the gas cost summary, while the effects are not committed to the chain.", "tags": [ "Write" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_dryRunTransactionBlock" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_dryRunTransactionBlock", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/DryRunTransactionBlockResponse" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_executeTransactionBlock": { "post": { "operationId": "iota_executeTransactionBlock", "summary": "iota_executeTransactionBlock", "description": "Execute the transaction and wait for results if desired. Request types: 1. WaitForEffectsCert: waits for TransactionEffectsCert and then return to client. This mode is a proxy for transaction finality. 2. WaitForLocalExecution: waits for TransactionEffectsCert and make sure the node executed the transaction locally before returning the client. The local execution makes sure this node is aware of this transaction when client fires subsequent queries. However if the node fails to execute the transaction locally in a timely manner, a bool type in the response is set to false to indicated the case. request_type is default to be `WaitForEffectsCert` unless options.show_events or options.show_effects is true", "tags": [ "Write" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_executeTransactionBlock" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_executeTransactionBlock", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/TransactionBlockResponse" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_getChainIdentifier": { "post": { "operationId": "iota_getChainIdentifier", "summary": "iota_getChainIdentifier", "description": "Return the first four bytes of the chain's genesis checkpoint digest.", "tags": [ "Read" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_getChainIdentifier" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_getChainIdentifier", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "type": "string" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_getCheckpoint": { "post": { "operationId": "iota_getCheckpoint", "summary": "iota_getCheckpoint", "description": "Return a checkpoint", "tags": [ "Read" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_getCheckpoint" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_getCheckpoint", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/Checkpoint" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_getCheckpoints": { "post": { "operationId": "iota_getCheckpoints", "summary": "iota_getCheckpoints", "description": "Return paginated list of checkpoints", "tags": [ "Read" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_getCheckpoints" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_getCheckpoints", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/Page_for_Checkpoint_and_String" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_getEvents": { "post": { "operationId": "iota_getEvents", "summary": "iota_getEvents", "description": "Return transaction events.", "tags": [ "Read" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_getEvents" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_getEvents", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_getLatestCheckpointSequenceNumber": { "post": { "operationId": "iota_getLatestCheckpointSequenceNumber", "summary": "iota_getLatestCheckpointSequenceNumber", "description": "Return the sequence number of the latest checkpoint that has been executed", "tags": [ "Read" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_getLatestCheckpointSequenceNumber" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_getLatestCheckpointSequenceNumber", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "type": "string" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_getMoveFunctionArgTypes": { "post": { "operationId": "iota_getMoveFunctionArgTypes", "summary": "iota_getMoveFunctionArgTypes", "description": "Return the argument types of a Move function, based on normalized Type.", "tags": [ "Move Utils" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_getMoveFunctionArgTypes" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_getMoveFunctionArgTypes", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/MoveFunctionArgType" } } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_getNormalizedMoveFunction": { "post": { "operationId": "iota_getNormalizedMoveFunction", "summary": "iota_getNormalizedMoveFunction", "description": "Return a structured representation of Move function", "tags": [ "Move Utils" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_getNormalizedMoveFunction" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_getNormalizedMoveFunction", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/IotaMoveNormalizedFunction" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_getNormalizedMoveModule": { "post": { "operationId": "iota_getNormalizedMoveModule", "summary": "iota_getNormalizedMoveModule", "description": "Return a structured representation of Move module", "tags": [ "Move Utils" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_getNormalizedMoveModule" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_getNormalizedMoveModule", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/IotaMoveNormalizedModule" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_getNormalizedMoveModulesByPackage": { "post": { "operationId": "iota_getNormalizedMoveModulesByPackage", "summary": "iota_getNormalizedMoveModulesByPackage", "description": "Return structured representations of all modules in the given package", "tags": [ "Move Utils" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_getNormalizedMoveModulesByPackage" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_getNormalizedMoveModulesByPackage", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/IotaMoveNormalizedModule" } } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_getNormalizedMoveStruct": { "post": { "operationId": "iota_getNormalizedMoveStruct", "summary": "iota_getNormalizedMoveStruct", "description": "Return a structured representation of Move struct", "tags": [ "Move Utils" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_getNormalizedMoveStruct" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_getNormalizedMoveStruct", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/IotaMoveNormalizedStruct" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_getObject": { "post": { "operationId": "iota_getObject", "summary": "iota_getObject", "description": "Return the object information for a specified object", "tags": [ "Read" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_getObject" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_getObject", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/IotaObjectResponse" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_getProtocolConfig": { "post": { "operationId": "iota_getProtocolConfig", "summary": "iota_getProtocolConfig", "description": "Return the protocol config table for the given version number. If the version number is not specified, If none is specified, the node uses the version of the latest epoch it has processed.", "tags": [ "Read" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_getProtocolConfig" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_getProtocolConfig", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/ProtocolConfig" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_getTotalTransactionBlocks": { "post": { "operationId": "iota_getTotalTransactionBlocks", "summary": "iota_getTotalTransactionBlocks", "description": "Return the total number of transaction blocks known to the server.", "tags": [ "Write" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_getTotalTransactionBlocks" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_getTotalTransactionBlocks", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "type": "string" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_getTransactionBlock": { "post": { "operationId": "iota_getTransactionBlock", "summary": "iota_getTransactionBlock", "description": "Return the transaction response object.", "tags": [ "Write" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_getTransactionBlock" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_getTransactionBlock", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/TransactionBlockResponse" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_isTransactionIndexedOnNode": { "post": { "operationId": "iota_isTransactionIndexedOnNode", "summary": "iota_isTransactionIndexedOnNode", "description": "Return if the transaction has been indexed on the fullnode.", "tags": [ "Write" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_isTransactionIndexedOnNode" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_isTransactionIndexedOnNode", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "type": "boolean" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_multiGetObjects": { "post": { "operationId": "iota_multiGetObjects", "summary": "iota_multiGetObjects", "description": "Return the object data for a list of objects", "tags": [ "Read" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_multiGetObjects" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_multiGetObjects", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/IotaObjectResponse" } } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_multiGetTransactionBlocks": { "post": { "operationId": "iota_multiGetTransactionBlocks", "summary": "iota_multiGetTransactionBlocks", "description": "Returns an ordered list of transaction responses The method will throw an error if the input contains any duplicate or the input size exceeds QUERY_MAX_RESULT_LIMIT", "tags": [ "Write" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_multiGetTransactionBlocks" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_multiGetTransactionBlocks", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionBlockResponse" } } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_tryGetPastObject": { "post": { "operationId": "iota_tryGetPastObject", "summary": "iota_tryGetPastObject", "description": "Note there is no software-level guarantee/SLA that objects with past versions can be retrieved by this API, even if the object and version exists/existed. The result may vary across nodes depending on their pruning policies. Return the object information for a specified version", "tags": [ "Read" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_tryGetPastObject" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_tryGetPastObject", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/ObjectRead" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_tryMultiGetPastObjects": { "post": { "operationId": "iota_tryMultiGetPastObjects", "summary": "iota_tryMultiGetPastObjects", "description": "Note there is no software-level guarantee/SLA that objects with past versions can be retrieved by this API, even if the object and version exists/existed. The result may vary across nodes depending on their pruning policies. Return the object information for a specified version", "tags": [ "Read" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_tryMultiGetPastObjects" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_tryMultiGetPastObjects", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRead" } } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iota_view": { "post": { "operationId": "iota_view", "summary": "iota_view", "description": "Calls a move view function.", "tags": [ "Read" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iota_view" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iota_view", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/IotaMoveViewCallResults" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getAllBalances": { "post": { "operationId": "iotax_getAllBalances", "summary": "iotax_getAllBalances", "description": "Return the total coin balance for all coin type, owned by the address owner.", "tags": [ "Coin Query" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getAllBalances" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getAllBalances", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/Balance" } } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getAllCoins": { "post": { "operationId": "iotax_getAllCoins", "summary": "iotax_getAllCoins", "description": "Return all Coin objects owned by an address.", "tags": [ "Coin Query" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getAllCoins" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getAllCoins", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/Page_for_Coin_and_ObjectID" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getAllEpochAddressMetrics": { "post": { "operationId": "iotax_getAllEpochAddressMetrics", "summary": "iotax_getAllEpochAddressMetrics", "description": "Address related metrics. Exclusively served by the indexer.", "tags": [ "Governance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getAllEpochAddressMetrics" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getAllEpochAddressMetrics", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/AddressMetrics" } } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getBalance": { "post": { "operationId": "iotax_getBalance", "summary": "iotax_getBalance", "description": "Return the total coin balance for one coin type, owned by the address owner.", "tags": [ "Coin Query" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getBalance" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getBalance", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/Balance" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getCheckpointAddressMetrics": { "post": { "operationId": "iotax_getCheckpointAddressMetrics", "summary": "iotax_getCheckpointAddressMetrics", "description": "Address related metrics. Exclusively served by the indexer.", "tags": [ "Extended" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getCheckpointAddressMetrics" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getCheckpointAddressMetrics", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/AddressMetrics" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getCirculatingSupply": { "post": { "operationId": "iotax_getCirculatingSupply", "summary": "iotax_getCirculatingSupply", "description": "Return the circulating supply summary.", "tags": [ "Coin Query" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getCirculatingSupply" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getCirculatingSupply", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/IotaCirculatingSupply" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getCoinMetadata": { "post": { "operationId": "iotax_getCoinMetadata", "summary": "iotax_getCoinMetadata", "description": "Return metadata (e.g., symbol, decimals) for a coin.", "tags": [ "Coin Query" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getCoinMetadata" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getCoinMetadata", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/IotaCoinMetadata" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getCoins": { "post": { "operationId": "iotax_getCoins", "summary": "iotax_getCoins", "description": "Return all Coin<`coin_type`> objects owned by an address.", "tags": [ "Coin Query" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getCoins" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getCoins", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/Page_for_Coin_and_ObjectID" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getCommitteeInfo": { "post": { "operationId": "iotax_getCommitteeInfo", "summary": "iotax_getCommitteeInfo", "description": "Return the committee information for the asked `epoch`.", "tags": [ "Governance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getCommitteeInfo" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getCommitteeInfo", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/CommitteeInfo" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getCurrentEpoch": { "post": { "operationId": "iotax_getCurrentEpoch", "summary": "iotax_getCurrentEpoch", "description": "Return current epoch info. Exclusively served by the indexer.", "tags": [ "Governance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getCurrentEpoch" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getCurrentEpoch", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/EpochInfo" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getDynamicFieldObject": { "post": { "operationId": "iotax_getDynamicFieldObject", "summary": "iotax_getDynamicFieldObject", "description": "Return the dynamic field object information for a specified object", "tags": [ "Extended" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getDynamicFieldObject" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getDynamicFieldObject", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/IotaObjectResponse" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getDynamicFieldObjectV2": { "post": { "operationId": "iotax_getDynamicFieldObjectV2", "summary": "iotax_getDynamicFieldObjectV2", "description": "Return the dynamic field object information for a specified object with content options.", "tags": [ "Extended" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getDynamicFieldObjectV2" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getDynamicFieldObjectV2", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/IotaObjectResponse" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getDynamicFields": { "post": { "operationId": "iotax_getDynamicFields", "summary": "iotax_getDynamicFields", "description": "Return the list of dynamic field objects owned by an object.", "tags": [ "Extended" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getDynamicFields" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getDynamicFields", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/Page_for_DynamicFieldInfo_and_ObjectID" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getEpochMetrics": { "post": { "operationId": "iotax_getEpochMetrics", "summary": "iotax_getEpochMetrics", "description": "Return a list of epoch metrics, which is a subset of epoch info. Exclusively served by the indexer.", "tags": [ "Governance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getEpochMetrics" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getEpochMetrics", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/Page_for_EpochMetrics_and_String" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getEpochs": { "post": { "operationId": "iotax_getEpochs", "summary": "iotax_getEpochs", "description": "Return a list of epoch info. Exclusively served by the indexer.", "tags": [ "Governance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getEpochs" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getEpochs", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/Page_for_EpochInfo_and_String" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getLatestAddressMetrics": { "post": { "operationId": "iotax_getLatestAddressMetrics", "summary": "iotax_getLatestAddressMetrics", "description": "Address related metrics. Exclusively served by the indexer.", "tags": [ "Extended" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getLatestAddressMetrics" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getLatestAddressMetrics", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/AddressMetrics" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getLatestIotaSystemState": { "post": { "operationId": "iotax_getLatestIotaSystemState", "summary": "iotax_getLatestIotaSystemState", "description": "Return the latest IOTA system state object on networks supporting protocol version `< 5`. These are networks with node software release version `< 0.11`.", "tags": [ "Governance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getLatestIotaSystemState" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getLatestIotaSystemState", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/IotaSystemStateSummaryV1" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getLatestIotaSystemStateV2": { "post": { "operationId": "iotax_getLatestIotaSystemStateV2", "summary": "iotax_getLatestIotaSystemStateV2", "description": "Return the latest IOTA system state object on networks supporting protocol version `>= 5`. These are networks with node software release version `>= 0.11`.", "tags": [ "Governance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getLatestIotaSystemStateV2" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getLatestIotaSystemStateV2", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/IotaSystemStateSummary" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getMoveCallMetrics": { "post": { "operationId": "iotax_getMoveCallMetrics", "summary": "iotax_getMoveCallMetrics", "description": "Return move call metrics. Exclusively served by the indexer.", "tags": [ "Extended" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getMoveCallMetrics" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getMoveCallMetrics", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/MoveCallMetrics" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getNetworkMetrics": { "post": { "operationId": "iotax_getNetworkMetrics", "summary": "iotax_getNetworkMetrics", "description": "Return Network metrics. Exclusively served by the indexer.", "tags": [ "Extended" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getNetworkMetrics" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getNetworkMetrics", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/NetworkMetrics" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getOwnedObjects": { "post": { "operationId": "iotax_getOwnedObjects", "summary": "iotax_getOwnedObjects", "description": "Return the list of objects owned by an address. Note that if the address owns more than `QUERY_MAX_RESULT_LIMIT` objects, the pagination is not accurate, because previous page may have been updated when the next page is fetched. Please use iotax_queryObjects if this is a concern.", "tags": [ "Extended" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getOwnedObjects" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getOwnedObjects", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/Page_for_IotaObjectResponse_and_ObjectID" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getParticipationMetrics": { "post": { "operationId": "iotax_getParticipationMetrics", "summary": "iotax_getParticipationMetrics", "description": "Returns the participation metrics. Participation is defined as the total number of unique addresses that have delegated stake in the current epoch. Includes both staked and timelocked staked IOTA. Exclusively served by the indexer.", "tags": [ "Governance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getParticipationMetrics" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getParticipationMetrics", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/ParticipationMetrics" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getReferenceGasPrice": { "post": { "operationId": "iotax_getReferenceGasPrice", "summary": "iotax_getReferenceGasPrice", "description": "Return the reference gas price for the network", "tags": [ "Governance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getReferenceGasPrice" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getReferenceGasPrice", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "type": "string" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getStakes": { "post": { "operationId": "iotax_getStakes", "summary": "iotax_getStakes", "description": "Return all [DelegatedStake].", "tags": [ "Governance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getStakes" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getStakes", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/DelegatedStake" } } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getStakesByIds": { "post": { "operationId": "iotax_getStakesByIds", "summary": "iotax_getStakesByIds", "description": "Return one or more [DelegatedStake]. If a Stake was withdrawn its status will be Unstaked.", "tags": [ "Governance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getStakesByIds" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getStakesByIds", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/DelegatedStake" } } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getTimelockedStakes": { "post": { "operationId": "iotax_getTimelockedStakes", "summary": "iotax_getTimelockedStakes", "description": "Return all [DelegatedTimelockedStake].", "tags": [ "Governance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getTimelockedStakes" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getTimelockedStakes", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/DelegatedTimelockedStake" } } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getTimelockedStakesByIds": { "post": { "operationId": "iotax_getTimelockedStakesByIds", "summary": "iotax_getTimelockedStakesByIds", "description": "Return one or more [DelegatedTimelockedStake]. If a Stake was withdrawn its status will be Unstaked.", "tags": [ "Governance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getTimelockedStakesByIds" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getTimelockedStakesByIds", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/DelegatedTimelockedStake" } } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getTotalSupply": { "post": { "operationId": "iotax_getTotalSupply", "summary": "iotax_getTotalSupply", "description": "Return total supply for a coin.", "tags": [ "Coin Query" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getTotalSupply" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getTotalSupply", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/Supply" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getTotalTransactions": { "post": { "operationId": "iotax_getTotalTransactions", "summary": "iotax_getTotalTransactions", "description": "Return the total number of transactions. Exclusively served by the indexer.", "tags": [ "Extended" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getTotalTransactions" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getTotalTransactions", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "type": "string" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_getValidatorsApy": { "post": { "operationId": "iotax_getValidatorsApy", "summary": "iotax_getValidatorsApy", "description": "Return the validator APY", "tags": [ "Governance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_getValidatorsApy" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_getValidatorsApy", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/ValidatorApys" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_iotaNamesFindAllRegistrationNFTs": { "post": { "operationId": "iotax_iotaNamesFindAllRegistrationNFTs", "summary": "iotax_iotaNamesFindAllRegistrationNFTs", "description": "Find all registration NFTs for the given address.", "tags": [ "Extended" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_iotaNamesFindAllRegistrationNFTs" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_iotaNamesFindAllRegistrationNFTs", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/Page_for_IotaObjectResponse_and_ObjectID" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_iotaNamesLookup": { "post": { "operationId": "iotax_iotaNamesLookup", "summary": "iotax_iotaNamesLookup", "description": "Return the resolved record for the given name.", "tags": [ "Extended" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_iotaNamesLookup" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_iotaNamesLookup", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/IotaNameRecord" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_iotaNamesReverseLookup": { "post": { "operationId": "iotax_iotaNamesReverseLookup", "summary": "iotax_iotaNamesReverseLookup", "description": "Return the resolved name for the given address.", "tags": [ "Extended" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_iotaNamesReverseLookup" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_iotaNamesReverseLookup", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "type": "string" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_queryEvents": { "post": { "operationId": "iotax_queryEvents", "summary": "iotax_queryEvents", "description": "Return list of events for a specified query criteria.", "tags": [ "Extended" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_queryEvents" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_queryEvents", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/Page_for_Event_and_EventID" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_queryTransactionBlocks": { "post": { "operationId": "iotax_queryTransactionBlocks", "summary": "iotax_queryTransactionBlocks", "description": "Return list of transactions for a specified query criteria.", "tags": [ "Extended" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_queryTransactionBlocks" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_queryTransactionBlocks", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/Page_for_TransactionBlockResponse_and_Base58" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_subscribeEvent": { "post": { "operationId": "iotax_subscribeEvent", "summary": "iotax_subscribeEvent", "description": "Subscribe to a stream of IOTA event", "tags": [ "Extended" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_subscribeEvent" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_subscribeEvent", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/Event" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/iotax_subscribeTransaction": { "post": { "operationId": "iotax_subscribeTransaction", "summary": "iotax_subscribeTransaction", "description": "Subscribe to a stream of IOTA transaction effects", "tags": [ "Extended" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "iotax_subscribeTransaction" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "iotax_subscribeTransaction", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/TransactionBlockEffects" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/unsafe_batchTransaction": { "post": { "operationId": "unsafe_batchTransaction", "summary": "unsafe_batchTransaction", "description": "Create an unsigned batched transaction.", "tags": [ "Transaction Builder" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "unsafe_batchTransaction" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "unsafe_batchTransaction", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/unsafe_mergeCoins": { "post": { "operationId": "unsafe_mergeCoins", "summary": "unsafe_mergeCoins", "description": "Create an unsigned transaction to merge multiple coins into one coin.", "tags": [ "Transaction Builder" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "unsafe_mergeCoins" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "unsafe_mergeCoins", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/unsafe_moveCall": { "post": { "operationId": "unsafe_moveCall", "summary": "unsafe_moveCall", "description": "Create an unsigned transaction to execute a Move call on the network, by calling the specified function in the module of a given package.", "tags": [ "Transaction Builder" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "unsafe_moveCall" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "unsafe_moveCall", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/unsafe_pay": { "post": { "operationId": "unsafe_pay", "summary": "unsafe_pay", "description": "Send `Coin` to a list of addresses, where `T` can be any coin type, following a list of amounts, The object specified in the `gas` field will be used to pay the gas fee for the transaction. The gas object can not appear in `input_coins`. If the gas object is not specified, the RPC server will auto-select one.", "tags": [ "Transaction Builder" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "unsafe_pay" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "unsafe_pay", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/unsafe_payAllIota": { "post": { "operationId": "unsafe_payAllIota", "summary": "unsafe_payAllIota", "description": "Send all IOTA coins to one recipient. This is for IOTA coin only and does not require a separate gas coin object. Specifically, what pay_all_iota does are: 1. accumulate all IOTA from input coins and deposit all IOTA to the first input coin 2. transfer the updated first coin to the recipient and also use this first coin as gas coin object. 3. the balance of the first input coin after tx is sum(input_coins) - actual_gas_cost. 4. all other input coins other than the first are deleted.", "tags": [ "Transaction Builder" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "unsafe_payAllIota" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "unsafe_payAllIota", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/unsafe_payIota": { "post": { "operationId": "unsafe_payIota", "summary": "unsafe_payIota", "description": "Send IOTA coins to a list of addresses, following a list of amounts. This is for IOTA coin only and does not require a separate gas coin object. Specifically, what pay_iota does are: 1. debit each input_coin to create new coin following the order of amounts and assign it to the corresponding recipient. 2. accumulate all residual IOTA from input coins left and deposit all IOTA to the first input coin, then use the first input coin as the gas coin object. 3. the balance of the first input coin after tx is sum(input_coins) - sum(amounts) - actual_gas_cost 4. all other input coints other than the first one are deleted.", "tags": [ "Transaction Builder" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "unsafe_payIota" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "unsafe_payIota", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/unsafe_publish": { "post": { "operationId": "unsafe_publish", "summary": "unsafe_publish", "description": "Create an unsigned transaction to publish a Move package.", "tags": [ "Transaction Builder" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "unsafe_publish" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "unsafe_publish", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/unsafe_requestAddStake": { "post": { "operationId": "unsafe_requestAddStake", "summary": "unsafe_requestAddStake", "description": "Add stake to a validator's staking pool using multiple coins and amount.", "tags": [ "Transaction Builder" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "unsafe_requestAddStake" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "unsafe_requestAddStake", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/unsafe_requestAddTimelockedStake": { "post": { "operationId": "unsafe_requestAddTimelockedStake", "summary": "unsafe_requestAddTimelockedStake", "description": "Add timelocked stake to a validator's staking pool using multiple balances and amount.", "tags": [ "Transaction Builder" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "unsafe_requestAddTimelockedStake" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "unsafe_requestAddTimelockedStake", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/unsafe_requestWithdrawStake": { "post": { "operationId": "unsafe_requestWithdrawStake", "summary": "unsafe_requestWithdrawStake", "description": "Withdraw stake from a validator's staking pool.", "tags": [ "Transaction Builder" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "unsafe_requestWithdrawStake" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "unsafe_requestWithdrawStake", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/unsafe_requestWithdrawTimelockedStake": { "post": { "operationId": "unsafe_requestWithdrawTimelockedStake", "summary": "unsafe_requestWithdrawTimelockedStake", "description": "Withdraw timelocked stake from a validator's staking pool.", "tags": [ "Transaction Builder" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "unsafe_requestWithdrawTimelockedStake" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "unsafe_requestWithdrawTimelockedStake", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/unsafe_splitCoin": { "post": { "operationId": "unsafe_splitCoin", "summary": "unsafe_splitCoin", "description": "Create an unsigned transaction to split a coin object into multiple coins.", "tags": [ "Transaction Builder" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "unsafe_splitCoin" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "unsafe_splitCoin", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/unsafe_splitCoinEqual": { "post": { "operationId": "unsafe_splitCoinEqual", "summary": "unsafe_splitCoinEqual", "description": "Create an unsigned transaction to split a coin object into multiple equal-size coins.", "tags": [ "Transaction Builder" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "unsafe_splitCoinEqual" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "unsafe_splitCoinEqual", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/unsafe_transferIota": { "post": { "operationId": "unsafe_transferIota", "summary": "unsafe_transferIota", "description": "Create an unsigned transaction to send IOTA coin object to an IOTA address. The IOTA object is also used as the gas object.", "tags": [ "Transaction Builder" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "unsafe_transferIota" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "unsafe_transferIota", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/unsafe_transferObject": { "post": { "operationId": "unsafe_transferObject", "summary": "unsafe_transferObject", "description": "Create an unsigned transaction to transfer an object from one address to another. The object's type must allow public transfers", "tags": [ "Transaction Builder" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC protocol version" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Request identifier" }, "method": { "type": "string", "enum": [ "unsafe_transferObject" ], "description": "The JSON-RPC method name" }, "params": { "type": "array", "description": "Method parameters", "items": {} } } }, "example": { "jsonrpc": "2.0", "id": 1, "method": "unsafe_transferObject", "params": [] } } } }, "responses": { "200": { "description": "Successful JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" } } } } } }, "default": { "description": "JSON-RPC error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } } } }