openapi: 3.0.3 info: title: Chainstack Arbitrum Node Account Info General API version: 1.0.0 description: Chainstack-managed RPC node API for the Arbitrum blockchain. Endpoints follow the canonical JSON-RPC over HTTPS interface for the network. Authenticate against your Chainstack node's per-node URL (e.g. https://nd-XXX-XXX-XXX.p2pify.com/). Merged from the Chainstack Developer Portal per-method fragments at https://github.com/chainstack/dev-portal/tree/main/openapi/arbitrum_node_api. contact: name: Chainstack API Support email: support@chainstack.com license: name: Chainstack Terms url: https://chainstack.com/terms-of-service/ servers: - url: https://{node_id}.p2pify.com/{api_key} description: Chainstack-managed node endpoint variables: node_id: default: nd-000-000-000 description: Your Chainstack node identifier api_key: default: description: Per-node access key tags: - name: General paths: /eth_blockNumber: post: tags: - General summary: eth_blockNumber operationId: eth_blockNumber requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: eth_blockNumber params: type: array default: [] responses: '200': description: The latest block number. content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /eth_call: post: tags: - General summary: Eth_Call operationId: ethCall requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_call id: type: integer default: 1 params: type: array items: type: object title: Call object properties: to: type: string description: The address of the contract to call. data: type: string description: The data to send with the call. default: - to: '0xC9BdeEd33CD01541e1eeD10f90519d2C06Fe3feB' data: '0x313ce567' - latest responses: '200': description: The result of the call. content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string /eth_chainId: post: tags: - General summary: eth_chainId operationId: getChainId requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: eth_chainId params: type: array default: [] responses: '200': description: The network Chain ID content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string /eth_estimateGas: post: tags: - General summary: eth_estimateGas operationId: estimateGas requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: eth_estimateGas params: type: array items: type: object properties: from: type: string format: byte to: type: string format: byte default: - from: '0xE9217BC70B7ED1f598ddD3199e80b093fA71124F' to: '0x2A39319dB98A3982F7C363380b72C66Ab1FFe228' - latest responses: '200': description: The estimated gas amount content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string format: byte /eth_gasPrice: post: tags: - General summary: eth_gasPrice operationId: getGasPrice requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: eth_gasPrice params: type: array default: [] responses: '200': description: The value of the current gas base fee in Wei. content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string /eth_getBalance: post: tags: - General summary: eth_getBalance operationId: getBalance requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: eth_getBalance params: type: array items: anyOf: - type: string title: Address description: The address identifier. - type: string title: Block identifier description: The block identifier. default: - '0xf20BB5451591639A490aa65a6d08a13D420157b7' - pending responses: '200': description: The account balance. content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /eth_getBlockByHash: post: tags: - General summary: eth_getBlockByHash operationId: getBlockByHash requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: eth_getBlockByHash params: type: array items: anyOf: - type: string title: Block Hash description: The hash identifying the block. - type: boolean title: Transaction selector description: True for the full transactions, false for only the transaction hashes. default: - '0x555a1edee58ca5e8a4a8b6e994315efe365d10e62e185d7d38333437c8edbc7f' - true responses: '200': description: The block information content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /eth_getBlockByNumber: post: tags: - General summary: eth_getBlockByNumber operationId: getBlockByNumber requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: eth_getBlockByNumber params: type: array items: anyOf: - type: string title: Block identifier description: The block number or tag. - type: boolean title: Transaction selector description: True for the full transactions, false for only the transaction hashes. default: - latest - false responses: '200': description: The block information content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /eth_getBlockTransactionCountByHash: post: tags: - General summary: eth_getBlockTransactionCountByHash operationId: getBlockTransactionCountByHash requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: eth_getBlockTransactionCountByHash params: type: array items: type: string title: Block hash description: The block hash identifier. default: - '0x5db8ff1beb252c1a9cb390ef25af04e2763bdee1bcd48c76977a17148bba503d' responses: '200': description: The block information content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string /eth_getBlockTransactionCountByNumber: post: tags: - General summary: eth_getBlockTransactionCountByNumber operationId: getBlockTransactionCountByNumber requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: eth_getBlockTransactionCountByNumber params: type: array items: type: string title: Block identifier description: The block number or tag. default: - latest responses: '200': description: The block transaction count information content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string /eth_getCode: post: tags: - General summary: eth_getCode operationId: getCode requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: eth_getCode params: type: array items: anyOf: - type: string title: Smart contract address description: The address identifier. - type: string title: Block identifier description: The block identifier. default: - '0xC9BdeEd33CD01541e1eeD10f90519d2C06Fe3feB' - latest responses: '200': description: The smart contract code. content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /eth_getFilterChanges: post: summary: eth_getFilterChanges operationId: getFilterChanges requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_getFilterChanges params: type: array items: type: string title: The filter ID default: - '0xbdc5b4b99ca699e1d734fc4202afee79' id: type: integer default: 1 responses: '200': description: The filter changes. content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: string tags: - General /eth_getLogs: post: tags: - General summary: eth_getLogs operationId: getLogs requestBody: required: true content: application/json: schema: type: object properties: method: type: string default: eth_getLogs params: type: array items: type: object properties: fromBlock: type: string title: from block description: The block number or tag to start searching for logs from. default: latest address: type: string title: smart contract address description: The contract address to retrieve the logs for. topics: type: array title: topics items: type: string description: An array of 32-byte topics to filter for. Each topic is treated as an OR condition. default: - fromBlock: latest address: '0xC9BdeEd33CD01541e1eeD10f90519d2C06Fe3feB' topics: - '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef' id: type: integer default: 1 jsonrpc: type: string default: '2.0' responses: '200': description: An array of log objects matching the specified filter. content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: object /eth_getStorageAt: post: tags: - General summary: eth_getStorageAt operationId: getStorageAt requestBody: required: true content: application/json: schema: type: object properties: method: type: string default: eth_getStorageAt params: type: array items: anyOf: - type: string title: Smart contract address description: The address of the contract to query. - type: string title: Slot index description: The index of the storage position to query. - type: string title: Block ID description: The block number or tag to use as a reference. default: - '0xC9BdeEd33CD01541e1eeD10f90519d2C06Fe3feB' - '0x2' - latest id: type: integer default: 1 jsonrpc: type: string default: '2.0' responses: '200': description: The value stored at the specified position. content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string /eth_getTransactionByBlockHashAndIndex: post: tags: - General summary: eth_getTransactionByBlockHashAndIndex operationId: getTransactionByBlockHashAndIndex requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: eth_getTransactionByBlockHashAndIndex params: type: array items: anyOf: - type: string title: Block hash - type: string title: Transaction index default: - '0x90146736f9cb8bece40fb0ee5bd1f22d8f96e1d01143ac0531cc2faeb05ae606' - '0x0' responses: '200': description: The transaction information content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /eth_getTransactionByBlockNumberAndIndex: post: tags: - General summary: eth_getTransactionByBlockNumberAndIndex operationId: getTransactionByBlockNumberAndIndex requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: eth_getTransactionByBlockNumberAndIndex params: type: array items: anyOf: - type: string title: Block number - type: string title: Transaction index default: - '0x7155458' - '0x0' responses: '200': description: The transaction information content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /eth_getTransactionByHash: post: tags: - General summary: eth_getTransactionByHash operationId: getTransactionByHash requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: eth_getTransactionByHash params: type: array items: type: string title: Transaction hash default: - '0xd33ef2f7c09daaa50fd9694e2782bee2a40840abcc5929af685489ed5ad5cfd0' responses: '200': description: The transaction information content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /eth_getTransactionCount: post: tags: - General summary: eth_getTransactionCount operationId: getTransactionCount requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: eth_getTransactionCount params: type: array items: anyOf: - type: string title: Address description: The address to check - type: string title: Block identifier description: The block identifier default: - '0xF59A3094538DA6D733793Ec8d9F1da863BC33671' - latest responses: '200': description: The address nonce content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /eth_getTransactionReceipt: post: tags: - General summary: eth_getTransactionReceipt operationId: getTransactionReceipt requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: eth_getTransactionReceipt params: type: array items: type: string title: Transaction hash default: - '0xd33ef2f7c09daaa50fd9694e2782bee2a40840abcc5929af685489ed5ad5cfd0' responses: '200': description: The transaction receipt content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /eth_newBlockFilter: post: summary: eth_newBlockFilter operationId: newBlockFilter requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_newBlockFilter params: type: array default: [] id: type: integer default: 1 responses: '200': description: The new filter ID. content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: string tags: - General /eth_newFilter: post: tags: - General summary: eth_newFilter operationId: newFilter requestBody: required: true content: application/json: schema: type: object properties: method: type: string default: eth_newFilter params: type: array items: type: object properties: fromBlock: type: string title: from block description: The block number or tag to start searching for logs from. default: latest address: type: string title: smart contract address description: The contract address to retrieve the logs for. topics: type: array title: topics items: type: string description: An array of 32-byte topics to filter for. Each topic is treated as an OR condition. default: - fromBlock: latest address: '0xC9BdeEd33CD01541e1eeD10f90519d2C06Fe3feB' topics: - '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef' id: type: integer default: 1 jsonrpc: type: string default: '2.0' responses: '200': description: The filter ID. content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string /eth_newPendingTransactionFilter: post: summary: eth_newPendingTransactionFilter operationId: newPendingTransactionFilter requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_newPendingTransactionFilter params: type: array default: [] id: type: integer default: 1 responses: '200': description: The new filter ID. content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: string tags: - General /eth_sendRawTransaction: post: tags: - General summary: eth_sendRawTransaction operationId: sendRawTransaction requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: eth_sendRawTransaction params: type: array items: anyOf: - type: string description: The signed transaction. default: - '0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675' responses: '200': description: The transaction hash. content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /eth_syncing: post: tags: - General summary: Eth_Syncing operationId: syncing requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: eth_syncing params: type: array default: [] responses: '200': description: Syncing information content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /eth_uninstallFilter: post: summary: eth_uninstallFilter operationId: uninstallFilter requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_uninstallFilter params: type: array items: type: string title: Filter ID default: - '0xbdc5b4b99ca699e1d734fc4202afee79' id: type: integer default: 1 responses: '200': description: Boolean value indicating if the filter was removed or not. content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: boolean tags: - General /net_listening: post: tags: - General summary: Net_Listening operationId: listening requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: net_listening params: type: array default: [] responses: '200': description: The boolean value that indicates whether or not a node is currently actively seeking peer connections. content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string /net_peerCount: post: tags: - General summary: net_peerCount operationId: peerCount requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: net_peerCount params: type: array default: [] responses: '200': description: The number of peers connected to the client. content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string /web3_clientVersion: post: tags: - General summary: web3_clientVersion operationId: clientVersion requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: web3_clientVersion params: type: array default: [] responses: '200': description: The client running on this node. content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string /debug_getModifiedAccountsByHash: post: tags: - General summary: debug_getModifiedAccountsByHash operationId: getModifiedAccountsByHash requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: debug_getModifiedAccountsByHash id: type: integer default: 1 params: type: array items: type: string default: - '0x5208b53713adbfe3397055946b487b16c45f018dee8213df81b3f4ccb9b3142d' responses: '200': description: A list of accounts modified in the specified block content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: string description: The addresses of the modified accounts. /debug_getModifiedAccountsByNumber: post: tags: - General summary: debug_getModifiedAccountsByNumber operationId: getModifiedAccountsByNumber requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: debug_getModifiedAccountsByNumber id: type: string default: '1' params: type: array default: - '0xbb54e6' - '0xbb54e7' items: type: string responses: '200': description: A list of accounts modified between the two block numbers content: application/json: schema: type: object properties: jsonrpc: type: string id: type: string result: type: array items: type: string description: The addresses of the modified accounts. /debug_storageRangeAt: post: tags: - General summary: debug_storageRangeAt operationId: getStorageRangeAt requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: debug_storageRangeAt id: type: integer default: 1 params: type: array items: oneOf: - type: string - type: integer default: - '0xc40b7058b5b80e565dfb986fe852c047733291291c8de1be8888ae64b5457bbd' - 25 - '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913' - '0x00000000000000000000000000000000' - 2 responses: '200': description: Storage data for the specified range content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object properties: storage: type: object additionalProperties: true complete: type: boolean description: The storage entries and a flag indicating if the storage is complete. /debug_traceBlockByHash: post: tags: - General summary: debug_traceBlockByHash operationId: traceBlockByHash requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: debug_traceBlockByHash id: type: integer default: 1 params: type: array items: type: string default: - '0xff9d126bda9b40194e2ac7ad069652fd2b9200c2739fdb78817da89903ce3b5d' responses: '200': description: Detailed execution traces for all transactions in the specified block content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: object description: An array of execution traces for each transaction in the block. /debug_traceBlockByNumber: post: tags: - General summary: debug_traceBlockByNumber operationId: traceBlockByNumber requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: debug_traceBlockByNumber id: type: integer default: 1 params: type: array items: type: string default: - '0xbb5583' responses: '200': description: Detailed execution traces for all transactions in the specified block content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: object description: An array of execution traces for each transaction in the block. /debug_traceCall: post: tags: - General summary: Execute a call and retrieve a detailed execution trace operationId: traceCall requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' method: type: string default: debug_traceCall id: type: integer default: 1 params: type: array description: Parameters for the call default: - to: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913' gasPrice: '0x7896e72a' data: '0x70a082310000000000000000000000001985ea6e9c68e1c272d8209f3b478ac2fdb25c87' - latest responses: '200': description: Detailed execution trace of the call content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object properties: structLogs: type: array items: type: object description: An array of execution steps (opcodes) taken by the call. gas: type: integer description: The gas provided by the call. returnValue: type: string description: The return value of the call, if any. gasUsed: type: integer description: The total gas used by the call. failed: type: boolean description: Indicates whether the call failed. /debug_traceCallMany: post: tags: - General summary: Execute multiple calls and retrieve detailed execution traces operationId: traceCallMany requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' method: type: string default: debug_traceCallMany id: type: integer default: 1 params: type: array description: Parameters for the call default: - - transactions: - from: '0x1985EA6E9c68E1C272d8209f3B478AC2Fdb25c87' to: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913' gas: '0xf4240' gasPrice: '0x7896e72a' data: '0xa9059cbb000000000000000000000000bc0E63965946815d105E7591407704e6e1964E590000000000000000000000000000000000000000000000000000000005f5e100' - to: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913' gasPrice: '0x7896e72a' data: '0x70a08231000000000000000000000000bc0E63965946815d105E7591407704e6e1964E59' blockOverride: blockNumber: '0xbb5fe9' - blockNumber: '0xbb5fe9' transactionIndex: 1 - {} responses: '200': description: Detailed execution traces of the calls content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: object properties: structLogs: type: array items: type: object properties: pc: type: integer op: type: string gas: type: integer gasCost: type: integer depth: type: integer stack: type: array memory: type: array gas: type: integer returnValue: type: string gasUsed: type: integer failed: type: boolean /debug_traceTransaction: post: tags: - General summary: debug_traceTransaction operationId: traceTransaction requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: debug_traceTransaction id: type: integer default: 1 params: type: array items: type: string default: - '0x317888c89fe0914c6d11be51acf758742afbe0cf1fdac11f19d35d6ed652ac29' responses: '200': description: Detailed execution trace of the specified transaction content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object properties: structLogs: type: array items: type: object description: An array of execution steps (opcodes) taken by the transaction. gas: type: integer description: The gas provided by the transaction. returnValue: type: string description: The return value of the transaction, if any. gasUsed: type: integer description: The total gas used by the transaction. failed: type: boolean description: Indicates whether the transaction failed. description: The detailed execution trace of the transaction. /eth_accounts: post: tags: - General summary: Eth_Accounts operationId: accounts requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_accounts id: type: integer default: 1 responses: '200': description: List of addresses owned by the client content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: string description: Array of 20 Bytes - addresses owned by the client /eth_callMany: post: tags: - General summary: eth_callMany operationId: callMany requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_callMany id: type: integer default: 1 params: type: array default: - - transactions: - from: '0x1985EA6E9c68E1C272d8209f3B478AC2Fdb25c87' to: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913' gas: '0xf4240' gasPrice: '0x7896e72a' data: '0xa9059cbb000000000000000000000000bc0E63965946815d105E7591407704e6e1964E590000000000000000000000000000000000000000000000000000000005f5e100' - to: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913' gasPrice: '0x7896e72a' data: '0x70a08231000000000000000000000000bc0E63965946815d105E7591407704e6e1964E59' blockOverride: blockNumber: '0xbb5fe9' - blockNumber: '0xbb5fe9' transactionIndex: 1 - {} items: type: object responses: '200': description: The result of the multiple calls content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: object description: The results of the executed calls. /eth_createAccessList: post: tags: - General summary: eth_createAccessList operationId: createAccessList requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_createAccessList id: type: integer default: 1 params: type: array items: anyOf: - type: object properties: from: type: string default: '0xaeA8F8f781326bfE6A7683C2BD48Dd6AA4d3Ba63' data: type: string default: '0x608060806080608155' - type: string default: pending default: - from: '0xaeA8F8f781326bfE6A7683C2BD48Dd6AA4d3Ba63' data: '0x608060806080608155' - pending responses: '200': description: The generated access list and gas used content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object properties: accessList: type: array items: type: object properties: address: type: string storageKeys: type: array items: type: string gasUsed: type: string /eth_feeHistory: post: tags: - General summary: eth_feeHistory operationId: feeHistory requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_feeHistory id: type: integer default: 1 params: type: array items: anyOf: - type: integer - type: string - type: array items: type: integer - type: array items: type: string default: - 1024 - latest - - 10 - 20 - 30 responses: '200': description: Historical gas fee data content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object properties: oldestBlock: type: string baseFeePerGas: type: array items: type: string gasUsedRatio: type: array items: type: number reward: type: array items: type: array items: type: string /eth_getBlockReceipts: post: tags: - General summary: eth_getBlockReceipts operationId: getBlockReceipts requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_getBlockReceipts id: type: integer default: 1 params: type: array items: anyOf: - type: string default: latest default: - latest responses: '200': description: The transaction receipts of the block content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: object properties: transactionHash: type: string transactionIndex: type: integer blockHash: type: string blockNumber: type: integer from: type: string to: type: string cumulativeGasUsed: type: integer gasUsed: type: integer contractAddress: type: string logs: type: array items: type: object properties: removed: type: boolean logIndex: type: integer transactionIndex: type: integer transactionHash: type: string blockHash: type: string blockNumber: type: integer address: type: string data: type: string topics: type: array items: type: string status: type: string /eth_getFilterLogs: post: tags: - General summary: eth_getFilterLogs operationId: getFilterLogs requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_getFilterLogs id: type: integer default: 1 params: type: array items: type: string default: - '0x5a6b7c' responses: '200': description: All logs matching the filter content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: object properties: removed: type: boolean logIndex: type: string transactionIndex: type: string transactionHash: type: string blockHash: type: string blockNumber: type: string address: type: string data: type: string topics: type: array items: type: string /eth_getProof: post: tags: - General summary: eth_getProof operationId: getProof requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_getProof id: type: integer default: 1 params: type: array default: - '0x548Da0F6b0AFD0094F735503D44e79a3769980Fd' - - '0xf6e506a9cbe7546a796b187c40609a170ea8073e047129a3cae1c38e6d7559b7' - latest items: oneOf: - type: string - type: array items: type: string responses: '200': description: Account and storage values of the specified account including the Merkle-proof content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object properties: accountProof: type: array items: type: string balance: type: string codeHash: type: string nonce: type: string storageHash: type: string storageProof: type: array items: type: object properties: key: type: string value: type: string proof: type: array items: type: string /eth_getRawTransactionByBlockHashAndIndex: post: tags: - General summary: eth_getRawTransactionByBlockHashAndIndex operationId: getRawTransactionByBlockHashAndIndex requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_getRawTransactionByBlockHashAndIndex id: type: integer default: 1 params: type: array default: - '0x07fcc7d5f86839e12afa756e979de05812b5341f936b850c9409aa0938819b30' - '0x1' items: type: string responses: '200': description: Raw transaction data for the given block hash and index content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string /eth_getRawTransactionByBlockNumberAndIndex: post: tags: - General summary: eth_getRawTransactionByBlockNumberAndIndex operationId: getRawTransactionByBlockNumberAndIndex requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_getRawTransactionByBlockNumberAndIndex id: type: integer default: 1 params: type: array default: - '0xbb623d' - '0x1' items: type: string responses: '200': description: Raw transaction data for the given block number and index content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string /eth_getRawTransactionByHash: post: tags: - General summary: eth_getRawTransactionByHash operationId: getRawTransactionByHash requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_getRawTransactionByHash id: type: integer default: 1 params: type: array default: - '0x1759c699e6e2b1f249fa0ed605c0de18998bc66556cd6ea3362f92f511aeb06a' items: type: string responses: '200': description: Raw transaction data for the given hash content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string /eth_getUncleByBlockHashAndIndex: post: tags: - General summary: eth_getUncleByBlockHashAndIndex operationId: getUncleByBlockHashAndIndex requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_getUncleByBlockHashAndIndex id: type: integer default: 1 params: type: array items: type: string minItems: 2 maxItems: 2 default: - '0xb3e8c898cfbf4072eaad440e8606e578a33ca4fafc27d7936d83d7392ba3e939' - '0x0' responses: '200': description: Information about the uncle block content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object description: Uncle block object, or null when no uncle exists /eth_getUncleByBlockNumberAndIndex: post: tags: - General summary: eth_getUncleByBlockNumberAndIndex operationId: getUncleByBlockNumberAndIndex requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_getUncleByBlockNumberAndIndex id: type: integer default: 1 params: type: array items: type: string minItems: 2 maxItems: 2 default: - latest - '0x0' responses: '200': description: Information about the uncle block content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object description: Uncle block object, or null when no uncle exists /eth_getUncleCountByBlockHash: post: tags: - General summary: eth_getUncleCountByBlockHash operationId: getUncleCountByBlockHash requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_getUncleCountByBlockHash id: type: integer default: 1 params: type: array items: anyOf: - type: string default: '0x07fcc7d5f86839e12afa756e979de05812b5341f936b850c9409aa0938819b30' default: - '0x07fcc7d5f86839e12afa756e979de05812b5341f936b850c9409aa0938819b30' responses: '200': description: The uncle count of the block by hash content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string /eth_getUncleCountByBlockNumber: post: tags: - General summary: eth_getUncleCountByBlockNumber operationId: getUncleCountByBlockNumber requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_getUncleCountByBlockNumber id: type: integer default: 1 params: type: array items: anyOf: - type: string default: '0xbb623d' default: - '0xbb623d' responses: '200': description: The uncle count of the block by number content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string /eth_maxPriorityFeePerGas: post: tags: - General summary: eth_maxPriorityFeePerGas operationId: maxPriorityFeePerGas requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_maxPriorityFeePerGas id: type: integer default: 1 responses: '200': description: Current maximum priority fee per gas content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string /eth_protocolVersion: post: tags: - General summary: eth_protocolVersion operationId: protocolVersion requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_protocolVersion id: type: integer default: 1 responses: '200': description: The current ethereum protocol version content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string /eth_sendRawTransactionSync: post: tags: - General summary: eth_sendRawTransactionSync operationId: sendRawTransactionSync requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_sendRawTransactionSync id: type: integer default: 1 params: type: array default: - '0xf86c808504a817c80082520894ab5db0e98b8ea6b7f9d8ad8e8ed0bc8fba0d1a2f870de0b6b3a764000080821b9f' items: oneOf: - type: string - type: integer minItems: 1 maxItems: 2 examples: example1: summary: Submit raw transaction with timeout value: jsonrpc: '2.0' method: eth_sendRawTransactionSync params: - '0xf86c808504a817c80082520894ab5db0e98b8ea6b7f9d8ad8e8ed0bc8fba0d1a2f870de0b6b3a764000080821b9f' - 5000 id: 1 responses: '200': description: Successful transaction submission with receipt content: application/json: schema: type: object properties: jsonrpc: type: string example: '2.0' id: type: integer example: 1 result: type: object properties: transactionHash: type: string example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' blockHash: type: string example: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdef' blockNumber: type: string example: '0x12345' gasUsed: type: string example: '0x5208' status: type: string example: '0x1' /trace_block: post: tags: - General summary: Trace_Block operationId: traceBlockByNumber requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: trace_block id: type: integer default: 1 params: type: array items: type: string default: - '0xbb5583' responses: '200': description: Detailed execution traces for all transactions in the specified block content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: object description: An array of execution traces for each transaction in the block. /trace_call: post: tags: - General summary: Trace_Call operationId: call requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' method: type: string default: trace_call id: type: integer default: 1 params: type: array items: anyOf: - type: object properties: from: type: string nullable: true default: null to: type: string default: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913' data: type: string default: '0x70a082310000000000000000000000001985ea6e9c68e1c272d8209f3b478ac2fdb25c87' - type: array items: type: string default: - trace - vmTrace - type: string default: latest default: - from: null to: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913' data: '0x70a082310000000000000000000000001985ea6e9c68e1c272d8209f3b478ac2fdb25c87' - - trace - vmTrace - latest responses: '200': description: The result of the call content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string /trace_callMany_method: post: summary: trace_callMany method operationId: traceCallMany tags: - General requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' method: type: string default: trace_callMany params: type: array default: - - - from: '0x407d73d8a49eeb85d32cf465507dd71d507100c1' to: '0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b' data: '0xa9059cbb000000000000000000000000bc0E63965946815d105E7591407704e6e1964E590000000000000000000000000000000000000000000000000000000005f5e100' - - trace - vmTrace - - from: null to: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913' data: '0x70a08231000000000000000000000000bc0E63965946815d105E7591407704e6e1964E59' - - trace - vmTrace - latest id: type: integer default: 1 responses: '200': description: Successful response content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: object properties: exampleProperty: type: string /trace_get: post: summary: Replay transactions in a block operationId: trace_get tags: - General requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' example: '2.0' method: type: string default: trace_get example: trace_get params: type: array default: - '0x1759c699e6e2b1f249fa0ed605c0de18998bc66556cd6ea3362f92f511aeb06a' - - '0x0' example: - '0x1759c699e6e2b1f249fa0ed605c0de18998bc66556cd6ea3362f92f511aeb06a' - - '0x0' id: type: integer default: 1 example: 1 responses: '200': description: Trace data for transactions in the specified block content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: object description: Trace data for a single transaction. /trace_replayBlockTransactions: post: summary: Replay transactions in a block operationId: trace_replayBlockTransactions tags: - General requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' example: '2.0' method: type: string default: trace_replayBlockTransactions example: trace_replayBlockTransactions params: type: array default: - '0xbb623d' - - trace example: - '0xbb623d' - - trace id: type: integer default: 1 example: 1 responses: '200': description: Trace data for transactions in the specified block content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: object description: Trace data for a single transaction. /trace_replayTransaction: post: summary: Replay transactions in a block operationId: trace_replayTransaction tags: - General requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' example: '2.0' method: type: string default: trace_replayTransaction example: trace_replayTransaction params: type: array default: - '0x1759c699e6e2b1f249fa0ed605c0de18998bc66556cd6ea3362f92f511aeb06a' - - trace example: - '0x1759c699e6e2b1f249fa0ed605c0de18998bc66556cd6ea3362f92f511aeb06a' - - trace id: type: integer default: 1 example: 1 responses: '200': description: Trace data for transactions in the specified block content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: object description: Trace data for a single transaction. /trace_transaction: post: tags: - General summary: Trace_Transaction operationId: traceTransaction requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: trace_transaction id: type: integer default: 1 params: type: array items: type: string default: - '0x317888c89fe0914c6d11be51acf758742afbe0cf1fdac11f19d35d6ed652ac29' responses: '200': description: Detailed execution trace of the specified transaction content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object properties: structLogs: type: array items: type: object description: An array of execution steps (opcodes) taken by the transaction. gas: type: integer description: The gas provided by the transaction. returnValue: type: string description: The return value of the transaction, if any. gasUsed: type: integer description: The total gas used by the transaction. failed: type: boolean description: Indicates whether the transaction failed. description: The detailed execution trace of the transaction. /web3_sha3: post: tags: - General summary: Web3_Sha3 operationId: sha3 requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: web3_sha3 id: type: integer default: 1 params: type: array default: - '0x436861696E737461636B' items: type: string responses: '200': description: The SHA3 result of the given data content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string description: The Keccak-256 hash of the input data. /decoderawtransaction: post: tags: - General summary: Decoderawtransaction operationId: decodeRawTransaction requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: decoderawtransaction params: type: array items: type: string description: The raw transaction in hex format to decode. default: - 010000000001010000000000000000000000000000000000000000000000000000000000000000ffffffff5603b2c50c194d696e656420627920416e74506f6f6c206e0006071c93cbcdfabe6d6db50cdb1bd4713d7d8e48a75ce34c044bd84ee9f67e53dd443e3f24ccdabb687a100000000000000000006bf6dd49000000000000ffffffff05220200000000000017a91442402a28dd61f2718a4b27ae72a4791d5bbdade7876f81e0250000000017a9145249bdf2c131d43995cff42e8feee293f79297a8870000000000000000266a24aa21a9ed7a97cbb5b2366e5185da4ca412ca7ec1a3474c3ea2160e6fdf78d6f2924971c300000000000000002f6a2d434f5245012953559db5cc88ab20b1960faa9793803d0703375997be5a09d05bb9bac27ec60419d0b373f32b2000000000000000002b6a2952534b424c4f434b3a1d2a85762502a28245b3f5103a8f26ef0754f340b291af79649be425005ecdaf0120000000000000000000000000000000000000000000000000000000000000000000000000 id: type: integer default: 1 responses: '200': description: Details about the decoded transaction. content: application/json: schema: type: object properties: result: type: object description: Contains detailed information about the transaction, including its inputs, outputs, and various metadata. error: type: object id: type: integer /decodescript: post: tags: - General summary: Decodescript operationId: decodeScript requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: decodescript params: type: array items: type: string description: The hex-encoded script to decode. default: - 76a914af92ad98c7f77559f96430dfef2a6805b87b24f888ac id: type: integer default: 1 responses: '200': description: Details about the decoded script. content: application/json: schema: type: object properties: result: type: object description: Contains information about the script, such as its type, addresses involved, and if it's a segwit script. error: type: object id: type: integer /estimatesmartfee: post: tags: - General summary: Estimatesmartfee operationId: estimateSmartFee requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: estimatesmartfee params: type: array items: type: integer description: The number of blocks within which the transaction is expected to be confirmed. default: - 6 id: type: integer default: 1 responses: '200': description: The estimated fee per kilobyte for a transaction to be confirmed within the specified number of blocks. content: application/json: schema: type: object properties: result: type: object properties: feerate: type: number description: The estimated fee per kilobyte. blocks: type: integer description: The number of blocks within which the transaction is expected to be confirmed. description: Contains the estimated fee rate and the number of blocks. error: type: object id: type: integer /getbestblockhash: post: tags: - General summary: Getbestblockhash operationId: getBestBlockHash requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getbestblockhash id: type: integer default: 1 responses: '200': description: The hash of the best (tip) block content: application/json: schema: type: object properties: result: type: string error: type: object id: type: integer /getblock: post: tags: - General summary: Getblock operationId: getblock requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getblock params: type: array items: oneOf: - type: string description: The block hash example: 000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f - type: integer description: The block height example: '0' default: - 000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f id: type: integer default: 1 responses: '200': description: The requested block content: application/json: schema: type: object properties: result: type: object description: The block object error: type: object id: type: integer /getblockchaininfo: post: tags: - General summary: Getblockchaininfo operationId: getBlockchainInfo requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getblockchaininfo params: type: array items: {} default: [] id: type: integer default: 1 responses: '200': description: Various state info regarding blockchain processing content: application/json: schema: type: object properties: result: type: object description: An object containing various state info error: type: object id: type: integer /getblockfilter: post: tags: - General summary: Getblockfilter operationId: getBlockFilter requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getblockfilter params: type: array items: oneOf: - type: string description: The block hash example: 000000000000000000100c3c4b0b07a64612385408f6c7d97c422a5a0c1d859d - type: string description: The filter type example: basic default: - 000000000000000000100c3c4b0b07a64612385408f6c7d97c422a5a0c1d859d - basic id: type: integer default: 1 responses: '200': description: The BIP 157 content filter for the block content: application/json: schema: type: object properties: result: type: object description: An object containing the block filter error: type: object id: type: integer /getblockhash: post: tags: - General summary: Getblockhash operationId: getBlockHash requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getblockhash params: type: array items: type: integer description: The block height example: 836491 default: - 836491 id: type: integer default: 1 responses: '200': description: The hash of the block at the given height content: application/json: schema: type: object properties: result: type: string description: The block hash error: type: object id: type: integer /getblockheader: post: tags: - General summary: Getblockheader operationId: getblockheader requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getblockheader params: type: array items: oneOf: - type: string description: The block hash example: 000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f - type: boolean description: If true, returns the blockheader as a hex-encoded string example: true default: - 000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f - true id: type: integer default: 1 responses: '200': description: Information about the block header content: application/json: schema: type: object properties: result: type: object error: type: object id: type: integer /getblockstats: post: tags: - General summary: Getblockstats operationId: getBlockStats requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getblockstats params: type: array items: oneOf: - type: string description: The block hash example: 00000000000000000002d517d73d1abd09730ea69aa688207c281944300e8a50 - type: array description: An array of stats to include items: type: string enum: - avgfee - avgfeerate - avgtxsize - blockhash - feerate_percentiles - height - ins - maxfee - maxfeerate - maxtxsize - medianfee - mediantime - mediantxsize - minfee - minfeerate - mintxsize - outs - subsidy - swtotal_size - swtotal_weight - swtxs - time - total_out - total_size - total_weight - totalfee - txs - utxo_increase - utxo_size_inc default: - avgfee - avgfeerate - avgtxsize - blockhash - feerate_percentiles - height - ins - maxfee - maxfeerate - maxtxsize - medianfee - mediantime - mediantxsize - minfee - minfeerate - mintxsize - outs - subsidy - swtotal_size - swtotal_weight - swtxs - time - total_out - total_size - total_weight - totalfee - txs - utxo_increase - utxo_size_inc default: - 00000000000000000002d517d73d1abd09730ea69aa688207c281944300e8a50 - - avgfee - avgfeerate - avgtxsize - blockhash - feerate_percentiles - height - ins - maxfee - maxfeerate - maxtxsize - medianfee - mediantime - mediantxsize - minfee - minfeerate - mintxsize - outs - subsidy - swtotal_size - swtotal_weight - swtxs - time - total_out - total_size - total_weight - totalfee - txs - utxo_increase - utxo_size_inc id: type: integer default: 1 responses: '200': description: The requested block statistics content: application/json: schema: type: object properties: result: type: object description: An object containing the block statistics error: type: object id: type: integer /getblocktemplate: post: tags: - General summary: Getblocktemplate operationId: getBlockTemplate requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getblocktemplate params: type: array items: type: object properties: mode: type: string description: This must be set to 'template', 'proposal', or left unset. enum: - template - proposal capabilities: type: array items: type: string description: List of capabilities example: - coinbasetxn - workid - coinbase/append rules: type: array items: type: string description: A list of strings example: - segwit required: - mode example: - mode: template capabilities: - coinbasetxn - workid - coinbase/append rules: - segwit default: - mode: template capabilities: - coinbasetxn - workid - coinbase/append rules: - segwit id: type: integer default: 1 responses: '200': description: A block template or proposal for mining. content: application/json: schema: type: object properties: result: type: object description: The block template or proposal. error: type: object id: type: integer /getchaintips: post: tags: - General summary: Getchaintips operationId: getChainTips requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getchaintips params: type: array items: {} default: [] id: type: integer default: 1 responses: '200': description: Information about the current chain tips content: application/json: schema: type: object properties: result: type: array description: An array of chain tip information error: type: object id: type: integer /getchaintxstats: post: tags: - General summary: Getchaintxstats operationId: getChainTxStats requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getchaintxstats params: type: object properties: nblocks: type: integer description: The block height example: 100 blockhash: type: string description: The block hash example: 000000000000000000024b16f3c9bfd109d0c666dd8a694cfaeca1b6a0f0d112 required: - nblocks - blockhash default: nblocks: 100 blockhash: 000000000000000000024b16f3c9bfd109d0c666dd8a694cfaeca1b6a0f0d112 id: type: integer default: 1 responses: '200': description: Statistics about the total number and rate of transactions in the chain content: application/json: schema: type: object properties: result: type: object description: An object containing transaction statistics error: type: object id: type: integer /getconnectioncount: post: tags: - General summary: Getconnectioncount operationId: getConnectionCount requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getconnectioncount params: {} id: type: integer default: 1 responses: '200': description: The number of connections to other nodes. content: application/json: schema: type: object properties: result: type: integer description: The current number of connections to other nodes. error: type: object id: type: integer /getdifficulty: post: tags: - General summary: Getdifficulty operationId: getDifficulty requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getdifficulty params: {} id: type: integer default: 1 responses: '200': description: The current network difficulty content: application/json: schema: type: object properties: result: type: number description: The current network difficulty as a number error: type: object id: type: integer /getmemoryinfo: post: tags: - General summary: Getmemoryinfo operationId: getMemoryInfo requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getmemoryinfo params: type: array items: type: string enum: - stats - mallocinfo description: The mode in which memory information should be returned. 'stats' for a summary view, 'mallocinfo' for detailed XML format. default: - stats id: type: integer default: 1 responses: '200': description: Detailed information about the node's memory usage. content: application/json: schema: type: object properties: result: type: object description: Memory information in the requested format. error: type: object id: type: integer /getmempoolancestors: post: tags: - General summary: Getmempoolancestors operationId: getMempoolAncestors requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getmempoolancestors params: type: array items: type: string description: The transaction ID example: f6a4beaf3b26ae273d50eb8f6ea18e776932b4fefd24c8b915b94b6d22e89bc9 default: - f6a4beaf3b26ae273d50eb8f6ea18e776932b4fefd24c8b915b94b6d22e89bc9 id: type: integer default: 1 responses: '200': description: All in-mempool ancestors for the specified transaction content: application/json: schema: type: object properties: result: type: array description: An array of in-mempool ancestor transactions error: type: object id: type: integer /getmempooldescendants: post: tags: - General summary: Getmempooldescendants operationId: getMempoolDescendants requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getmempooldescendants params: type: array items: type: string description: The transaction ID example: 48b46e5905386ea21ff94d2be67dd7a75cc177c53e301d1ca29c5721d502793e default: - 48b46e5905386ea21ff94d2be67dd7a75cc177c53e301d1ca29c5721d502793e id: type: integer default: 1 responses: '200': description: All in-mempool descendants for the specified transaction content: application/json: schema: type: object properties: result: type: array description: An array of in-mempool descendant transactions error: type: object id: type: integer /getmempoolentry: post: tags: - General summary: Getmempoolentry operationId: getMempoolEntry requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getmempoolentry params: type: array items: type: string description: The transaction ID example: 48b46e5905386ea21ff94d2be67dd7a75cc177c53e301d1ca29c5721d502793e default: - 48b46e5905386ea21ff94d2be67dd7a75cc177c53e301d1ca29c5721d502793e id: type: integer default: 1 responses: '200': description: Detailed information about the specified transaction in the mempool content: application/json: schema: type: object properties: result: type: object description: Detailed information about the transaction in the mempool error: type: object id: type: integer /getmempoolinfo: post: tags: - General summary: Getmempoolinfo operationId: getMempoolInfo requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getmempoolinfo params: {} id: type: integer default: 1 responses: '200': description: Information about the current state of the transaction mempool content: application/json: schema: type: object properties: result: type: object description: Information about the transaction mempool error: type: object id: type: integer /getmininginfo: post: tags: - General summary: Getmininginfo operationId: getMiningInfo requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getmininginfo params: {} id: type: integer default: 1 responses: '200': description: Various mining-related information. content: application/json: schema: type: object properties: result: type: object description: Contains mining-related information such as blocks, current network hash rate, difficulty, and more. error: type: object id: type: integer /getnettotals: post: tags: - General summary: Getnettotals operationId: getNetTotals requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getnettotals params: {} id: type: integer default: 1 responses: '200': description: Network traffic statistics, including total bytes sent and received. content: application/json: schema: type: object properties: result: type: object description: Contains network traffic statistics. error: type: object id: type: integer /getnetworkhashps: post: tags: - General summary: Getnetworkhashps operationId: getNetworkHashPs requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getnetworkhashps params: type: array items: oneOf: - type: integer description: The number of blocks to calculate the average hash rate over. Default is 120. - type: integer description: The block height at which to calculate the hash rate. Default is -1, meaning the current height. default: - 120 - -1 id: type: integer default: 1 responses: '200': description: The estimated network hashes per second. content: application/json: schema: type: object properties: result: type: number description: The estimated number of hashes per second based on the last n blocks. error: type: object id: type: integer /getnetworkinfo: post: tags: - General summary: Getnetworkinfo operationId: getNetworkInfo requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getnetworkinfo params: {} id: type: integer default: 1 responses: '200': description: Detailed information about the node's network connections. content: application/json: schema: type: object properties: result: type: object description: Contains detailed information about the network connections. error: type: object id: type: integer /getnodeaddresses: post: tags: - General summary: Getnodeaddresses operationId: getNodeAddresses requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getnodeaddresses params: type: array items: type: integer description: The number of addresses to return. If 0 is specified, the node will return all known addresses. default: - 0 id: type: integer default: 1 responses: '200': description: A list of known network peer addresses. content: application/json: schema: type: object properties: result: type: array items: type: object properties: address: type: string description: The peer's network address. port: type: integer description: The peer's port. services: type: string description: The services offered by the peer. time: type: integer description: The last time the address was seen. error: type: object id: type: integer /getpeerinfo: post: tags: - General summary: Getpeerinfo operationId: getPeerInfo requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getpeerinfo params: {} id: type: integer default: 1 responses: '200': description: Information about each connected peer. content: application/json: schema: type: object properties: result: type: array items: type: object description: A list of objects containing information about each peer. error: type: object id: type: integer /getrawmempool: post: tags: - General summary: Getrawmempool operationId: getRawMempool requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getrawmempool params: {} id: type: integer default: 1 responses: '200': description: All transaction IDs in the mempool content: application/json: schema: type: object properties: result: type: array description: An array of transaction IDs in the mempool error: type: object id: type: integer /getrawtransaction: post: tags: - General summary: Getrawtransaction operationId: getRawTransaction requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getrawtransaction params: type: array items: oneOf: - type: string description: The transaction ID. - type: boolean description: Whether to return a detailed, decoded transaction instead of a hex-encoded string. default: - 0bf82c1d62b73497de2d796636cb1ce64415d25982332436007c0f51b5a75a62 - false id: type: integer default: 1 responses: '200': description: The hex-encoded transaction or transaction details. content: application/json: schema: type: object properties: result: oneOf: - type: string description: The hex-encoded transaction. - type: object description: The decoded transaction details, if requested. error: type: object id: type: integer /getrpcinfo: post: tags: - General summary: Getrpcinfo operationId: getRPCInfo requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: getrpcinfo params: {} id: type: integer default: 1 responses: '200': description: Detailed information about the RPC server. content: application/json: schema: type: object properties: result: type: object description: Information about the RPC server, including active commands and total duration. error: type: object id: type: integer /gettxout: post: tags: - General summary: Gettxout operationId: getTxOut requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: gettxout params: type: array items: type: string description: The transaction ID and index example: 0bf82c1d62b73497de2d796636cb1ce64415d25982332436007c0f51b5a75a62, 1 default: - 0bf82c1d62b73497de2d796636cb1ce64415d25982332436007c0f51b5a75a62 - 1 id: type: integer default: 1 responses: '200': description: Information about the specified transaction output content: application/json: schema: type: object properties: result: type: object description: Information about the transaction output error: type: object id: type: integer /gettxoutproof: post: tags: - General summary: Gettxoutproof operationId: getTxOutProof requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: gettxoutproof params: type: array items: type: string description: The transaction ID(s) for which the proof is requested example: - - 0bf82c1d62b73497de2d796636cb1ce64415d25982332436007c0f51b5a75a62 default: - - 0bf82c1d62b73497de2d796636cb1ce64415d25982332436007c0f51b5a75a62 id: type: integer default: 1 responses: '200': description: The merkle branch proof of the transaction inclusion in a block content: application/json: schema: type: object properties: result: type: string description: The hexadecimal string of the merkle branch proof error: type: object id: type: integer /gettxoutsetinfo: post: tags: - General summary: Gettxoutsetinfo operationId: getTxOutsetInfo requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: gettxoutsetinfo params: {} id: type: integer default: 1 responses: '200': description: Statistics about the unspent transaction output set content: application/json: schema: type: object properties: result: type: object description: Statistics about the unspent transaction output set error: type: object id: type: integer /listbanned: post: tags: - General summary: Listbanned operationId: listBanned requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: listbanned params: {} id: type: integer default: 1 responses: '200': description: A list of all banned IP addresses and subnets. content: application/json: schema: type: object properties: result: type: array items: type: object properties: address: type: string description: The banned IP address or subnet. banned_until: type: integer description: Timestamp in Unix time when the ban will be lifted. ban_created: type: integer description: Timestamp in Unix time when the ban was created. ban_reason: type: string description: Reason for the ban. description: Details about each banned IP address or subnet. error: type: object id: type: integer /ping: post: tags: - General summary: Ping operationId: ping requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: ping params: {} id: type: integer default: 1 responses: '200': description: Confirmation that the ping was sent to all connected peers. content: application/json: schema: type: object properties: result: description: The result is always null, indicating the ping was sent. error: type: object id: type: integer /preciousblock: post: tags: - General summary: Preciousblock operationId: preciousBlock requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: preciousblock params: type: array items: type: string description: The hash of the block to be treated as precious example: 000000000000000000011cefb2db6b82b6ae69b4ec06eedc81fc85d16f97865d default: - 000000000000000000011cefb2db6b82b6ae69b4ec06eedc81fc85d16f97865d id: type: integer default: 1 responses: '200': description: Acknowledgement that the block has been marked as precious content: application/json: schema: type: object properties: result: type: string description: The result is always null, indicating the request was processed. Actual type is 'null'. nullable: true error: type: object id: type: integer /prioritisetransaction: post: tags: - General summary: Prioritisetransaction operationId: prioritiseTransaction requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: prioritisetransaction params: type: array items: oneOf: - type: string description: The transaction ID. - type: integer description: The priority delta (increase in priority). - type: integer description: The fee delta in satoshis (increase in fee). example: - 0bf82c1d62b73497de2d796636cb1ce64415d25982332436007c0f51b5a75a62 - 0 - 10000 default: - 0bf82c1d62b73497de2d796636cb1ce64415d25982332436007c0f51b5a75a62 - 0 - 10000 id: type: integer default: 1 responses: '200': description: Confirmation that the transaction priority was increased. content: application/json: schema: type: object properties: result: type: boolean description: True if the transaction priority was successfully increased, false otherwise. error: type: object id: type: integer /uptime: post: tags: - General summary: Uptime operationId: uptime requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: uptime params: {} id: type: integer default: 1 responses: '200': description: The total uptime of the server in seconds content: application/json: schema: type: object properties: result: type: integer description: The uptime of the server in seconds error: type: object id: type: integer /validateaddress: post: tags: - General summary: Validateaddress operationId: validateAddress requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: validateaddress params: type: array items: type: string description: The Bitcoin address to validate. default: - bc1pmvg0vjl7cgayamkd4kvgyktx5849gul67c85pygvt52mpwmx6dtqp92l8r id: type: integer default: 1 responses: '200': description: Information about the validation of the address. content: application/json: schema: type: object properties: result: type: object properties: isvalid: type: boolean description: Whether the address is a valid Bitcoin address. address: type: string description: The Bitcoin address validated (if valid). scriptPubKey: type: string description: The hex-encoded scriptPubKey generated by the address. ismine: type: boolean description: Whether the address belongs to the wallet (if wallet support is enabled). iswatchonly: type: boolean description: Whether the address is watch-only (if wallet support is enabled). isscript: type: boolean description: Whether the address is a script. script: type: string description: The type of script, if `isscript` is true. hex: type: string description: The hex-encoded redeemScript (for P2SH) or witnessScript (for P2WSH), if applicable. addresses: type: array items: type: string description: Array of addresses associated with the script (for multisig scripts). sigsrequired: type: integer description: Number of signatures required (for multisig scripts). pubkey: type: string description: The hex-encoded public key (for P2PKH and P2WPKH addresses). iscompressed: type: boolean description: Whether the public key is compressed. account: type: string description: DEPRECATED. The account associated with the address (will be removed in future versions). timestamp: type: integer description: Timestamp of the address if known. hdkeypath: type: string description: The HD keypath, if the address is HD wallet related. hdseedid: type: string description: The Hash160 of the HD seed. hdmasterfingerprint: type: string description: The fingerprint of the master key. labels: type: array items: type: string description: User-assigned labels for the address. error: type: object id: type: integer /verifychain: post: tags: - General summary: Verifychain operationId: verifyChain requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: verifychain params: type: array items: type: integer description: 'The check level (0-4, default: 3)' example: 3 default: - 3 id: type: integer default: 1 responses: '200': description: The result of the blockchain verification content: application/json: schema: type: object properties: result: type: boolean description: The result of the verification error: type: object id: type: integer /verifytxoutproof: post: tags: - General summary: Verifytxoutproof operationId: verifyTxOutProof requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '1.0' method: type: string default: verifytxoutproof params: type: array items: type: string description: The proof of inclusion for a transaction in a block example: 00e0002000471175ec71a72541c100f21bb79f9da0e5ca98259a000000000000000000004769eae15b51056127304c5dec6d94c7840f8f922c0b65bc32177cb46ce05de9b8c10866d36203175dae051fdc0a00000d625aa7b5510f7c003624338259d21544e61ccb3666792dde9734b7621d2cf80bb81ffa45657310bdc47ad3b3f5e5346c150d4fc1b98a5446cc560c6f38f7156138761aab058be861e51fe52ea7cf7b4914a1e1b159ecebe46b51db0ec5cfd4c2324ae9c132169d1f133981632895c216a8e3c3d3a9cea545fade4c0ab8b626a2791862728b657abbdb06dedcc3faabee9d72ce6b8252b45fc99d6fe0f79cec401e1a431774d8830b962e5dee97fc96f4f85f84a6e50b986a37b35318537a81f3f8c604554e5b4f5ca4b4437caa3b0723896396532c1985d52f42f915084534c6bedb4ded1238781d23be0173b94ca25d7faff2832ac99fa16b2f9b219ff276062f100d4b7ce774ba405fbad36b65165e2e5aece3e0b9718886d7b24708be5ae72d10911e9301811b19fcb218ce7dfee31729f4ef56a3d8f31670865a039b3678b34fcb47f12bd157a064339c3e91a960c5a14b9e8da9c8ce211a02bb94e7165a1668d8a17663e95adcdacdbc8e8ab793e8796fda9b270ca957e67aa33dc95cff158cb2ff6882064942ef545612a8eceb3c60415d677d170f4351ede1f7a8807504ff1f0000 default: - 00e0002000471175ec71a72541c100f21bb79f9da0e5ca98259a000000000000000000004769eae15b51056127304c5dec6d94c7840f8f922c0b65bc32177cb46ce05de9b8c10866d36203175dae051fdc0a00000d625aa7b5510f7c003624338259d21544e61ccb3666792dde9734b7621d2cf80bb81ffa45657310bdc47ad3b3f5e5346c150d4fc1b98a5446cc560c6f38f7156138761aab058be861e51fe52ea7cf7b4914a1e1b159ecebe46b51db0ec5cfd4c2324ae9c132169d1f133981632895c216a8e3c3d3a9cea545fade4c0ab8b626a2791862728b657abbdb06dedcc3faabee9d72ce6b8252b45fc99d6fe0f79cec401e1a431774d8830b962e5dee97fc96f4f85f84a6e50b986a37b35318537a81f3f8c604554e5b4f5ca4b4437caa3b0723896396532c1985d52f42f915084534c6bedb4ded1238781d23be0173b94ca25d7faff2832ac99fa16b2f9b219ff276062f100d4b7ce774ba405fbad36b65165e2e5aece3e0b9718886d7b24708be5ae72d10911e9301811b19fcb218ce7dfee31729f4ef56a3d8f31670865a039b3678b34fcb47f12bd157a064339c3e91a960c5a14b9e8da9c8ce211a02bb94e7165a1668d8a17663e95adcdacdbc8e8ab793e8796fda9b270ca957e67aa33dc95cff158cb2ff6882064942ef545612a8eceb3c60415d677d170f4351ede1f7a8807504ff1f0000 id: type: integer default: 1 responses: '200': description: The transaction IDs included in the proof content: application/json: schema: type: object properties: result: type: array items: type: string description: The list of transaction IDs verified by the proof error: type: object id: type: integer /custom_js_tracer: post: tags: - General summary: Custom JS tracer operationId: traceTransaction requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: debug_traceTransaction params: type: array items: anyOf: - type: string title: Transaction hash description: The hash of the transaction to trace. - type: object title: The JS custom tracer object default: - '0x19b65f065ba8ebe235f0180bfcbc62ec0e7a043073f9f11f46c5775e898ac763' - tracer: '{gasUsed: [], step: function(log) { this.gasUsed.push(log.getGas()); }, result: function() { return this.gasUsed; }, fault: function() {}}' responses: '200': description: The transaction's trace content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /trace_callMany: post: tags: - General summary: trace_callMany operationId: traceCallMany requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: trace_callMany params: type: array items: anyOf: - type: array items: anyOf: - type: array items: anyOf: - type: object properties: from: type: string nullable: true to: type: string data: type: string - type: array items: type: string - type: string default: - - - from: '0x407d73d8a49eeb85d32cf465507dd71d507100c1' to: '0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b' data: '0xa9059cbb000000000000000000000000bc0E63965946815d105E7591407704e6e1964E590000000000000000000000000000000000000000000000000000000005f5e100' - - trace - vmTrace - - from: null to: '0x8965349fb649A33a30cbFDa057D8eC2C48AbE2A2' data: '0x70a08231000000000000000000000000bc0E63965946815d105E7591407704e6e1964E59' - - trace - vmTrace - latest responses: '200': description: The call's traces. content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /evm_debug_get_raw_block: post: summary: debug_getRawBlock description: Returns the complete raw block data for a specific block. This method provides the entire block in its raw encoded format, including header and all transactions. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - debug_getRawBlock default: debug_getRawBlock description: The RPC method name params: type: array description: 'Parameters: [block identifier (block number, hash, or ''latest''/''earliest''/''pending'')]' default: - latest id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: debug_getRawBlock params: - latest id: 1 responses: '200': description: Successful response with raw block data content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: Complete raw block data in hexadecimal format example: jsonrpc: '2.0' id: 1 result: 0xf90211a0... tags: - General operationId: evm_debug_get_raw_block /evm_debug_get_raw_header: post: summary: debug_getRawHeader description: Returns the raw header data for a specific block. This method provides the complete block header in its raw encoded format, useful for low-level blockchain analysis and debugging. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - debug_getRawHeader default: debug_getRawHeader description: The RPC method name params: type: array description: 'Parameters: [block identifier (block number, hash, or ''latest''/''earliest''/''pending'')]' default: - latest id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: debug_getRawHeader params: - latest id: 1 responses: '200': description: Successful response with raw header data content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: Raw header data in hexadecimal format example: jsonrpc: '2.0' id: 1 result: 0xf90211a0... tags: - General operationId: evm_debug_get_raw_header /evm_debug_get_raw_receipts: post: summary: debug_getRawReceipts description: Returns the raw receipt data for all transactions in a specific block. This method provides complete receipt information in raw encoded format for all transactions in a block. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - debug_getRawReceipts default: debug_getRawReceipts description: The RPC method name params: type: array description: 'Parameters: [block identifier (block number, hash, or ''latest''/''earliest''/''pending'')]' default: - latest id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: debug_getRawReceipts params: - latest id: 1 responses: '200': description: Successful response with raw receipts data content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: array description: Array of raw receipt data for all transactions in the block example: jsonrpc: '2.0' id: 1 result: - 0xf90111a0... - 0xf90112a1... tags: - General operationId: evm_debug_get_raw_receipts /evm_debug_get_raw_transaction: post: summary: debug_getRawTransaction description: Returns the raw transaction data for a specific transaction. This method provides the complete transaction in its raw encoded format, useful for low-level analysis and debugging. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - debug_getRawTransaction default: debug_getRawTransaction description: The RPC method name params: type: array description: 'Parameters: [transaction hash]' default: - '0x07712544ce8f50091c6c3b227921f763b342bf9465a22f0226d651a3246adb31' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: debug_getRawTransaction params: - '0x07712544ce8f50091c6c3b227921f763b342bf9465a22f0226d651a3246adb31' id: 1 responses: '200': description: Successful response with raw transaction data content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: Raw transaction data in hexadecimal format example: jsonrpc: '2.0' id: 1 result: 0xf86d80843b9aca0082520894... tags: - General operationId: evm_debug_get_raw_transaction /evm_debug_trace_block: post: summary: debug_traceBlockByHash description: Returns detailed trace information for all transactions in a specific block. This method provides comprehensive debugging information for an entire block, including call traces, gas usage, and execution details for each transaction. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - debug_traceBlockByHash default: debug_traceBlockByHash description: The RPC method name params: type: array description: 'Parameters: [blockHash, tracerConfig]' default: - '0x2ce91ae0ed242b4b78b432a45b982fb81a414d6b04167762ed3c7446710a4b8e' - tracer: callTracer id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: debug_traceBlockByHash params: - '0x2ce91ae0ed242b4b78b432a45b982fb81a414d6b04167762ed3c7446710a4b8e' - tracer: callTracer id: 1 responses: '200': description: Successful response with block trace data content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: array description: Array of trace data for each transaction in the block example: jsonrpc: '2.0' id: 1 result: - type: CALL from: 0x... to: 0x... value: '0x0' gas: 0x... gasUsed: 0x... input: 0x... output: 0x... tags: - General operationId: evm_debug_trace_block /evm_debug_trace_block_by_number: post: summary: debug_traceBlockByNumber description: Returns detailed trace information for all transactions in a specific block identified by block number. This method provides comprehensive debugging information for an entire block, including call traces, gas usage, and execution details for each transaction. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - debug_traceBlockByNumber default: debug_traceBlockByNumber description: The RPC method name params: type: array description: Method parameters default: - '0x1' - tracer: callTracer id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: debug_traceBlockByNumber params: - '0x1' - tracer: callTracer id: 1 responses: '200': description: Successful response content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array description: Trace results tags: - General operationId: evm_debug_trace_block_by_number /evm_debug_trace_call: post: summary: debug_traceCall description: Executes a call and returns detailed trace information without creating a transaction. This method simulates transaction execution and provides debugging information including call traces and state changes. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - debug_traceCall default: debug_traceCall description: The RPC method name params: type: array description: 'Parameters: [callObject, block, tracerConfig]' default: - from: '0x69835D480110e4919B7899f465aAB101e21c8A87' to: '0xB7C609cFfa0e47DB2467ea03fF3e598bf59361A5' gas: '0x76c0' gasPrice: '0x9184e72a000' value: '0xde0b6b3a7640000' data: 0x - latest - tracer: callTracer id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: debug_traceCall params: - from: '0x69835D480110e4919B7899f465aAB101e21c8A87' to: '0xB7C609cFfa0e47DB2467ea03fF3e598bf59361A5' gas: '0x76c0' gasPrice: '0x9184e72a000' value: '0xde0b6b3a7640000' data: 0x - latest - tracer: callTracer id: 1 responses: '200': description: Successful response with call trace data content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object description: Call trace data containing execution information, gas usage, and state changes example: jsonrpc: '2.0' id: 1 result: type: CALL from: '0x69835D480110e4919B7899f465aAB101e21c8A87' to: '0xB7C609cFfa0e47DB2467ea03fF3e598bf59361A5' value: '0xde0b6b3a7640000' gas: '0x76c0' gasUsed: '0x5208' input: 0x output: 0x tags: - General operationId: evm_debug_trace_call /evm_debug_trace_transaction: post: summary: debug_traceTransaction description: Returns detailed trace information for a specific transaction. This method provides comprehensive debugging information including call traces, state changes, and execution details. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - debug_traceTransaction default: debug_traceTransaction description: The RPC method name params: type: array description: 'Parameters: [transactionHash, tracerConfig]' default: - '0x07712544ce8f50091c6c3b227921f763b342bf9465a22f0226d651a3246adb31' - tracer: callTracer id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: debug_traceTransaction params: - '0x07712544ce8f50091c6c3b227921f763b342bf9465a22f0226d651a3246adb31' - tracer: callTracer id: 1 responses: '200': description: Successful response with transaction trace data content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object description: Transaction trace data containing call information, gas usage, and state changes example: jsonrpc: '2.0' id: 1 result: type: CALL from: 0x... to: 0x... value: '0x0' gas: 0x... gasUsed: 0x... input: 0x... output: 0x... tags: - General operationId: evm_debug_trace_transaction /evm_erigon_get_header_by_number: post: summary: erigon_getHeaderByNumber description: Get block header by number using Erigon-specific method on Hyperliquid EVM. Returns detailed header information. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - erigon_getHeaderByNumber default: erigon_getHeaderByNumber description: The RPC method name params: type: array description: 'Parameters: [block number]' default: - 1000 id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: erigon_getHeaderByNumber params: - 1000 id: 1 responses: '200': description: Successful response with block header content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object description: Block header object example: jsonrpc: '2.0' id: 1 result: number: '0x3e8' hash: '0xe8399bf41516f5ca663c79bc30db02b4989385c2f3a96f42958dea5753cbf4a9' parentHash: '0x7c8f6a0e4d3b2a1c9e5f8b7d4a6c3e9f2b8d5a7c1e4f9b3a6d8c2e5f7a9b4c6d' timestamp: '0x6734e8d0' tags: - General operationId: evm_erigon_get_header_by_number /evm_eth_big_block_gas_price: post: summary: eth_bigBlockGasPrice description: Returns the gas price for large blocks on Hyperliquid EVM. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_bigBlockGasPrice default: eth_bigBlockGasPrice description: The RPC method name params: type: array description: No parameters required default: [] id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_bigBlockGasPrice params: [] id: 1 responses: '200': description: Successful response with the big block gas price content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: The big block gas price in wei as a hexadecimal string example: jsonrpc: '2.0' id: 1 result: '0x3b9aca00' tags: - General operationId: evm_eth_big_block_gas_price /evm_eth_blob_base_fee: post: summary: eth_blobBaseFee description: Returns the current base fee for blob transactions. This method provides the current pricing information needed for EIP-4844 blob transactions, essential for cost estimation and blob data submission. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_blobBaseFee default: eth_blobBaseFee description: The RPC method name params: type: array default: [] description: Parameters for the method (empty array for eth_blobBaseFee) id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_blobBaseFee params: [] id: 1 responses: '200': description: Successful response with the current blob base fee content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: The current blob base fee as a hexadecimal string (in wei) example: jsonrpc: '2.0' id: 1 result: '0x1' tags: - General operationId: evm_eth_blob_base_fee /evm_eth_block_number: post: summary: eth_blockNumber description: Returns the number of the most recent block. This method provides the current block height of the Hyperliquid EVM blockchain, which is essential for tracking blockchain state and synchronization. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_blockNumber default: eth_blockNumber description: The RPC method name params: type: array default: [] description: Parameters for the method (empty array for eth_blockNumber) id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_blockNumber params: [] id: 1 responses: '200': description: Successful response with the current block number content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: The current block number as a hexadecimal string example: jsonrpc: '2.0' id: 1 result: '0x1b4' tags: - General operationId: evm_eth_block_number /evm_eth_call: post: summary: Eth_Call description: Executes a new message call immediately without creating a transaction on the blockchain. This method is used to call smart contract functions and retrieve data without modifying the blockchain state. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_call default: eth_call description: The RPC method name params: type: array description: 'Parameters: [transaction object, block parameter]' default: - to: '0x5555555555555555555555555555555555555555' data: '0x18160ddd' - latest id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_call params: - to: '0x5555555555555555555555555555555555555555' data: '0x18160ddd' - latest id: 1 responses: '200': description: Successful response with the call result content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: The return value of the executed contract method as a hexadecimal string example: jsonrpc: '2.0' id: 1 result: '0x0000000000000000000000000000000000000000000000000de0b6b3a7640000' tags: - General operationId: evm_eth_call /evm_eth_call_many: post: summary: eth_callMany description: Executes multiple call transactions in sequence without creating transactions on the blockchain. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_callMany default: eth_callMany description: The RPC method name params: type: array description: 'Parameters: [callContextArray, blockState]' default: - - transactions: - to: '0x5555555555555555555555555555555555555555' data: '0x70a082310000000000000000000000008D25Fb438C6efCD08679ffA82766869B50E24608' - to: '0xb8ce59fc3717ada4c02eadf9682a9e934f625ebb' data: '0x70a082310000000000000000000000008D25Fb438C6efCD08679ffA82766869B50E24608' - blockNumber: latest id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_callMany params: - - transactions: - to: '0x5555555555555555555555555555555555555555' data: '0x70a082310000000000000000000000008D25Fb438C6efCD08679ffA82766869B50E24608' - to: '0xb8ce59fc3717ada4c02eadf9682a9e934f625ebb' data: '0x70a082310000000000000000000000008D25Fb438C6efCD08679ffA82766869B50E24608' - blockNumber: latest id: 1 responses: '200': description: Successful response with call results content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: array description: Array of call results items: type: string description: Hexadecimal result data example: jsonrpc: '2.0' id: 1 result: - 0x - '0x0000000000000000000000000000000000000000000000000000000000000000' - 0x tags: - General operationId: evm_eth_call_many /evm_eth_chain_id: post: summary: eth_chainId description: Returns the chain ID of the currently connected blockchain network. This method is essential for identifying the specific blockchain network and ensuring transaction compatibility. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_chainId default: eth_chainId description: The RPC method name params: type: array default: [] description: Parameters for the method (empty array for eth_chainId) id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_chainId params: [] id: 1 responses: '200': description: Successful response with the chain ID content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: The chain ID as a hexadecimal string example: jsonrpc: '2.0' id: 1 result: '0x3e7' tags: - General operationId: evm_eth_chain_id /evm_eth_create_access_list: post: summary: eth_createAccessList description: Generates an access list for a transaction to optimize gas usage. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_createAccessList default: eth_createAccessList description: The RPC method name params: type: array description: 'Parameters: [transactionObject, block]' default: - from: '0x69835D480110e4919B7899f465aAB101e21c8A87' to: '0xb4DcFE4590adBd275aC3Ef1A3dd10e819d11648c' gas: '0x76c0' gasPrice: '0x9184e72a000' value: '0xde0b6b3a7640000' data: 0x - latest id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_createAccessList params: - from: '0x69835D480110e4919B7899f465aAB101e21c8A87' to: '0xb4DcFE4590adBd275aC3Ef1A3dd10e819d11648c' gas: '0x76c0' gasPrice: '0x9184e72a000' value: '0xde0b6b3a7640000' data: 0x - latest id: 1 responses: '200': description: Successful response with the generated access list content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object description: The access list and gas information properties: accessList: type: array description: Array of access list entries items: type: object properties: address: type: string description: The accessed contract address storageKeys: type: array description: Array of accessed storage keys items: type: string gasUsed: type: string description: The estimated gas used with the access list error: type: string description: Error message if transaction would fail example: jsonrpc: '2.0' id: 1 result: accessList: - address: '0xb4DcFE4590adBd275aC3Ef1A3dd10e819d11648c' storageKeys: - '0x0000000000000000000000000000000000000000000000000000000000000000' - '0x0000000000000000000000000000000000000000000000000000000000000001' gasUsed: '0x5208' '400': description: Bad request content: application/json: schema: type: object properties: jsonrpc: type: string example: '2.0' id: type: integer example: 1 error: type: object properties: code: type: integer example: -32602 message: type: string example: Invalid params tags: - General operationId: evm_eth_create_access_list /evm_eth_estimate_gas: post: summary: eth_estimateGas description: Estimates the amount of gas required to execute a transaction without actually executing it on the blockchain. Only the latest block is supported on Hyperliquid. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_estimateGas default: eth_estimateGas description: The RPC method name params: type: array description: 'Parameters: [transaction object]' default: - from: '0xFC1286EeddF81d6955eDAd5C8D99B8Aa32F3D2AA' to: '0x5555555555555555555555555555555555555555' data: '0xa9059cbb000000000000000000000000fefefefefefefefefefefefefefefefefefefefe0000000000000000000000000000000000000000000000000de0b6b3a7640000' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_estimateGas params: - from: '0xFC1286EeddF81d6955eDAd5C8D99B8Aa32F3D2AA' to: '0x5555555555555555555555555555555555555555' data: '0xa9059cbb000000000000000000000000fefefefefefefefefefefefefefefefefefefefe0000000000000000000000000000000000000000000000000de0b6b3a7640000' id: 1 responses: '200': description: Successful response with the estimated gas amount content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: The estimated gas amount as a hexadecimal string example: jsonrpc: '2.0' id: 1 result: '0x5208' tags: - General operationId: evm_eth_estimate_gas /evm_eth_fee_history: post: summary: eth_feeHistory description: Returns historical gas fee data for a range of blocks, including base fees and priority fees at specified percentiles. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_feeHistory default: eth_feeHistory description: The RPC method name params: type: array description: 'Parameters: [blockCount, newestBlock, rewardPercentiles]' default: - '0x4' - latest - - 25 - 50 - 75 id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_feeHistory params: - '0x4' - latest - - 25 - 50 - 75 id: 1 responses: '200': description: Successful response with historical fee data content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object properties: oldestBlock: type: string description: The oldest block number in the range as a hexadecimal string baseFeePerGas: type: array items: type: string description: Array of base fees per gas for each block gasUsedRatio: type: array items: type: number description: Array of gas used ratios for each block reward: type: array items: type: array items: type: string description: Array of priority fee rewards at specified percentiles for each block example: jsonrpc: '2.0' id: 1 result: oldestBlock: '0x1234' baseFeePerGas: - '0x3b9aca00' - '0x3b9aca00' - '0x3b9aca00' - '0x3b9aca00' gasUsedRatio: - 0.5 - 0.6 - 0.4 - 0.7 reward: - - '0x1' - '0x2' - '0x3' - - '0x1' - '0x2' - '0x3' - - '0x1' - '0x2' - '0x3' - - '0x1' - '0x2' - '0x3' tags: - General operationId: evm_eth_fee_history /evm_eth_gas_price: post: summary: eth_gasPrice description: Returns the current gas price in wei as determined by the network. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_gasPrice default: eth_gasPrice description: The RPC method name params: type: array description: No parameters required default: [] id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_gasPrice params: [] id: 1 responses: '200': description: Successful response with the current gas price content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: The current gas price in wei as a hexadecimal string example: jsonrpc: '2.0' id: 1 result: '0x3b9aca00' tags: - General operationId: evm_eth_gas_price /evm_eth_get_balance: post: summary: eth_getBalance description: Returns the balance of an account at a given block number. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getBalance default: eth_getBalance description: The RPC method name params: type: array description: 'Parameters: [address, block]' default: - '0xFC1286EeddF81d6955eDAd5C8D99B8Aa32F3D2AA' - latest id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getBalance params: - '0xFC1286EeddF81d6955eDAd5C8D99B8Aa32F3D2AA' - latest id: 1 responses: '200': description: Successful response with the account balance content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: The account balance in wei as a hexadecimal string example: jsonrpc: '2.0' id: 1 result: '0xde0b6b3a7640000' tags: - General operationId: evm_eth_get_balance /evm_eth_get_block_by_hash: post: summary: eth_getBlockByHash description: Returns information about a block by its hash. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getBlockByHash default: eth_getBlockByHash description: The RPC method name params: type: array description: 'Parameters: [blockHash, fullTransactionObjects]' default: - '0x53e84f299e6893680383c6a53329574122a7292e5bb9397bb6a0b51b4db5957a' - false id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getBlockByHash params: - '0x53e84f299e6893680383c6a53329574122a7292e5bb9397bb6a0b51b4db5957a' - false id: 1 responses: '200': description: Successful response with block information content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object properties: number: type: string description: Block number as a hexadecimal string hash: type: string description: Block hash parentHash: type: string description: Hash of the parent block timestamp: type: string description: Block timestamp as a hexadecimal string gasLimit: type: string description: Gas limit for the block gasUsed: type: string description: Total gas used by all transactions in the block transactions: type: array description: Array of transaction hashes or full transaction objects miner: type: string description: Address of the block miner difficulty: type: string description: Block difficulty totalDifficulty: type: string description: Total difficulty of the chain until this block size: type: string description: Block size in bytes extraData: type: string description: Extra data field of the block example: jsonrpc: '2.0' id: 1 result: number: '0x1234' hash: '0x53e84f299e6893680383c6a53329574122a7292e5bb9397bb6a0b51b4db5957a' parentHash: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' timestamp: '0x61bc8c3a' gasLimit: '0x1c9c380' gasUsed: '0x5208' transactions: - 0xabc123... - 0xdef456... miner: '0x0000000000000000000000000000000000000000' difficulty: '0x0' totalDifficulty: '0x0' size: '0x220' extraData: 0x tags: - General operationId: evm_eth_get_block_by_hash /evm_eth_get_block_by_number: post: summary: eth_getBlockByNumber description: Returns information about a block by its number. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getBlockByNumber default: eth_getBlockByNumber description: The RPC method name params: type: array description: 'Parameters: [blockNumber, fullTransactionObjects]' default: - '0x9d0c37' - false id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getBlockByNumber params: - '0x9d0c37' - false id: 1 responses: '200': description: Successful response with block information content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object properties: number: type: string description: Block number as a hexadecimal string hash: type: string description: Block hash parentHash: type: string description: Hash of the parent block timestamp: type: string description: Block timestamp as a hexadecimal string gasLimit: type: string description: Gas limit for the block gasUsed: type: string description: Total gas used by all transactions in the block transactions: type: array description: Array of transaction hashes or full transaction objects miner: type: string description: Address of the block miner difficulty: type: string description: Block difficulty totalDifficulty: type: string description: Total difficulty of the chain until this block size: type: string description: Block size in bytes extraData: type: string description: Extra data field of the block example: jsonrpc: '2.0' id: 1 result: number: '0x9d0c37' hash: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' parentHash: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890' timestamp: '0x61bc8c3a' gasLimit: '0x1c9c380' gasUsed: '0x5208' transactions: - 0xabc123... - 0xdef456... miner: '0x0000000000000000000000000000000000000000' difficulty: '0x0' totalDifficulty: '0x0' size: '0x220' extraData: 0x tags: - General operationId: evm_eth_get_block_by_number /evm_eth_get_block_receipts: post: summary: eth_getBlockReceipts description: Returns all transaction receipts for a given block. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getBlockReceipts default: eth_getBlockReceipts description: The RPC method name params: type: array description: 'Parameters: [blockNumber]' default: - '0x9d0c37' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getBlockReceipts params: - '0x9d0c37' id: 1 responses: '200': description: Successful response with all transaction receipts for the block content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: array description: Array of transaction receipt objects items: type: object properties: transactionHash: type: string description: Hash of the transaction transactionIndex: type: string description: Index of the transaction in the block blockHash: type: string description: Hash of the block containing the transaction blockNumber: type: string description: Number of the block containing the transaction from: type: string description: Address of the sender to: type: string description: Address of the receiver gasUsed: type: string description: Amount of gas used by the transaction cumulativeGasUsed: type: string description: Total gas used in the block up to this transaction contractAddress: type: string description: Contract address created, if the transaction was a contract creation logs: type: array description: Array of log objects generated by the transaction status: type: string description: Transaction status (0x0 for failure, 0x1 for success) effectiveGasPrice: type: string description: Actual gas price paid by the transaction type: type: string description: Transaction type example: jsonrpc: '2.0' id: 1 result: - transactionHash: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' transactionIndex: '0x0' blockHash: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890' blockNumber: '0x9d0c37' from: '0xFC1286EeddF81d6955eDAd5C8D99B8Aa32F3D2AA' to: '0x5555555555555555555555555555555555555555' gasUsed: '0x5208' cumulativeGasUsed: '0x5208' contractAddress: null logs: [] status: '0x1' effectiveGasPrice: '0x3b9aca00' type: '0x0' tags: - General operationId: evm_eth_get_block_receipts /evm_eth_get_block_transaction_count_by_hash: post: summary: eth_getBlockTransactionCountByHash description: Returns the number of transactions in a block by its hash. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getBlockTransactionCountByHash default: eth_getBlockTransactionCountByHash description: The RPC method name params: type: array description: 'Parameters: [blockHash]' default: - '0x53e84f299e6893680383c6a53329574122a7292e5bb9397bb6a0b51b4db5957a' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getBlockTransactionCountByHash params: - '0x53e84f299e6893680383c6a53329574122a7292e5bb9397bb6a0b51b4db5957a' id: 1 responses: '200': description: Successful response with the transaction count content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: The number of transactions in the block as a hexadecimal string example: jsonrpc: '2.0' id: 1 result: '0x5' tags: - General operationId: evm_eth_get_block_transaction_count_by_hash /evm_eth_get_block_transaction_count_by_number: post: summary: eth_getBlockTransactionCountByNumber description: Returns the number of transactions in a block by its number. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getBlockTransactionCountByNumber default: eth_getBlockTransactionCountByNumber description: The RPC method name params: type: array description: 'Parameters: [blockNumber]' default: - '0x9d0c37' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getBlockTransactionCountByNumber params: - '0x9d0c37' id: 1 responses: '200': description: Successful response with the transaction count content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: The number of transactions in the block as a hexadecimal string example: jsonrpc: '2.0' id: 1 result: '0x3' tags: - General operationId: evm_eth_get_block_transaction_count_by_number /evm_eth_get_code: post: summary: eth_getCode description: Returns the bytecode of a smart contract at a given address and block. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getCode default: eth_getCode description: The RPC method name params: type: array description: 'Parameters: [address, block]' default: - '0x5555555555555555555555555555555555555555' - latest id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getCode params: - '0x5555555555555555555555555555555555555555' - latest id: 1 responses: '200': description: Successful response with the contract bytecode content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: The contract bytecode as a hexadecimal string, or '0x' if no code exists example: jsonrpc: '2.0' id: 1 result: 0x608060405234801561001057600080fd5b50600436106100365760003560e01c8063a9059cbb1461003b578063dd62ed3e14610057575b600080fd5b610055600480360381019061005091906101a7565b610087565b005b610071600480360381019061006c91906101e7565b6100a5565b60405161007e9190610236565b60405180910390f35b8173ffffffffffffffffffffffffffffffffffffffff16ff5b60008173ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff1614156100e0576000905061012c565b8173ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff161415610120576001905061012c565b60009050610131565b809150505b92915050565b600080fd5b600073ffffffffffffffffffffffffffffffffffffffff82169050919050565b600061016782610138565b9050919050565b6101778161015c565b811461018257600080fd5b50565b6000813590506101948161016e565b92915050565b6000819050919050565b6101ad8161019a565b81146101b857600080fd5b50565b6000813590506101ca816101a4565b92915050565b600080604083850312156101e7576101e6610133565b5b60006101f585828601610185565b9250506020610206858286016101bb565b9150509250929050565b600080604083850312156102275761022661013357600080fd5b5b600061023585828601610185565b925050602061024685828601610185565b9150509250929050565b6102598161019a565b82525050565b60006020820190506102746000830184610250565b9291505056fea2646970667358221220... tags: - General operationId: evm_eth_get_code /evm_eth_get_filter_changes: post: summary: eth_getFilterChanges description: Returns an array of logs or block hashes that have occurred since the last poll for the specified filter. This method is used to retrieve new results from filters created with eth_newFilter or eth_newBlockFilter. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getFilterChanges default: eth_getFilterChanges description: The RPC method name params: type: array description: 'Parameters: [filter_id]' default: - '0x1' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getFilterChanges params: - '0x1' id: 1 responses: '200': description: Successful response with filter changes content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: array description: Array of logs (for log filters) or block hashes (for block filters) example: jsonrpc: '2.0' id: 1 result: [] tags: - General operationId: evm_eth_get_filter_changes /evm_eth_get_filter_logs: post: summary: eth_getFilterLogs description: Returns an array of all logs matching the filter with the given ID. Unlike eth_getFilterChanges, this method returns all matching logs from the entire filter range, not just changes since the last poll. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getFilterLogs default: eth_getFilterLogs description: The RPC method name params: type: array description: 'Parameters: [filter_id]' default: - '0x1' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getFilterLogs params: - '0x1' id: 1 responses: '200': description: Successful response with all matching logs content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: array description: Array of log objects matching the filter criteria example: jsonrpc: '2.0' id: 1 result: [] tags: - General operationId: evm_eth_get_filter_logs /evm_eth_get_header_by_hash: post: summary: eth_getHeaderByHash description: Returns the block header information for a given block hash. This method provides header data without the transaction list, offering a lightweight way to access block metadata when you have the block hash. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getHeaderByHash default: eth_getHeaderByHash description: The RPC method name params: type: array description: 'Parameters: [block_hash]' default: - '0x2ce91ae0ed242b4b78b432a45b982fb81a414d6b04167762ed3c7446710a4b8e' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getHeaderByHash params: - '0x2ce91ae0ed242b4b78b432a45b982fb81a414d6b04167762ed3c7446710a4b8e' id: 1 responses: '200': description: Successful response with block header information content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object description: Block header information or null if not found nullable: true example: jsonrpc: '2.0' id: 1 result: hash: '0x2ce91ae0ed242b4b78b432a45b982fb81a414d6b04167762ed3c7446710a4b8e' parentHash: 0x... number: 0x... timestamp: 0x... gasLimit: 0x... gasUsed: 0x... tags: - General operationId: evm_eth_get_header_by_hash /evm_eth_get_header_by_number: post: summary: eth_getHeaderByNumber description: Returns the block header information for a given block number. This method provides header data without the transaction list, offering a lightweight way to access block metadata. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getHeaderByNumber default: eth_getHeaderByNumber description: The RPC method name params: type: array description: 'Parameters: [block_number]' default: - latest id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getHeaderByNumber params: - latest id: 1 responses: '200': description: Successful response with block header information content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object description: Block header information or null if not found nullable: true example: jsonrpc: '2.0' id: 1 result: hash: 0x... parentHash: 0x... number: 0x... timestamp: 0x... gasLimit: 0x... gasUsed: 0x... tags: - General operationId: evm_eth_get_header_by_number /evm_eth_get_logs: post: summary: eth_getLogs description: Returns event logs that match specified filter criteria. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getLogs default: eth_getLogs description: The RPC method name params: type: array description: 'Parameters: [filterObject]' default: - address: '0x5555555555555555555555555555555555555555' fromBlock: '0x9d0c37' toBlock: '0x9d0c42' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getLogs params: - address: '0x5555555555555555555555555555555555555555' fromBlock: '0x9d0c37' toBlock: '0x9d0c42' id: 1 responses: '200': description: Successful response with matching event logs content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: array description: Array of log objects matching the filter criteria items: type: object properties: address: type: string description: Contract address that emitted the log topics: type: array items: type: string description: Array of indexed event parameters data: type: string description: Non-indexed event parameters as hexadecimal string blockNumber: type: string description: Block number containing the log blockHash: type: string description: Hash of the block containing the log transactionHash: type: string description: Hash of the transaction that generated the log transactionIndex: type: string description: Index of the transaction in the block logIndex: type: string description: Index of the log in the transaction removed: type: boolean description: Whether the log was removed due to chain reorganization example: jsonrpc: '2.0' id: 1 result: - address: '0x5555555555555555555555555555555555555555' topics: - '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef' - '0x000000000000000000000000fc1286eeddf81d6955edad5c8d99b8aa32f3d2aa' - '0x0000000000000000000000005555555555555555555555555555555555555555' data: '0x0000000000000000000000000000000000000000000000000de0b6b3a7640000' blockNumber: '0x9d0c37' blockHash: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' transactionHash: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890' transactionIndex: '0x0' logIndex: '0x0' removed: false tags: - General operationId: evm_eth_get_logs /evm_eth_get_proof: post: summary: eth_getProof description: Returns the Merkle proof for an account and optionally some storage keys. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getProof default: eth_getProof description: The RPC method name params: type: array description: 'Parameters: [address, storageKeys, block]' default: - '0x69835D480110e4919B7899f465aAB101e21c8A87' - [] - latest id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getProof params: - '0x69835D480110e4919B7899f465aAB101e21c8A87' - [] - latest id: 1 responses: '200': description: Successful response content: application/json: schema: type: object properties: jsonrpc: type: string example: '2.0' id: type: integer example: 1 result: type: object description: The account and storage proofs properties: address: type: string description: The account address example: '0x69835D480110e4919B7899f465aAB101e21c8A87' accountProof: type: array description: Array of RLP-encoded Merkle tree nodes items: type: string balance: type: string description: The account balance in wei example: '0x0' codeHash: type: string description: The hash of the account code example: '0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470' nonce: type: string description: The account nonce example: '0x0' storageHash: type: string description: The hash of the storage trie root example: '0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421' storageProof: type: array description: Array of storage proof objects items: type: object properties: key: type: string description: The storage key value: type: string description: The storage value proof: type: array description: Array of RLP-encoded nodes items: type: string '400': description: Bad request content: application/json: schema: type: object properties: jsonrpc: type: string example: '2.0' id: type: integer example: 1 error: type: object properties: code: type: integer example: -32602 message: type: string example: Invalid params tags: - General operationId: evm_eth_get_proof /evm_eth_get_raw_transaction_by_block_hash_and_index: post: summary: eth_getRawTransactionByBlockHashAndIndex description: Returns the raw transaction data by block hash and transaction index. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getRawTransactionByBlockHashAndIndex default: eth_getRawTransactionByBlockHashAndIndex description: The RPC method name params: type: array description: 'Parameters: [blockHash, transactionIndex]' default: - '0x2ce91ae0ed242b4b78b432a45b982fb81a414d6b04167762ed3c7446710a4b8e' - '0x0' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getRawTransactionByBlockHashAndIndex params: - '0x2ce91ae0ed242b4b78b432a45b982fb81a414d6b04167762ed3c7446710a4b8e' - '0x0' id: 1 responses: '200': description: Successful response with raw transaction data content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: Raw transaction data as hex-encoded string, or null if not found example: jsonrpc: '2.0' id: 1 result: '0xf86c0185037e11d6008252089433c3321b162edac1fdbb53af2962b2940c07e334880de0b6b3a76400008026a01234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdefa0abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890ab' tags: - General operationId: evm_eth_get_raw_transaction_by_block_hash_and_index /evm_eth_get_raw_transaction_by_block_number_and_index: post: summary: eth_getRawTransactionByBlockNumberAndIndex description: Returns the raw transaction data by block number and transaction index. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getRawTransactionByBlockNumberAndIndex default: eth_getRawTransactionByBlockNumberAndIndex description: The RPC method name params: type: array description: 'Parameters: [blockNumber, transactionIndex]' default: - latest - '0x0' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getRawTransactionByBlockNumberAndIndex params: - latest - '0x0' id: 1 responses: '200': description: Successful response with raw transaction data content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: Raw transaction data as hex-encoded string, or null if not found example: jsonrpc: '2.0' id: 1 result: '0xf86c0185037e11d6008252089433c3321b162edac1fdbb53af2962b2940c07e334880de0b6b3a76400008026a01234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdefa0abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890ab' tags: - General operationId: evm_eth_get_raw_transaction_by_block_number_and_index /evm_eth_get_raw_transaction_by_hash: post: summary: eth_getRawTransactionByHash description: Returns the raw transaction data by its hash. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getRawTransactionByHash default: eth_getRawTransactionByHash description: The RPC method name params: type: array description: 'Parameters: [transactionHash]' default: - '0x66112ff0438f84686c8003f3a855057694c9018f07905c0e15f2f20f4dd0791a' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getRawTransactionByHash params: - '0x66112ff0438f84686c8003f3a855057694c9018f07905c0e15f2f20f4dd0791a' id: 1 responses: '200': description: Successful response with raw transaction data content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: Raw transaction data as hex-encoded string, or null if not found example: jsonrpc: '2.0' id: 1 result: '0xf86c0185037e11d6008252089433c3321b162edac1fdbb53af2962b2940c07e334880de0b6b3a76400008026a01234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdefa0abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890ab' tags: - General operationId: evm_eth_get_raw_transaction_by_hash /evm_eth_get_storage_at: post: summary: eth_getStorageAt description: Returns the value stored at a specific storage position in a smart contract. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getStorageAt default: eth_getStorageAt description: The RPC method name params: type: array description: 'Parameters: [address, position, block]' default: - '0x5555555555555555555555555555555555555555' - '0x0' - latest id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getStorageAt params: - '0x5555555555555555555555555555555555555555' - '0x0' - latest id: 1 responses: '200': description: Successful response with the storage value content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: The 32-byte storage value as a hexadecimal string example: jsonrpc: '2.0' id: 1 result: '0x000000000000000000000000fc1286eeddf81d6955edad5c8d99b8aa32f3d2aa' tags: - General operationId: evm_eth_get_storage_at /evm_eth_get_system_txs_by_block_hash: post: summary: eth_getSystemTxsByBlockHash description: Returns system transactions for a given block hash on Hyperliquid EVM. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getSystemTxsByBlockHash default: eth_getSystemTxsByBlockHash description: The RPC method name params: type: array description: 'Parameters: [blockHash]' default: - '0x1970d9c7ce6f00a982b421610ad400a79522c102a26db24ef3ec1f2bd621c399' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getSystemTxsByBlockHash params: - '0x1970d9c7ce6f00a982b421610ad400a79522c102a26db24ef3ec1f2bd621c399' id: 1 responses: '200': description: Successful response with system transactions content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: array description: Array of system transaction objects items: type: object properties: hash: type: string description: System transaction hash type: type: string description: System transaction type blockNumber: type: string description: Block number containing the system transaction blockHash: type: string description: Hash of the block containing the system transaction transactionIndex: type: string description: Index of the system transaction in the block from: type: string description: System address that initiated the transaction to: type: string description: Target address of the system transaction value: type: string description: Value transferred in the system transaction gasUsed: type: string description: Gas used by the system transaction gasPrice: type: string description: Gas price for the system transaction input: type: string description: Input data for the system transaction status: type: string description: System transaction status example: jsonrpc: '2.0' id: 1 result: - hash: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' type: '0x7e' blockNumber: '0x9d16cf' blockHash: '0x1970d9c7ce6f00a982b421610ad400a79522c102a26db24ef3ec1f2bd621c399' transactionIndex: '0x0' from: '0x0000000000000000000000000000000000000000' to: '0x1111111111111111111111111111111111111111' value: '0x0' gasUsed: '0x5208' gasPrice: '0x0' input: 0x status: '0x1' tags: - General operationId: evm_eth_get_system_txs_by_block_hash /evm_eth_get_system_txs_by_block_number: post: summary: eth_getSystemTxsByBlockNumber description: Returns system transactions for a given block number on Hyperliquid EVM. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getSystemTxsByBlockNumber default: eth_getSystemTxsByBlockNumber description: The RPC method name params: type: array description: 'Parameters: [blockNumber]' default: - '0x9d16cf' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getSystemTxsByBlockNumber params: - '0x9d16cf' id: 1 responses: '200': description: Successful response with system transactions content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: array description: Array of system transaction objects items: type: object properties: hash: type: string description: System transaction hash type: type: string description: System transaction type blockNumber: type: string description: Block number containing the system transaction blockHash: type: string description: Hash of the block containing the system transaction transactionIndex: type: string description: Index of the system transaction in the block from: type: string description: System address that initiated the transaction to: type: string description: Target address of the system transaction value: type: string description: Value transferred in the system transaction gasUsed: type: string description: Gas used by the system transaction gasPrice: type: string description: Gas price for the system transaction input: type: string description: Input data for the system transaction status: type: string description: System transaction status example: jsonrpc: '2.0' id: 1 result: - hash: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' type: '0x7e' blockNumber: '0x9d16cf' blockHash: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890' transactionIndex: '0x0' from: '0x0000000000000000000000000000000000000000' to: '0x1111111111111111111111111111111111111111' value: '0x0' gasUsed: '0x5208' gasPrice: '0x0' input: 0x status: '0x1' tags: - General operationId: evm_eth_get_system_txs_by_block_number /evm_eth_get_transaction_by_block_hash_and_index: post: summary: eth_getTransactionByBlockHashAndIndex description: Returns transaction information by block hash and transaction index. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getTransactionByBlockHashAndIndex default: eth_getTransactionByBlockHashAndIndex description: The RPC method name params: type: array description: 'Parameters: [blockHash, transactionIndex]' default: - '0x53e84f299e6893680383c6a53329574122a7292e5bb9397bb6a0b51b4db5957a' - '0x0' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getTransactionByBlockHashAndIndex params: - '0x53e84f299e6893680383c6a53329574122a7292e5bb9397bb6a0b51b4db5957a' - '0x0' id: 1 responses: '200': description: Successful response with transaction information content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object properties: hash: type: string description: Transaction hash nonce: type: string description: Transaction nonce blockHash: type: string description: Hash of the block containing the transaction blockNumber: type: string description: Number of the block containing the transaction transactionIndex: type: string description: Index of the transaction in the block from: type: string description: Address of the sender to: type: string description: Address of the receiver value: type: string description: Value transferred in wei gas: type: string description: Gas limit provided by the sender gasPrice: type: string description: Gas price provided by the sender in wei input: type: string description: Data sent along with the transaction v: type: string description: ECDSA recovery id r: type: string description: ECDSA signature r s: type: string description: ECDSA signature s type: type: string description: Transaction type example: jsonrpc: '2.0' id: 1 result: hash: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' nonce: '0x1' blockHash: '0x53e84f299e6893680383c6a53329574122a7292e5bb9397bb6a0b51b4db5957a' blockNumber: '0x9d0c37' transactionIndex: '0x0' from: '0xFC1286EeddF81d6955eDAd5C8D99B8Aa32F3D2AA' to: '0x5555555555555555555555555555555555555555' value: '0xde0b6b3a7640000' gas: '0x5208' gasPrice: '0x3b9aca00' input: 0x v: '0x1c' r: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890' type: '0x0' tags: - General operationId: evm_eth_get_transaction_by_block_hash_and_index /evm_eth_get_transaction_by_block_number_and_index: post: summary: eth_getTransactionByBlockNumberAndIndex description: Returns transaction information by block number and transaction index. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getTransactionByBlockNumberAndIndex default: eth_getTransactionByBlockNumberAndIndex description: The RPC method name params: type: array description: 'Parameters: [blockNumber, transactionIndex]' default: - '0x9d0c37' - '0x0' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getTransactionByBlockNumberAndIndex params: - '0x9d0c37' - '0x0' id: 1 responses: '200': description: Successful response with transaction information content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object properties: hash: type: string description: Transaction hash nonce: type: string description: Transaction nonce blockHash: type: string description: Hash of the block containing the transaction blockNumber: type: string description: Number of the block containing the transaction transactionIndex: type: string description: Index of the transaction in the block from: type: string description: Address of the sender to: type: string description: Address of the receiver value: type: string description: Value transferred in wei gas: type: string description: Gas limit provided by the sender gasPrice: type: string description: Gas price provided by the sender in wei input: type: string description: Data sent along with the transaction v: type: string description: ECDSA recovery id r: type: string description: ECDSA signature r s: type: string description: ECDSA signature s type: type: string description: Transaction type example: jsonrpc: '2.0' id: 1 result: hash: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' nonce: '0x1' blockHash: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890' blockNumber: '0x9d0c37' transactionIndex: '0x0' from: '0xFC1286EeddF81d6955eDAd5C8D99B8Aa32F3D2AA' to: '0x5555555555555555555555555555555555555555' value: '0xde0b6b3a7640000' gas: '0x5208' gasPrice: '0x3b9aca00' input: 0x v: '0x1c' r: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890' type: '0x0' tags: - General operationId: evm_eth_get_transaction_by_block_number_and_index /evm_eth_get_transaction_by_hash: post: summary: eth_getTransactionByHash description: Returns transaction information by its hash. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getTransactionByHash default: eth_getTransactionByHash description: The RPC method name params: type: array description: 'Parameters: [transactionHash]' default: - '0x33c3321b162edac1fdbb53af2962b2940c07e334a4f5ff758f1d5ef1235e55d0' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getTransactionByHash params: - '0x33c3321b162edac1fdbb53af2962b2940c07e334a4f5ff758f1d5ef1235e55d0' id: 1 responses: '200': description: Successful response with transaction information content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object properties: hash: type: string description: Transaction hash nonce: type: string description: Transaction nonce blockHash: type: string description: Hash of the block containing the transaction blockNumber: type: string description: Number of the block containing the transaction transactionIndex: type: string description: Index of the transaction in the block from: type: string description: Address of the sender to: type: string description: Address of the receiver value: type: string description: Value transferred in wei gas: type: string description: Gas limit provided by the sender gasPrice: type: string description: Gas price provided by the sender in wei input: type: string description: Data sent along with the transaction v: type: string description: ECDSA recovery id r: type: string description: ECDSA signature r s: type: string description: ECDSA signature s type: type: string description: Transaction type example: jsonrpc: '2.0' id: 1 result: hash: '0x33c3321b162edac1fdbb53af2962b2940c07e334a4f5ff758f1d5ef1235e55d0' nonce: '0x1' blockHash: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890' blockNumber: '0x9d0c37' transactionIndex: '0x0' from: '0xFC1286EeddF81d6955eDAd5C8D99B8Aa32F3D2AA' to: '0x5555555555555555555555555555555555555555' value: '0xde0b6b3a7640000' gas: '0x5208' gasPrice: '0x3b9aca00' input: 0x v: '0x1c' r: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890' type: '0x0' tags: - General operationId: evm_eth_get_transaction_by_hash /evm_eth_get_transaction_by_sender_and_nonce: post: summary: eth_getTransactionBySenderAndNonce description: Returns transaction information for a specific sender address and nonce. This method is useful for tracking transactions when you know the sender and the sequence number of their transaction. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getTransactionBySenderAndNonce default: eth_getTransactionBySenderAndNonce description: The RPC method name params: type: array description: 'Parameters: [sender_address, nonce]' default: - '0x69835D480110e4919B7899f465aAB101e21c8A87' - '0x0' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getTransactionBySenderAndNonce params: - '0x69835D480110e4919B7899f465aAB101e21c8A87' - '0x0' id: 1 responses: '200': description: Successful response with transaction information or null if not found content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object description: Transaction object or null if not found nullable: true properties: blockHash: type: string description: Hash of the block containing the transaction blockNumber: type: string description: Block number containing the transaction (hexadecimal) from: type: string description: Address of the transaction sender gas: type: string description: Gas limit provided for the transaction (hexadecimal) gasPrice: type: string description: Gas price used for the transaction (hexadecimal) hash: type: string description: Transaction hash input: type: string description: Transaction data payload nonce: type: string description: Transaction nonce (hexadecimal) to: type: string description: Address of the transaction recipient transactionIndex: type: string description: Position of transaction in the block (hexadecimal) value: type: string description: Value transferred in the transaction (hexadecimal, in wei) type: type: string description: Transaction type (hexadecimal) v: type: string description: Transaction signature v component r: type: string description: Transaction signature r component s: type: string description: Transaction signature s component example: jsonrpc: '2.0' id: 1 result: blockHash: '0x1d59ff54b1eb26b013ce3cb5fc9dab3705b415a67127a003c3e61eb445bb8df2' blockNumber: '0x5daf3b' from: '0x69835d480110e4919b7899f465aab101e21c8a87' gas: '0x5208' gasPrice: '0x9184e72a000' hash: '0x88df016429689c079f3b2f6ad39fa052532c56795b733da78a91ebe6a713944b' input: 0x nonce: '0x0' to: '0xb4dcfe4590adbd275ac3ef1a3dd10e819d11648c' transactionIndex: '0x41' value: '0xde0b6b3a7640000' type: '0x0' v: '0x25' r: '0xc9e1f8a5b3e0d2f7a4b5c3d8e9f6a2b1c4d7e8f9' s: '0xa2b1c4d7e8f9c9e1f8a5b3e0d2f7a4b5c3d8e9f6' tags: - General operationId: evm_eth_get_transaction_by_sender_and_nonce /evm_eth_get_transaction_count: post: summary: eth_getTransactionCount description: Returns the number of transactions sent from an address (the nonce). requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getTransactionCount default: eth_getTransactionCount description: The RPC method name params: type: array description: 'Parameters: [address, block]' default: - '0xFC1286EeddF81d6955eDAd5C8D99B8Aa32F3D2AA' - latest id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getTransactionCount params: - '0xFC1286EeddF81d6955eDAd5C8D99B8Aa32F3D2AA' - latest id: 1 responses: '200': description: Successful response with the transaction count content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: The transaction count (nonce) as a hexadecimal string example: jsonrpc: '2.0' id: 1 result: '0x1a' tags: - General operationId: evm_eth_get_transaction_count /evm_eth_get_transaction_receipt: post: summary: eth_getTransactionReceipt description: Returns the receipt of a transaction by its hash, containing execution results and event logs. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getTransactionReceipt default: eth_getTransactionReceipt description: The RPC method name params: type: array description: 'Parameters: [transactionHash]' default: - '0x33c3321b162edac1fdbb53af2962b2940c07e334a4f5ff758f1d5ef1235e55d0' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getTransactionReceipt params: - '0x33c3321b162edac1fdbb53af2962b2940c07e334a4f5ff758f1d5ef1235e55d0' id: 1 responses: '200': description: Successful response with transaction receipt content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object properties: transactionHash: type: string description: Hash of the transaction transactionIndex: type: string description: Index of the transaction in the block blockHash: type: string description: Hash of the block containing the transaction blockNumber: type: string description: Number of the block containing the transaction from: type: string description: Address of the sender to: type: string description: Address of the receiver gasUsed: type: string description: Amount of gas used by the transaction cumulativeGasUsed: type: string description: Total gas used in the block up to this transaction contractAddress: type: string description: Contract address created, if the transaction was a contract creation logs: type: array description: Array of log objects generated by the transaction items: type: object properties: address: type: string description: Contract address that emitted the log topics: type: array items: type: string description: Array of indexed event parameters data: type: string description: Non-indexed event parameters status: type: string description: Transaction status (0x0 for failure, 0x1 for success) effectiveGasPrice: type: string description: Actual gas price paid by the transaction type: type: string description: Transaction type example: jsonrpc: '2.0' id: 1 result: transactionHash: '0x33c3321b162edac1fdbb53af2962b2940c07e334a4f5ff758f1d5ef1235e55d0' transactionIndex: '0x0' blockHash: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890' blockNumber: '0x9d0c37' from: '0xFC1286EeddF81d6955eDAd5C8D99B8Aa32F3D2AA' to: '0x5555555555555555555555555555555555555555' gasUsed: '0x5208' cumulativeGasUsed: '0x5208' contractAddress: null logs: [] status: '0x1' effectiveGasPrice: '0x3b9aca00' type: '0x0' tags: - General operationId: evm_eth_get_transaction_receipt /evm_eth_get_uncle_by_block_hash_and_index: post: summary: eth_getUncleByBlockHashAndIndex description: Returns information about an uncle block by the block hash and uncle index position. Uncle blocks are valid blocks that were not included in the main chain but are referenced by the main chain blocks. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getUncleByBlockHashAndIndex default: eth_getUncleByBlockHashAndIndex description: The RPC method name params: type: array description: 'Parameters: [block_hash, uncle_index]' default: - '0x2ce91ae0ed242b4b78b432a45b982fb81a414d6b04167762ed3c7446710a4b8e' - '0x0' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getUncleByBlockHashAndIndex params: - '0x2ce91ae0ed242b4b78b432a45b982fb81a414d6b04167762ed3c7446710a4b8e' - '0x0' id: 1 responses: '200': description: Successful response with uncle block information content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object description: Uncle block information or null if not found nullable: true example: jsonrpc: '2.0' id: 1 result: null tags: - General operationId: evm_eth_get_uncle_by_block_hash_and_index /evm_eth_get_uncle_by_block_number_and_index: post: summary: eth_getUncleByBlockNumberAndIndex description: Returns information about an uncle block by the block number and uncle index position. Uncle blocks are valid blocks that were not included in the main chain but are referenced by the main chain blocks. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getUncleByBlockNumberAndIndex default: eth_getUncleByBlockNumberAndIndex description: The RPC method name params: type: array description: 'Parameters: [block_number, uncle_index]' default: - latest - '0x0' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getUncleByBlockNumberAndIndex params: - latest - '0x0' id: 1 responses: '200': description: Successful response with uncle block information content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object description: Uncle block information or null if not found nullable: true example: jsonrpc: '2.0' id: 1 result: null tags: - General operationId: evm_eth_get_uncle_by_block_number_and_index /evm_eth_get_uncle_count_by_block_hash: post: summary: eth_getUncleCountByBlockHash description: Returns the number of uncle blocks for a given block hash. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getUncleCountByBlockHash default: eth_getUncleCountByBlockHash description: The RPC method name params: type: array description: 'Parameters: [blockHash]' default: - '0x2ce91ae0ed242b4b78b432a45b982fb81a414d6b04167762ed3c7446710a4b8e' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getUncleCountByBlockHash params: - '0x2ce91ae0ed242b4b78b432a45b982fb81a414d6b04167762ed3c7446710a4b8e' id: 1 responses: '200': description: Successful response with uncle count content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: Number of uncle blocks as hex-encoded integer, or null if block not found example: jsonrpc: '2.0' id: 1 result: '0x0' tags: - General operationId: evm_eth_get_uncle_count_by_block_hash /evm_eth_get_uncle_count_by_block_number: post: summary: eth_getUncleCountByBlockNumber description: Returns the number of uncle blocks for a given block number. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_getUncleCountByBlockNumber default: eth_getUncleCountByBlockNumber description: The RPC method name params: type: array description: 'Parameters: [blockNumber]' default: - latest id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_getUncleCountByBlockNumber params: - latest id: 1 responses: '200': description: Successful response with uncle count content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: Number of uncle blocks as hex-encoded integer, or null if block not found example: jsonrpc: '2.0' id: 1 result: '0x0' tags: - General operationId: evm_eth_get_uncle_count_by_block_number /evm_eth_max_priority_fee_per_gas: post: summary: eth_maxPriorityFeePerGas description: Returns the current maximum priority fee per gas for EIP-1559 transactions. On Hyperliquid, this always returns zero. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_maxPriorityFeePerGas default: eth_maxPriorityFeePerGas description: The RPC method name params: type: array description: No parameters required default: [] id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_maxPriorityFeePerGas params: [] id: 1 responses: '200': description: Successful response with the maximum priority fee per gas content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: The maximum priority fee per gas in wei as a hexadecimal string example: jsonrpc: '2.0' id: 1 result: '0x0' tags: - General operationId: evm_eth_max_priority_fee_per_gas /evm_eth_new_block_filter: post: summary: eth_newBlockFilter description: Creates a filter object to notify when new blocks arrive. Returns a filter ID that can be used with eth_getFilterChanges to retrieve new block hashes. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_newBlockFilter default: eth_newBlockFilter description: The RPC method name params: type: array default: [] description: Parameters (empty array for eth_newBlockFilter) id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_newBlockFilter params: [] id: 1 responses: '200': description: Successful response with filter ID content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: The filter ID as a hexadecimal string example: jsonrpc: '2.0' id: 1 result: '0x1' tags: - General operationId: evm_eth_new_block_filter /evm_eth_new_filter: post: summary: eth_newFilter description: Creates a filter object to notify when logs match the specified criteria. Returns a filter ID that can be used to retrieve matching logs and changes. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_newFilter default: eth_newFilter description: The RPC method name params: type: array description: 'Parameters: [filter_object]' default: - fromBlock: latest toBlock: latest address: '0xB7C609cFfa0e47DB2467ea03fF3e598bf59361A5' topics: [] id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_newFilter params: - fromBlock: latest toBlock: latest address: '0xB7C609cFfa0e47DB2467ea03fF3e598bf59361A5' topics: [] id: 1 responses: '200': description: Successful response with filter ID content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: The filter ID as a hexadecimal string example: jsonrpc: '2.0' id: 1 result: '0x1' tags: - General operationId: evm_eth_new_filter /evm_eth_protocol_version: post: summary: eth_protocolVersion description: Returns the current Ethereum protocol version supported by the node. This method helps verify protocol compatibility between client applications and the blockchain network. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_protocolVersion default: eth_protocolVersion description: The RPC method name params: type: array default: [] description: Parameters for the method (empty array for eth_protocolVersion) id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_protocolVersion params: [] id: 1 responses: '200': description: Successful response with the current protocol version content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: The current protocol version as a hexadecimal string example: jsonrpc: '2.0' id: 1 result: '0x41' tags: - General operationId: evm_eth_protocol_version /evm_eth_send_raw_transaction: post: summary: eth_sendRawTransaction description: Submits a pre-signed transaction to the network for broadcasting and inclusion in a block. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_sendRawTransaction default: eth_sendRawTransaction description: The RPC method name params: type: array description: 'Parameters: [signedTransactionData]' default: - f86d80843b9aca0082520894b7c609cffa0e47db2467ea03ff3e598bf59361a5880de0b6b3a7640000808207f2a02d013b9980176ca8674f77797ac04e928b8de3be92dd452501ec26acbb2b1abca054041f43109eeadbb4d6b712a20dc71e5dbe1225e549644be3de803b55041a89 id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_sendRawTransaction params: - f86d80843b9aca0082520894b7c609cffa0e47db2467ea03ff3e598bf59361a5880de0b6b3a7640000808207f2a02d013b9980176ca8674f77797ac04e928b8de3be92dd452501ec26acbb2b1abca054041f43109eeadbb4d6b712a20dc71e5dbe1225e549644be3de803b55041a89 id: 1 responses: '200': description: Successful response content: application/json: schema: type: object properties: jsonrpc: type: string example: '2.0' id: type: integer example: 1 result: type: string description: The transaction hash example: '0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331' '400': description: Bad request content: application/json: schema: type: object properties: jsonrpc: type: string example: '2.0' id: type: integer example: 1 error: type: object properties: code: type: integer example: -32000 message: type: string example: nonce too low tags: - General operationId: evm_eth_send_raw_transaction /evm_eth_simulate_v1: post: summary: eth_simulateV1 description: Simulates transactions without actually executing them on the blockchain. This method allows for testing transaction outcomes, estimating gas usage, and validating transaction logic before submission. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_simulateV1 default: eth_simulateV1 description: The RPC method name params: type: array minItems: 1 maxItems: 1 items: type: object required: - blockStateCalls properties: blockStateCalls: type: array items: type: object required: - calls properties: calls: type: array items: type: object properties: from: type: string description: Transaction sender address to: type: string description: Transaction recipient address gas: type: string description: Gas limit as hexadecimal string gasPrice: type: string description: Gas price as hexadecimal string value: type: string description: Transaction value as hexadecimal string data: type: string description: Transaction data as hexadecimal string blockOverride: type: object properties: number: type: string description: Block number to simulate against traceTransfers: type: boolean description: Whether to trace token transfers during simulation validation: type: boolean description: Whether to perform validation during simulation default: - blockStateCalls: - calls: - from: '0x69835D480110e4919B7899f465aAB101e21c8A87' to: '0xb4DcFE4590adBd275aC3Ef1A3dd10e819d11648c' gas: '0x5208' gasPrice: '0x9184e72a000' value: '0xde0b6b3a7640000' data: 0x blockOverride: number: latest traceTransfers: false validation: true description: Simulation parameters id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_simulateV1 params: - blockStateCalls: - calls: - from: '0x69835D480110e4919B7899f465aAB101e21c8A87' to: '0xb4DcFE4590adBd275aC3Ef1A3dd10e819d11648c' gas: '0x5208' gasPrice: '0x9184e72a000' value: '0xde0b6b3a7640000' data: 0x blockOverride: number: latest traceTransfers: false validation: true id: 1 responses: '200': description: Successful response with simulation results content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object description: Simulation results including gas estimates and transaction outcomes example: jsonrpc: '2.0' id: 1 result: {} tags: - General operationId: evm_eth_simulate_v1 /evm_eth_syncing: post: summary: Eth_Syncing description: Returns the synchronization status of the node. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_syncing default: eth_syncing description: The RPC method name params: type: array description: No parameters required default: [] id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_syncing params: [] id: 1 responses: '200': description: Successful response with synchronization status content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: oneOf: - type: boolean description: false if the node is fully synchronized - type: object properties: startingBlock: type: string description: Block number where sync started currentBlock: type: string description: Current block number being processed highestBlock: type: string description: Highest known block number description: Sync status object if the node is synchronizing examples: synchronized: summary: Node is fully synchronized value: jsonrpc: '2.0' id: 1 result: false syncing: summary: Node is synchronizing value: jsonrpc: '2.0' id: 1 result: startingBlock: '0x0' currentBlock: '0x9d0c37' highestBlock: '0x9d0c50' tags: - General operationId: evm_eth_syncing /evm_eth_uninstall_filter: post: summary: eth_uninstallFilter description: Uninstalls a filter with the given ID. Should be called when polling is no longer needed to free up server resources. Filters may also be automatically uninstalled if they are not polled for a period of time. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_uninstallFilter default: eth_uninstallFilter description: The RPC method name params: type: array description: 'Parameters: [filter_id]' default: - '0x1' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_uninstallFilter params: - '0x1' id: 1 responses: '200': description: Successful response indicating whether the filter was uninstalled content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: boolean description: True if the filter was successfully uninstalled, false if the filter was not found example: jsonrpc: '2.0' id: 1 result: true tags: - General operationId: evm_eth_uninstall_filter /evm_eth_using_big_blocks: post: summary: eth_usingBigBlocks description: Returns whether an address is using big blocks on Hyperliquid EVM. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - eth_usingBigBlocks default: eth_usingBigBlocks description: The RPC method name params: type: array description: 'Parameters: [address]' default: - '0xFC1286EeddF81d6955eDAd5C8D99B8Aa32F3D2AA' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: eth_usingBigBlocks params: - '0xFC1286EeddF81d6955eDAd5C8D99B8Aa32F3D2AA' id: 1 responses: '200': description: Successful response with big blocks usage status content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: boolean description: Whether the address is using big blocks example: jsonrpc: '2.0' id: 1 result: true tags: - General operationId: evm_eth_using_big_blocks /evm_net_listening: post: summary: Net_Listening description: Returns true if the client is actively listening for network connections. This method checks if the node is accepting incoming connections from peers on the network. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - net_listening default: net_listening description: The RPC method name params: type: array default: [] description: Parameters for the method (empty array for net_listening) id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: net_listening params: [] id: 1 responses: '200': description: Successful response with the listening status content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: boolean description: True if the client is listening for network connections example: jsonrpc: '2.0' id: 1 result: true tags: - General operationId: evm_net_listening /evm_net_peer_count: post: summary: net_peerCount description: Returns the number of peers currently connected to the client. This method provides information about the node's network connectivity and can be used to monitor network health and connectivity status. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - net_peerCount default: net_peerCount description: The RPC method name params: type: array default: [] description: Parameters (empty array for net_peerCount) id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: net_peerCount params: [] id: 1 responses: '200': description: Successful response with peer count content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: The number of connected peers as a hexadecimal string example: jsonrpc: '2.0' id: 1 result: '0x2a' tags: - General operationId: evm_net_peer_count /evm_net_version: post: summary: Net_Version description: Returns the current network ID. This method is used to identify which Ethereum network the client is connected to. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - net_version default: net_version description: The RPC method name params: type: array default: [] description: Parameters for the method (empty array for net_version) id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: net_version params: [] id: 1 responses: '200': description: Successful response with network ID content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: The current network ID as a string example: jsonrpc: '2.0' id: 1 result: '999' tags: - General operationId: evm_net_version /evm_ots_get_api_level: post: summary: ots_getApiLevel description: Get the Otterscan API version level on Hyperliquid EVM. Check node compatibility with Otterscan block explorer features. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - ots_getApiLevel default: ots_getApiLevel description: The RPC method name params: type: array description: No parameters required default: [] id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: ots_getApiLevel params: [] id: 1 responses: '200': description: Successful response with API level content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: integer description: API level number example: jsonrpc: '2.0' id: 1 result: 8 tags: - General operationId: evm_ots_get_api_level /evm_ots_get_block_details: post: summary: ots_getBlockDetails description: Get detailed block information by block number on Hyperliquid EVM. Includes transaction summaries and block metadata. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - ots_getBlockDetails default: ots_getBlockDetails description: The RPC method name params: type: array description: 'Parameters: [block number]' default: - 1000 id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: ots_getBlockDetails params: - 1000 id: 1 responses: '200': description: Successful response with detailed block information content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object description: Detailed block information example: jsonrpc: '2.0' id: 1 result: block: number: '0x3e8' hash: '0xe8399bf41516f5ca663c79bc30db02b4989385c2f3a96f42958dea5753cbf4a9' transactions: [] tags: - General operationId: evm_ots_get_block_details /evm_ots_get_block_details_by_hash: post: summary: ots_getBlockDetailsByHash description: Get detailed block information by block hash on Hyperliquid EVM. Includes transaction summaries and block metadata. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - ots_getBlockDetailsByHash default: ots_getBlockDetailsByHash description: The RPC method name params: type: array description: 'Parameters: [block hash]' default: - '0xe8399bf41516f5ca663c79bc30db02b4989385c2f3a96f42958dea5753cbf4a9' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: ots_getBlockDetailsByHash params: - '0xe8399bf41516f5ca663c79bc30db02b4989385c2f3a96f42958dea5753cbf4a9' id: 1 responses: '200': description: Successful response with detailed block information content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object description: Detailed block information example: jsonrpc: '2.0' id: 1 result: block: number: '0x3e8' hash: '0xe8399bf41516f5ca663c79bc30db02b4989385c2f3a96f42958dea5753cbf4a9' transactions: [] tags: - General operationId: evm_ots_get_block_details_by_hash /evm_ots_get_block_transactions: post: summary: ots_getBlockTransactions description: Get paginated list of transactions in a block on Hyperliquid EVM. Supports pagination for large blocks. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - ots_getBlockTransactions default: ots_getBlockTransactions description: The RPC method name params: type: array description: 'Parameters: [block number, page, page size]' default: - 1000 - 0 - 10 id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: ots_getBlockTransactions params: - 1000 - 0 - 10 id: 1 responses: '200': description: Successful response with paginated transaction list content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object description: Paginated transaction data example: jsonrpc: '2.0' id: 1 result: txs: [] receipts: [] firstPage: true lastPage: true tags: - General operationId: evm_ots_get_block_transactions /evm_ots_get_contract_creator: post: summary: ots_getContractCreator description: Get the creator address and transaction hash for a contract on Hyperliquid EVM. Identifies who deployed a smart contract. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - ots_getContractCreator default: ots_getContractCreator description: The RPC method name params: type: array description: 'Parameters: [contract address]' default: - '0x5555555555555555555555555555555555555555' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: ots_getContractCreator params: - '0x5555555555555555555555555555555555555555' id: 1 responses: '200': description: Successful response with contract creator information content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object description: Creator information or null if not a contract example: jsonrpc: '2.0' id: 1 result: creator: '0x6666666666666666666666666666666666666666' hash: '0xf94f3d2ed5b59aefb6a0e566af8e86552014d84f6ed2f38a1366dedffe723381' tags: - General operationId: evm_ots_get_contract_creator /evm_ots_get_header_by_number: post: summary: ots_getHeaderByNumber description: Retrieve block header information by block number on Hyperliquid EVM. Provides lightweight block data access for block explorers. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - ots_getHeaderByNumber default: ots_getHeaderByNumber description: The RPC method name params: type: array description: 'Parameters: [block number]' default: - 1000 id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: ots_getHeaderByNumber params: - 1000 id: 1 responses: '200': description: Successful response with block header data content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object description: Block header object example: jsonrpc: '2.0' id: 1 result: number: '0x3e8' hash: '0xe8399bf41516f5ca663c79bc30db02b4989385c2f3a96f42958dea5753cbf4a9' parentHash: '0x7c8f6a0e4d3b2a1c9e5f8b7d4a6c3e9f2b8d5a7c1e4f9b3a6d8c2e5f7a9b4c6d' timestamp: '0x6734e8d0' tags: - General operationId: evm_ots_get_header_by_number /evm_ots_get_internal_operations: post: summary: ots_getInternalOperations description: Get internal ETH transfers and operations within a transaction on Hyperliquid EVM. Track value movements through contract interactions. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - ots_getInternalOperations default: ots_getInternalOperations description: The RPC method name params: type: array description: 'Parameters: [transaction hash]' default: - '0xf94f3d2ed5b59aefb6a0e566af8e86552014d84f6ed2f38a1366dedffe723381' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: ots_getInternalOperations params: - '0xf94f3d2ed5b59aefb6a0e566af8e86552014d84f6ed2f38a1366dedffe723381' id: 1 responses: '200': description: Successful response with internal operations content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: array description: Array of internal operations example: jsonrpc: '2.0' id: 1 result: - type: 0 from: '0x5555555555555555555555555555555555555555' to: '0x6666666666666666666666666666666666666666' value: '0xde0b6b3a7640000' tags: - General operationId: evm_ots_get_internal_operations /evm_ots_get_transaction_by_sender_and_nonce: post: summary: ots_getTransactionBySenderAndNonce description: Find a transaction by sender address and nonce on Hyperliquid EVM. Useful for tracking specific account transactions. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - ots_getTransactionBySenderAndNonce default: ots_getTransactionBySenderAndNonce description: The RPC method name params: type: array description: 'Parameters: [sender address, nonce]' default: - '0x5555555555555555555555555555555555555555' - 0 id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: ots_getTransactionBySenderAndNonce params: - '0x5555555555555555555555555555555555555555' - 0 id: 1 responses: '200': description: Successful response with transaction data content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object description: Transaction object or null if not found example: jsonrpc: '2.0' id: 1 result: hash: '0xf94f3d2ed5b59aefb6a0e566af8e86552014d84f6ed2f38a1366dedffe723381' nonce: '0x0' from: '0x5555555555555555555555555555555555555555' tags: - General operationId: evm_ots_get_transaction_by_sender_and_nonce /evm_ots_get_transaction_error: post: summary: ots_getTransactionError description: Retrieve detailed error information for a failed transaction on Hyperliquid EVM. Get specific revert reasons and execution failures. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - ots_getTransactionError default: ots_getTransactionError description: The RPC method name params: type: array description: 'Parameters: [transaction hash]' default: - '0xf94f3d2ed5b59aefb6a0e566af8e86552014d84f6ed2f38a1366dedffe723381' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: ots_getTransactionError params: - '0xf94f3d2ed5b59aefb6a0e566af8e86552014d84f6ed2f38a1366dedffe723381' id: 1 responses: '200': description: Successful response with transaction error details content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: Error message or null if no error example: jsonrpc: '2.0' id: 1 result: 'execution reverted: insufficient balance' tags: - General operationId: evm_ots_get_transaction_error /evm_ots_has_code: post: summary: ots_hasCode description: Check if an address contains deployed contract code on Hyperliquid EVM. Efficiently determine if an address is a smart contract. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - ots_hasCode default: ots_hasCode description: The RPC method name params: type: array description: 'Parameters: [address, block identifier (optional)]' default: - '0x5555555555555555555555555555555555555555' - latest id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: ots_hasCode params: - '0x5555555555555555555555555555555555555555' - latest id: 1 responses: '200': description: Successful response indicating if address has code content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: boolean description: True if address has code, false otherwise example: jsonrpc: '2.0' id: 1 result: true tags: - General operationId: evm_ots_has_code /evm_ots_trace_transaction: post: summary: ots_traceTransaction description: Get a detailed execution trace of a transaction on Hyperliquid EVM. Provides comprehensive call stack and state changes. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - ots_traceTransaction default: ots_traceTransaction description: The RPC method name params: type: array description: 'Parameters: [transaction hash]' default: - '0xf94f3d2ed5b59aefb6a0e566af8e86552014d84f6ed2f38a1366dedffe723381' id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: ots_traceTransaction params: - '0xf94f3d2ed5b59aefb6a0e566af8e86552014d84f6ed2f38a1366dedffe723381' id: 1 responses: '200': description: Successful response with transaction trace content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object description: Transaction trace data example: jsonrpc: '2.0' id: 1 result: txHash: '0xf94f3d2ed5b59aefb6a0e566af8e86552014d84f6ed2f38a1366dedffe723381' calls: [] tags: - General operationId: evm_ots_trace_transaction /evm_trace_block: post: summary: Trace_Block description: Returns trace information for all transactions in a specific block. This method provides execution traces for all transactions within a block using OpenEthereum-style tracing. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - trace_block default: trace_block description: The RPC method name params: type: array description: 'Parameters: [block identifier]' default: - latest id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: trace_block params: - latest id: 1 responses: '200': description: Successful response with trace data for all transactions in the block content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: array description: Array of trace objects for all transactions in the block example: jsonrpc: '2.0' id: 1 result: - action: from: 0x... to: 0x... value: '0x0' gas: 0x... input: 0x... callType: call result: gasUsed: '0x5208' output: 0x traceAddress: [] type: call tags: - General operationId: evm_trace_block /evm_trace_call: post: summary: Trace_Call description: Executes a call and returns trace information using OpenEthereum-style tracing. This method simulates a transaction and provides detailed execution traces without committing changes to the blockchain. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - trace_call default: trace_call description: The RPC method name params: type: array description: 'Parameters: [call object, trace types array, block parameter]' default: - from: '0x69835D480110e4919B7899f465aAB101e21c8A87' to: '0xB7C609cFfa0e47DB2467ea03fF3e598bf59361A5' gas: '0x76c0' gasPrice: '0x9184e72a000' value: '0xde0b6b3a7640000' data: 0x - - trace - latest id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: trace_call params: - from: '0x69835D480110e4919B7899f465aAB101e21c8A87' to: '0xB7C609cFfa0e47DB2467ea03fF3e598bf59361A5' gas: '0x76c0' gasPrice: '0x9184e72a000' value: '0xde0b6b3a7640000' data: 0x - - trace - latest id: 1 responses: '200': description: Successful response with trace data content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: array description: Array of trace objects containing execution information example: jsonrpc: '2.0' id: 1 result: - action: from: '0x69835D480110e4919B7899f465aAB101e21c8A87' to: '0xB7C609cFfa0e47DB2467ea03fF3e598bf59361A5' value: '0xde0b6b3a7640000' gas: '0x76c0' input: 0x callType: call result: gasUsed: '0x5208' output: 0x traceAddress: [] type: call tags: - General operationId: evm_trace_call /evm_trace_call_many: post: summary: trace_callMany description: Executes multiple calls and returns trace information for each call. This method allows batch simulation of multiple transactions with detailed execution traces. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - trace_callMany default: trace_callMany description: The RPC method name params: type: array description: 'Parameters: [array of call/trace pairs, block parameter]' default: - - - from: '0x69835D480110e4919B7899f465aAB101e21c8A87' to: '0xB7C609cFfa0e47DB2467ea03fF3e598bf59361A5' gas: '0x76c0' gasPrice: '0x9184e72a000' value: '0xde0b6b3a7640000' data: 0x - - trace - - from: '0x69835D480110e4919B7899f465aAB101e21c8A87' to: '0xb4DcFE4590adBd275aC3Ef1A3dd10e819d11648c' gas: '0x5208' gasPrice: '0x9184e72a000' value: '0x1bc16d674ec80000' data: 0x - - trace - latest id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: trace_callMany params: - - - from: '0x69835D480110e4919B7899f465aAB101e21c8A87' to: '0xB7C609cFfa0e47DB2467ea03fF3e598bf59361A5' gas: '0x76c0' gasPrice: '0x9184e72a000' value: '0xde0b6b3a7640000' data: 0x - - trace - - from: '0x69835D480110e4919B7899f465aAB101e21c8A87' to: '0xb4DcFE4590adBd275aC3Ef1A3dd10e819d11648c' gas: '0x5208' gasPrice: '0x9184e72a000' value: '0x1bc16d674ec80000' data: 0x - - trace - latest id: 1 responses: '200': description: Successful response with trace data for all calls content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: array description: Array of trace results for each call example: jsonrpc: '2.0' id: 1 result: - - action: from: '0x69835D480110e4919B7899f465aAB101e21c8A87' to: '0xB7C609cFfa0e47DB2467ea03fF3e598bf59361A5' value: '0xde0b6b3a7640000' gas: '0x76c0' input: 0x callType: call result: gasUsed: '0x5208' output: 0x traceAddress: [] type: call tags: - General operationId: evm_trace_call_many /evm_trace_filter: post: summary: Trace_Filter description: Returns traces matching the specified filter criteria. This method allows filtering traces by block range, addresses, and other criteria to find specific transaction patterns. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - trace_filter default: trace_filter description: The RPC method name params: type: array description: 'Parameters: [filter object with search criteria]' default: - fromBlock: '0xb92f20' toBlock: '0xb92f6d' toAddress: - '0x5555555555555555555555555555555555555555' count: 5 id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: trace_filter params: - fromBlock: '0xb92f20' toBlock: '0xb92f6d' toAddress: - '0x5555555555555555555555555555555555555555' count: 5 id: 1 responses: '200': description: Successful response with filtered trace data content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: array description: Array of trace objects matching the filter criteria example: jsonrpc: '2.0' id: 1 result: - action: from: '0x69835D480110e4919B7899f465aAB101e21c8A87' to: '0xB7C609cFfa0e47DB2467ea03fF3e598bf59361A5' value: '0x0' gas: 0x... input: 0x... callType: call result: gasUsed: '0x5208' output: 0x traceAddress: [] type: call blockNumber: 12345 transactionHash: 0x... tags: - General operationId: evm_trace_filter /evm_trace_raw_transaction: post: summary: trace_rawTransaction description: Executes a raw transaction and returns trace information. This method simulates the execution of a raw transaction and provides detailed execution traces. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - trace_rawTransaction default: trace_rawTransaction description: The RPC method name params: type: array description: 'Parameters: [raw transaction data, trace types array]' default: - '0xf86d80843b9aca0082520894b7c609cffa0e47db2467ea03ff3e598bf59361a5880de0b6b3a7640000808207f2a02d013b9980176ca8674f77797ac04e928b8de3be92dd452501ec26acbb2b1abca054041f43109eeadbb4d6b712a20dc71e5dbe1225e549644be3de803b55041a89' - - trace id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: trace_rawTransaction params: - '0xf86d80843b9aca0082520894b7c609cffa0e47db2467ea03ff3e598bf59361a5880de0b6b3a7640000808207f2a02d013b9980176ca8674f77797ac04e928b8de3be92dd452501ec26acbb2b1abca054041f43109eeadbb4d6b712a20dc71e5dbe1225e549644be3de803b55041a89' - - trace id: 1 responses: '200': description: Successful response with trace data content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: array description: Array of trace objects containing execution information example: jsonrpc: '2.0' id: 1 result: - action: from: 0x... to: 0x... value: 0x... gas: 0x... input: 0x callType: call result: gasUsed: '0x5208' output: 0x traceAddress: [] type: call tags: - General operationId: evm_trace_raw_transaction /evm_trace_replay_block_transactions: post: summary: trace_replayBlockTransactions description: Replays all transactions in a block and returns trace information for each transaction. This method provides detailed execution traces for all transactions in a specific block. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - trace_replayBlockTransactions default: trace_replayBlockTransactions description: The RPC method name params: type: array description: 'Parameters: [block identifier, trace types array]' default: - latest - - trace id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: trace_replayBlockTransactions params: - latest - - trace id: 1 responses: '200': description: Successful response with trace data for all transactions content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: array description: Array of trace results for each transaction in the block example: jsonrpc: '2.0' id: 1 result: - trace: - action: from: 0x... to: 0x... value: '0x0' gas: 0x... input: 0x... callType: call result: gasUsed: '0x5208' output: 0x traceAddress: [] type: call tags: - General operationId: evm_trace_replay_block_transactions /evm_trace_replay_transaction: post: summary: trace_replayTransaction description: Replays a specific transaction and returns trace information. This method provides detailed execution traces for a single transaction by replaying its execution. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - trace_replayTransaction default: trace_replayTransaction description: The RPC method name params: type: array description: 'Parameters: [transaction hash, trace types array]' default: - '0x07712544ce8f50091c6c3b227921f763b342bf9465a22f0226d651a3246adb31' - - trace id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: trace_replayTransaction params: - '0x07712544ce8f50091c6c3b227921f763b342bf9465a22f0226d651a3246adb31' - - trace id: 1 responses: '200': description: Successful response with trace data content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: object description: Trace data for the replayed transaction example: jsonrpc: '2.0' id: 1 result: trace: - action: from: 0x... to: 0x... value: '0x0' gas: 0x... input: 0x... callType: call result: gasUsed: '0x5208' output: 0x traceAddress: [] type: call tags: - General operationId: evm_trace_replay_transaction /evm_web3_client_version: post: summary: web3_clientVersion description: Returns the current client version. This method provides information about the Ethereum client implementation and version running on the Hyperliquid EVM. requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' description: JSON-RPC version method: type: string enum: - web3_clientVersion default: web3_clientVersion description: The RPC method name params: type: array default: [] description: Parameters for the method (empty array for web3_clientVersion) id: type: integer default: 1 description: Request identifier example: jsonrpc: '2.0' method: web3_clientVersion params: [] id: 1 responses: '200': description: Successful response with client version information content: application/json: schema: type: object properties: jsonrpc: type: string description: JSON-RPC version id: type: integer description: Request identifier result: type: string description: The client version string example: jsonrpc: '2.0' id: 1 result: HyperEVM/v1.0.0 tags: - General operationId: evm_web3_client_version /exchange_agent_enable_dex_abstraction: post: tags: - General summary: Agent enable DEX abstraction operationId: agentEnableDexAbstraction requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: agentEnableDexAbstraction enum: - agentEnableDexAbstraction description: Action type required: - type nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: agentEnableDexAbstraction nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_agent_set_abstraction: post: tags: - General summary: Agent set abstraction operationId: agentSetAbstraction requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: agentSetAbstraction enum: - agentSetAbstraction description: Action type abstraction: type: object description: Abstraction configuration object required: - type - abstraction nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: agentSetAbstraction abstraction: {} nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_approve_agent: post: tags: - General summary: Approve agent operationId: approveAgent requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: approveAgent enum: - approveAgent description: Action type hyperliquidChain: type: string description: Chain identifier default: Mainnet enum: - Mainnet - Testnet signatureChainId: type: string description: EIP-712 signature chain ID default: '0xa4b1' agentAddress: type: string description: Ethereum address of the agent to approve agentName: type: string nullable: true description: Optional display name for the agent nonce: type: integer description: Current timestamp in milliseconds required: - type - hyperliquidChain - signatureChainId - agentAddress - agentName - nonce nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: approveAgent hyperliquidChain: Mainnet signatureChainId: '0xa4b1' agentAddress: '0x1234567890abcdef1234567890abcdef12345678' agentName: null nonce: 1705234567890 nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_approve_builder_fee: post: tags: - General summary: Approve builder fee operationId: approveBuilderFee requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: approveBuilderFee enum: - approveBuilderFee description: Action type hyperliquidChain: type: string description: Chain identifier default: Mainnet enum: - Mainnet - Testnet signatureChainId: type: string description: EIP-712 signature chain ID default: '0xa4b1' maxFeeRate: type: string description: Maximum fee rate as a percentage string (e.g., "0.001%") builder: type: string description: Ethereum address of the builder nonce: type: integer description: Current timestamp in milliseconds required: - type - hyperliquidChain - signatureChainId - maxFeeRate - builder - nonce nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: approveBuilderFee hyperliquidChain: Mainnet signatureChainId: '0xa4b1' maxFeeRate: 0.001% builder: '0x1234567890abcdef1234567890abcdef12345678' nonce: 1705234567890 nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_batch_modify: post: tags: - General summary: Batch modify orders operationId: batchModifyOrders requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: batchModify enum: - batchModify description: Action type for batch modifying orders modifies: type: array description: Array of modify objects items: type: object properties: oid: type: integer description: Order ID to modify order: type: object description: New order parameters properties: a: type: integer description: Asset index (use universe index for perps, 10000 + index for spot) b: type: boolean description: Is buy order (true for buy/long, false for sell/short) p: type: string description: Limit price (use '0' for market orders) s: type: string description: Size in units of the base asset r: type: boolean description: Reduce only order t: type: object description: Order type specification oneOf: - type: object properties: limit: type: object properties: tif: type: string enum: - Alo - Ioc - Gtc description: 'Time in force: Alo (add liquidity only), Ioc (immediate or cancel), Gtc (good til canceled)' required: - tif - type: object properties: trigger: type: object properties: isMarket: type: boolean description: Whether to place market order when triggered triggerPx: type: string description: Price at which to trigger the order tpsl: type: string enum: - tp - sl description: Take profit (tp) or stop loss (sl) required: - isMarket - triggerPx - tpsl c: type: string description: Client order ID (128-bit hex string, optional) required: - a - b - p - s - r - t required: - oid - order required: - type - modifies nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true expiresAfter: type: integer description: Timestamp in milliseconds after which the request is rejected (optional) required: - action - nonce - signature example: action: type: batchModify modifies: - oid: 123456789 order: a: 0 b: true p: '27.5' s: '1.0' r: false t: limit: tif: Gtc c: '0x1234567890abcdef1234567890abcdef' - oid: 123456790 order: a: 0 b: false p: '28.0' s: '0.5' r: false t: limit: tif: Gtc nonce: 1705234567890 signature: r: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: 27 vaultAddress: null responses: '200': description: Batch modification result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object properties: type: type: string data: type: object properties: statuses: type: array items: oneOf: - type: object properties: resting: type: object properties: oid: type: integer description: Order ID - type: object properties: filled: type: object properties: totalSz: type: string description: Total size filled avgPx: type: string description: Average fill price oid: type: integer description: Order ID - type: object properties: error: type: string description: Error message example: status: ok response: type: batchModify data: statuses: - resting: oid: 77738310 - resting: oid: 77738311 /exchange_c_deposit: post: tags: - General summary: C deposit operationId: cDeposit requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: cDeposit enum: - cDeposit description: Action type hyperliquidChain: type: string description: Chain identifier default: Mainnet enum: - Mainnet - Testnet signatureChainId: type: string description: EIP-712 signature chain ID default: '0xa4b1' wei: type: integer description: Amount in wei to deposit for staking nonce: type: integer description: Current timestamp in milliseconds required: - type - hyperliquidChain - signatureChainId - wei - nonce nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: cDeposit hyperliquidChain: Mainnet signatureChainId: '0xa4b1' wei: 1000000000000000000 nonce: 1705234567890 nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_c_signer_action: post: tags: - General summary: C signer action operationId: cSignerAction requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: CSignerAction enum: - CSignerAction description: Action type unjailSelf: type: object nullable: true description: Set to null to unjail this signer node required: - type nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: CSignerAction unjailSelf: null nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_c_validator_action: post: tags: - General summary: C validator action operationId: cValidatorAction requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: CValidatorAction enum: - CValidatorAction description: Action type register: type: object description: 'Register a new validator (one of several possible sub-actions: register, changeProfile, unregister)' properties: profile: type: object properties: node_ip: type: object description: 'Node IP object, e.g., {"Ip": "1.2.3.4"}' name: type: string description: Validator display name description: type: string description: Validator description delegations_disabled: type: boolean description: Whether delegations are disabled commission_bps: type: integer description: Commission rate in basis points (e.g., 1000 = 10%) signer: type: string description: Signer Ethereum address unjailed: type: boolean description: Whether the validator starts unjailed initial_wei: type: integer description: Initial self-delegation in wei required: - type nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: CValidatorAction register: profile: node_ip: Ip: 1.2.3.4 name: My Validator description: A Hyperliquid validator node delegations_disabled: false commission_bps: 1000 signer: '0x1234567890abcdef1234567890abcdef12345678' unjailed: false initial_wei: 0 nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_c_withdraw: post: tags: - General summary: C withdraw operationId: cWithdraw requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: cWithdraw enum: - cWithdraw description: Action type hyperliquidChain: type: string description: Chain identifier default: Mainnet enum: - Mainnet - Testnet signatureChainId: type: string description: EIP-712 signature chain ID default: '0xa4b1' wei: type: integer description: Amount in wei to withdraw from staking nonce: type: integer description: Current timestamp in milliseconds required: - type - hyperliquidChain - signatureChainId - wei - nonce nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: cWithdraw hyperliquidChain: Mainnet signatureChainId: '0xa4b1' wei: 1000000000000000000 nonce: 1705234567890 nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_cancel_by_cloid: post: tags: - General summary: Cancel order by cloid operationId: cancelOrderByCloid requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: cancelByCloid enum: - cancelByCloid description: Action type for canceling orders by client order ID cancels: type: array description: Array of cancel objects items: type: object properties: asset: type: integer description: Asset index cloid: type: string description: Client order ID (128-bit hex string) required: - asset - cloid required: - type - cancels nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true expiresAfter: type: integer description: Timestamp in milliseconds after which the request is rejected (optional) required: - action - nonce - signature example: action: type: cancelByCloid cancels: - asset: 0 cloid: '0x1234567890abcdef1234567890abcdef' nonce: 1705234567890 signature: r: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: 27 vaultAddress: null responses: '200': description: Cancellation result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object properties: type: type: string data: type: object properties: statuses: type: array description: Array of status results /exchange_cancel_order: post: tags: - General summary: Cancel order operationId: cancelOrder requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: cancel enum: - cancel description: Action type for canceling orders cancels: type: array description: Array of cancel objects items: type: object properties: a: type: integer description: Asset index o: type: integer description: Order ID to cancel required: - a - o required: - type - cancels nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true expiresAfter: type: integer description: Timestamp in milliseconds after which the request is rejected (optional) required: - action - nonce - signature example: action: type: cancel cancels: - a: 0 o: 123456789 nonce: 1705234567890 signature: r: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: 27 vaultAddress: null responses: '200': description: Cancellation result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object properties: type: type: string data: type: object properties: statuses: type: array items: oneOf: - type: string enum: - success - type: object properties: error: type: string description: Error message example: status: ok response: type: cancel data: statuses: - success /exchange_convert_to_multi_sig_user: post: tags: - General summary: Convert to multi-sig operationId: convertToMultiSigUser requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: convertToMultiSigUser enum: - convertToMultiSigUser description: Action type hyperliquidChain: type: string description: Chain identifier default: Mainnet enum: - Mainnet - Testnet signatureChainId: type: string description: EIP-712 signature chain ID default: '0xa4b1' signers: type: string description: 'JSON string encoding {authorizedUsers: [{address: string}], threshold: number}' nonce: type: integer description: Current timestamp in milliseconds required: - type - hyperliquidChain - signatureChainId - signers - nonce nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: convertToMultiSigUser hyperliquidChain: Mainnet signatureChainId: '0xa4b1' signers: '{"authorizedUsers":[{"address":"0x1234567890abcdef1234567890abcdef12345678"},{"address":"0xabcdef1234567890abcdef1234567890abcdef12"}],"threshold":2}' nonce: 1705234567890 nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_create_sub_account: post: tags: - General summary: Create sub-account operationId: createSubAccount requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: createSubAccount enum: - createSubAccount description: Action type for create sub-account name: type: string description: Sub-account name example: trading-bot-1 required: - type nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: createSubAccount name: trading-bot-1 nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_evm_user_modify: post: tags: - General summary: EVM user modify operationId: evmUserModify requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: evmUserModify enum: - evmUserModify description: Action type usingBigBlocks: type: boolean description: Whether to enable big block mode for HyperEVM transactions required: - type - usingBigBlocks nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: evmUserModify usingBigBlocks: true nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_modify_order: post: tags: - General summary: Modify order operationId: modifyOrder requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: modify enum: - modify description: Action type for modifying orders oid: type: integer description: Order ID to modify order: type: object description: New order parameters properties: a: type: integer description: Asset index (use universe index for perps, 10000 + index for spot) b: type: boolean description: Is buy order (true for buy/long, false for sell/short) p: type: string description: Limit price (use '0' for market orders) s: type: string description: Size in units of the base asset r: type: boolean description: Reduce only order t: type: object description: Order type specification oneOf: - type: object properties: limit: type: object properties: tif: type: string enum: - Alo - Ioc - Gtc description: 'Time in force: Alo (add liquidity only), Ioc (immediate or cancel), Gtc (good til canceled)' required: - tif - type: object properties: trigger: type: object properties: isMarket: type: boolean description: Whether to place market order when triggered triggerPx: type: string description: Price at which to trigger the order tpsl: type: string enum: - tp - sl description: Take profit (tp) or stop loss (sl) required: - isMarket - triggerPx - tpsl c: type: string description: Client order ID (128-bit hex string, optional) required: - a - b - p - s - r - t required: - type - oid - order nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true expiresAfter: type: integer description: Timestamp in milliseconds after which the request is rejected (optional) required: - action - nonce - signature example: action: type: modify oid: 123456789 order: a: 0 b: true p: '27.5' s: '1.0' r: false t: limit: tif: Gtc c: '0x1234567890abcdef1234567890abcdef' nonce: 1705234567890 signature: r: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: 27 vaultAddress: null responses: '200': description: Order modification result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object properties: type: type: string data: type: object properties: statuses: type: array items: oneOf: - type: object properties: resting: type: object properties: oid: type: integer description: Order ID - type: object properties: filled: type: object properties: totalSz: type: string description: Total size filled avgPx: type: string description: Average fill price oid: type: integer description: Order ID - type: object properties: error: type: string description: Error message example: status: ok response: type: modify data: statuses: - resting: oid: 77738309 /exchange_multi_sig: post: tags: - General summary: Multi-sig action operationId: multiSig requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: multiSig enum: - multiSig description: Action type signatureChainId: type: string description: EIP-712 signature chain ID default: '0xa4b1' signatures: type: array description: Array of EIP-712 signatures from authorized signers items: type: object properties: r: type: string s: type: string v: type: integer payload: type: object description: Multi-sig payload containing the inner action properties: multiSigUser: type: string description: Address of the multi-sig user outerSigner: type: string description: Address of the signer submitting the transaction action: type: object description: The inner action to execute (e.g., order, cancel, etc.) required: - type - signatureChainId - signatures - payload nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: multiSig signatureChainId: '0xa4b1' signatures: - r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 payload: multiSigUser: '0x1234567890abcdef1234567890abcdef12345678' outerSigner: '0xabcdef1234567890abcdef1234567890abcdef12' action: type: noop nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_noop: post: tags: - General summary: No-op operationId: noop requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: noop enum: - noop description: Action type for no-op required: - type nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: noop nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_perp_deploy: post: tags: - General summary: Perp deploy operationId: perpDeploy requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: perpDeploy enum: - perpDeploy description: Action type. Contains exactly one sub-action field such as setOracle, registerAsset, setPerpAnnotation, etc. setOracle: type: object description: Set oracle prices for a HIP-3 DEX (one of several sub-actions) properties: dex: type: string description: DEX identifier (2-4 characters) oraclePxs: type: array description: Array of [coin, price] tuples items: type: array markPxs: type: array description: Array of mark price arrays items: type: array externalPerpPxs: type: array description: Array of [coin, price] tuples for external perps items: type: array required: - type nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: perpDeploy setOracle: dex: xyz oraclePxs: - - BTC - '50000.0' markPxs: - - - BTC - '50000.0' externalPerpPxs: [] nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_place_order: post: tags: - General summary: Place order operationId: placeOrder requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: order enum: - order description: Action type for placing orders orders: type: array description: Array of order objects to place items: type: object properties: a: type: integer description: Asset index (use universe index for perps, 10000 + index for spot) example: 0 b: type: boolean description: Is buy order (true for buy/long, false for sell/short) example: true p: type: string description: Limit price (use '0' for market orders) example: '50000.0' s: type: string description: Size in units of the base asset example: '0.01' r: type: boolean description: Reduce only order example: false t: type: object description: Order type specification oneOf: - type: object properties: limit: type: object properties: tif: type: string enum: - Alo - Ioc - Gtc description: 'Time in force: Alo (add liquidity only), Ioc (immediate or cancel), Gtc (good til canceled)' required: - tif - type: object properties: trigger: type: object properties: isMarket: type: boolean description: Whether to place market order when triggered triggerPx: type: string description: Price at which to trigger the order tpsl: type: string enum: - tp - sl description: Take profit (tp) or stop loss (sl) required: - isMarket - triggerPx - tpsl c: type: string description: Client order ID (128-bit hex string, optional) required: - a - b - p - s - r - t grouping: type: string enum: - na - normalTpsl - positionTpsl default: na description: Order grouping type builder: type: object description: Optional builder fee configuration properties: b: type: string description: Builder address to receive fees f: type: number description: Fee in tenths of a basis point required: - b - f required: - type - orders - grouping nonce: type: integer description: Current timestamp in milliseconds example: 1734567890123 signature: type: object description: EIP-712 signature of the action. REQUIRED for authentication. Must be properly signed. properties: r: type: string description: R component of signature example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: S component of signature example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' v: type: integer description: V component of signature example: 28 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) example: '0x0000000000000000000000000000000000000000' nullable: true expiresAfter: type: integer description: Timestamp in milliseconds after which the order is rejected (optional) required: - action - nonce - signature example: action: type: order orders: - a: 0 b: true p: '50000.0' s: '0.01' r: false t: limit: tif: Gtc grouping: na nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Order placement result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object properties: type: type: string data: type: object properties: statuses: type: array items: oneOf: - type: object properties: resting: type: object properties: oid: type: integer description: Order ID - type: object properties: filled: type: object properties: totalSz: type: string description: Total size filled avgPx: type: string description: Average fill price oid: type: integer description: Order ID - type: object properties: error: type: string description: Error message example: status: ok response: type: order data: statuses: - resting: oid: 77738308 /exchange_reserve_request_weight: post: tags: - General summary: Reserve request weight operationId: reserveRequestWeight requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: reserveRequestWeight enum: - reserveRequestWeight description: Action type for reserve request weight weight: type: integer description: Amount of rate limit weight to reserve example: 100 required: - type nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: reserveRequestWeight weight: 100 nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_schedule_cancel: post: tags: - General summary: Schedule cancel (dead man's switch) operationId: scheduleCancel requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: scheduleCancel enum: - scheduleCancel description: Action type for scheduling automatic cancellation time: type: integer description: Unix timestamp in milliseconds when to cancel all orders. Omit to remove existing scheduled cancel required: - type nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true expiresAfter: type: integer description: Timestamp in milliseconds after which the request is rejected (optional) required: - action - nonce - signature example: action: type: scheduleCancel time: 1705234867890 nonce: 1705234567890 signature: r: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: 27 vaultAddress: null responses: '200': description: Schedule cancel result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object properties: type: type: string default: scheduleCancel example: status: ok response: type: scheduleCancel /exchange_send_asset: post: tags: - General summary: Send asset operationId: sendAsset requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: sendAsset enum: - sendAsset description: Action type hyperliquidChain: type: string description: Chain identifier default: Mainnet enum: - Mainnet - Testnet signatureChainId: type: string description: EIP-712 signature chain ID default: '0xa4b1' destination: type: string description: Recipient Ethereum address sourceDex: type: string description: Source DEX name (e.g., "HL" for Hyperliquid native) destinationDex: type: string description: Destination DEX name token: type: string description: Token identifier (e.g., "PURR:0xb8b" for spot tokens with index) amount: type: string description: Amount to send as a decimal string fromSubAccount: type: string description: Source sub-account address or empty string for main account nonce: type: integer description: Current timestamp in milliseconds required: - type - hyperliquidChain - signatureChainId - destination - sourceDex - destinationDex - token - amount - fromSubAccount - nonce nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: sendAsset hyperliquidChain: Mainnet signatureChainId: '0xa4b1' destination: '0x1234567890abcdef1234567890abcdef12345678' sourceDex: HL destinationDex: HL token: PURR:0x1 amount: '100.0' fromSubAccount: '' nonce: 1705234567890 nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_send_to_evm_with_data: post: tags: - General summary: Send to EVM with data operationId: sendToEvmWithData requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: sendToEvmWithData enum: - sendToEvmWithData description: Action type hyperliquidChain: type: string description: Chain identifier default: Mainnet enum: - Mainnet - Testnet signatureChainId: type: string description: EIP-712 signature chain ID default: '0xa4b1' token: type: string description: Token with address (e.g., "USDC:0x6d1e7cde53ba9467b783cb7c530ce054") amount: type: string description: Amount to send as a decimal string sourceDex: type: string description: Source DEX name (e.g., "HL") destinationRecipient: type: string description: Recipient address on destination chain addressEncoding: type: string description: Address encoding format default: hex destinationChainId: type: integer description: Destination chain ID (e.g., 42161 for Arbitrum) gasLimit: type: integer description: Gas limit for the destination chain transaction data: type: string description: Hex-encoded calldata ("0x" for automatic forwarding) nonce: type: integer description: Current timestamp in milliseconds required: - type - hyperliquidChain - signatureChainId - token - amount - sourceDex - destinationRecipient - addressEncoding - destinationChainId - gasLimit - data - nonce nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: sendToEvmWithData hyperliquidChain: Mainnet signatureChainId: '0xa4b1' token: USDC:0x6d1e7cde53ba9467b783cb7c530ce054 amount: '1.0' sourceDex: HL destinationRecipient: '0x1234567890abcdef1234567890abcdef12345678' addressEncoding: hex destinationChainId: 42161 gasLimit: 800000 data: 0x nonce: 1705234567890 nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_set_referrer: post: tags: - General summary: Set referrer operationId: setReferrer requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: setReferrer enum: - setReferrer description: Action type for set referrer code: type: string description: Referral code example: MYREF required: - type nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: setReferrer code: MYREF nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_spot_deploy: post: tags: - General summary: Spot deploy operationId: spotDeploy requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: spotDeploy enum: - spotDeploy description: Action type. The action object must contain exactly one sub-action field. registerToken2: type: object description: Register a new HIP-1 token (one of several possible sub-actions) properties: spec: type: object properties: name: type: string description: Token ticker symbol szDecimals: type: integer description: Size decimal places weiDecimals: type: integer description: Wei decimal places maxGas: type: integer description: Maximum gas for deployment fullName: type: string description: Full display name of the token required: - type nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: spotDeploy registerToken2: spec: name: MYTOKEN szDecimals: 8 weiDecimals: 8 maxGas: 100000 fullName: My Custom Token nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_spot_perp_transfer: post: tags: - General summary: Transfer between spot and perp accounts operationId: transferSpotPerp requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: usdClassTransfer enum: - usdClassTransfer description: Action type for transferring between spot and perp hyperliquidChain: type: string description: Chain identifier default: Mainnet enum: - Mainnet - Testnet signatureChainId: type: string description: EIP-712 signature chain ID default: '0xa4b1' amount: type: string description: Amount to transfer as a decimal string toPerp: type: boolean description: true to transfer from spot to perp, false for perp to spot nonce: type: integer description: Current timestamp in milliseconds required: - type - hyperliquidChain - signatureChainId - amount - toPerp - nonce nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: usdClassTransfer hyperliquidChain: Mainnet signatureChainId: '0xa4b1' amount: '250.0' toPerp: true nonce: 1705234567890 nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Spot/Perp transfer result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object properties: type: type: string data: type: object properties: status: type: string description: Transfer status example: status: ok response: type: spotUser data: status: success /exchange_spot_send: post: tags: - General summary: Transfer spot token operationId: transferSpotToken requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: spotSend enum: - spotSend description: Action type hyperliquidChain: type: string description: Chain identifier default: Mainnet enum: - Mainnet - Testnet signatureChainId: type: string description: EIP-712 signature chain ID default: '0xa4b1' destination: type: string description: Recipient Ethereum address token: type: string description: Token identifier with index (e.g., "PURR:0x1") amount: type: string description: Amount to send as a decimal string time: type: integer description: Current timestamp in milliseconds required: - type - hyperliquidChain - signatureChainId - destination - token - amount - time nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: spotSend hyperliquidChain: Mainnet signatureChainId: '0xa4b1' destination: '0x1234567890abcdef1234567890abcdef12345678' token: PURR:0x1 amount: '100.0' time: 1705234567890 nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Spot token transfer result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object properties: type: type: string data: type: object properties: status: type: string description: Transfer status example: status: ok response: type: spotSend data: status: success /exchange_sub_account_spot_transfer: post: tags: - General summary: Sub-account spot transfer operationId: subAccountSpotTransfer requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: subAccountSpotTransfer enum: - subAccountSpotTransfer description: Action type for sub-account spot transfer subAccountUser: type: string description: Sub-account address example: 0x... isDeposit: type: boolean description: True to deposit into sub-account, false to withdraw example: true token: type: string description: Token to transfer example: PURR amount: type: string description: Amount to transfer example: '100.0' required: - type nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: subAccountSpotTransfer subAccountUser: '0x1234567890abcdef1234567890abcdef12345678' isDeposit: true token: PURR amount: '100.0' nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_sub_account_transfer: post: tags: - General summary: Sub-account transfer operationId: subAccountTransfer requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: subAccountTransfer enum: - subAccountTransfer description: Action type for sub-account transfer subAccountUser: type: string description: Sub-account address example: 0x... isDeposit: type: boolean description: True to deposit into sub-account, false to withdraw example: true usd: type: integer description: Amount in raw USD units (multiply dollars by 1e6) example: 1000000 required: - type nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: subAccountTransfer subAccountUser: '0x1234567890abcdef1234567890abcdef12345678' isDeposit: true usd: 1000000 nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_token_delegate: post: tags: - General summary: Token delegate operationId: tokenDelegate requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: tokenDelegate enum: - tokenDelegate description: Action type hyperliquidChain: type: string description: Chain identifier default: Mainnet enum: - Mainnet - Testnet signatureChainId: type: string description: EIP-712 signature chain ID default: '0xa4b1' validator: type: string description: Validator Ethereum address to delegate to or undelegate from wei: type: integer description: Amount in wei to delegate or undelegate isUndelegate: type: boolean description: true to undelegate, false to delegate nonce: type: integer description: Current timestamp in milliseconds required: - type - hyperliquidChain - signatureChainId - validator - wei - isUndelegate - nonce nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: tokenDelegate hyperliquidChain: Mainnet signatureChainId: '0xa4b1' validator: '0x1234567890abcdef1234567890abcdef12345678' wei: 1000000000000000000 isUndelegate: false nonce: 1705234567890 nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_twap_cancel: post: tags: - General summary: TWAP cancel operationId: twapCancel requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: twapCancel enum: - twapCancel description: Action type for twap cancel a: type: integer description: Asset index example: 0 t: type: integer description: TWAP order ID to cancel example: 12345 required: - type nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: twapCancel a: 0 t: 12345 nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_twap_order: post: tags: - General summary: TWAP order operationId: twapOrder requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: twapOrder enum: - twapOrder description: Action type twap: type: object description: TWAP order parameters properties: a: type: integer description: Asset index b: type: boolean description: true for buy, false for sell s: type: string description: Size as a decimal string r: type: boolean description: Whether to reduce only m: type: integer description: Duration in minutes (5-1440) t: type: boolean description: Whether to randomize sub-order timing required: - a - b - s - r - m - t required: - type - twap nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: twapOrder twap: a: 0 b: true s: '1.0' r: false m: 60 t: true nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_update_isolated_margin: post: tags: - General summary: Update isolated margin operationId: updateIsolatedMargin requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: updateIsolatedMargin enum: - updateIsolatedMargin description: Action type for updating isolated margin asset: type: integer description: Asset index to update isolated margin for isBuy: type: boolean description: true for long position (always true, reserved for future hedge mode) ntli: type: integer description: Margin amount to add (positive) or remove (negative) in raw units required: - type - asset - isBuy - ntli nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: updateIsolatedMargin asset: 0 isBuy: true ntli: 100000000 nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Isolated margin update result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object properties: type: type: string data: type: object properties: status: type: string description: Result status example: status: ok response: type: updateIsolatedMargin data: status: success /exchange_update_leverage: post: tags: - General summary: Update leverage operationId: updateLeverage requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: updateLeverage enum: - updateLeverage description: Action type for updating leverage asset: type: integer description: Asset index to update leverage for isCross: type: boolean description: Whether to use cross margin (true) or isolated margin (false) leverage: type: integer description: Leverage value (1-50 for isolated margin, 1-20 for cross margin) required: - type - asset - isCross - leverage nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: updateLeverage asset: 0 isCross: false leverage: 10 nonce: 1705234567890 signature: r: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: 27 vaultAddress: null responses: '200': description: Leverage update result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object properties: type: type: string data: type: object properties: status: type: string description: Result status example: status: ok response: type: updateLeverage data: status: success /exchange_usd_send: post: tags: - General summary: Transfer USDC operationId: transferUSDC requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: usdSend enum: - usdSend description: Action type hyperliquidChain: type: string description: Chain identifier default: Mainnet enum: - Mainnet - Testnet signatureChainId: type: string description: EIP-712 signature chain ID default: '0xa4b1' destination: type: string description: Recipient Ethereum address amount: type: string description: Amount of USD to send as a decimal string time: type: integer description: Current timestamp in milliseconds required: - type - hyperliquidChain - signatureChainId - destination - amount - time nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: usdSend hyperliquidChain: Mainnet signatureChainId: '0xa4b1' destination: '0x1234567890abcdef1234567890abcdef12345678' amount: '100.0' time: 1705234567890 nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: USDC transfer result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object properties: type: type: string data: type: object properties: status: type: string description: Transfer status example: status: ok response: type: usdSend data: status: success /exchange_user_dex_abstraction: post: tags: - General summary: Set user DEX abstraction operationId: exchangeUserDexAbstraction requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: userDexAbstraction enum: - userDexAbstraction description: Action type hyperliquidChain: type: string description: Chain identifier default: Mainnet enum: - Mainnet - Testnet signatureChainId: type: string description: EIP-712 signature chain ID default: '0xa4b1' user: type: string description: Ethereum address of the user enabled: type: boolean description: Whether to enable or disable DEX abstraction nonce: type: integer description: Current timestamp in milliseconds required: - type - hyperliquidChain - signatureChainId - user - enabled - nonce nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: userDexAbstraction hyperliquidChain: Mainnet signatureChainId: '0xa4b1' user: '0x1234567890abcdef1234567890abcdef12345678' enabled: true nonce: 1705234567890 nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_user_set_abstraction: post: tags: - General summary: Set user abstraction operationId: userSetAbstraction requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: userSetAbstraction enum: - userSetAbstraction description: Action type user: type: string description: Ethereum address of the user abstraction: type: object description: Abstraction configuration object nonce: type: integer description: Current timestamp in milliseconds required: - type - user - abstraction - nonce nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: userSetAbstraction user: '0x1234567890abcdef1234567890abcdef12345678' abstraction: {} nonce: 1705234567890 nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_validator_l1_stream: post: tags: - General summary: Validator L1 stream operationId: validatorL1Stream requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: validatorL1Stream enum: - validatorL1Stream description: Action type payload: type: object description: L1 stream payload data required: - type - payload nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: validatorL1Stream payload: {} nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_vault_transfer: post: tags: - General summary: Vault transfer operationId: vaultTransfer requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: vaultTransfer enum: - vaultTransfer description: Action type for vault transfer vaultAddress: type: string description: Vault address example: 0x... isDeposit: type: boolean description: True to deposit, false to withdraw example: true usd: type: integer description: Amount in raw USD units example: 1000000 required: - type nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: vaultTransfer vaultAddress: '0x1234567890abcdef1234567890abcdef12345678' isDeposit: true usd: 1000000 nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: Action result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object description: Action response data /exchange_withdraw: post: tags: - General summary: Withdraw USDC operationId: withdrawUSDC requestBody: required: true content: application/json: schema: type: object properties: action: type: object properties: type: type: string default: withdraw3 enum: - withdraw3 description: Action type for withdrawal hyperliquidChain: type: string description: Chain identifier default: Mainnet enum: - Mainnet - Testnet signatureChainId: type: string description: EIP-712 signature chain ID default: '0xa4b1' destination: type: string description: Destination Ethereum address for the withdrawal amount: type: string description: Amount to withdraw as a decimal string time: type: integer description: Current timestamp in milliseconds required: - type - hyperliquidChain - signatureChainId - destination - amount - time nonce: type: integer description: Current timestamp in milliseconds signature: type: object description: EIP-712 signature of the action with r, s, v components properties: r: type: string description: ECDSA signature r component (hex string) example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' s: type: string description: ECDSA signature s component (hex string) example: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321' v: type: integer description: ECDSA recovery id (27 or 28) example: 27 required: - r - s - v vaultAddress: type: string description: Address when trading on behalf of a vault or subaccount (optional) nullable: true required: - action - nonce - signature example: action: type: withdraw3 hyperliquidChain: Mainnet signatureChainId: '0xa4b1' destination: '0x1234567890abcdef1234567890abcdef12345678' amount: '500.0' time: 1705234567890 nonce: 1705234567890 signature: r: '0x0000000000000000000000000000000000000000000000000000000000000000' s: '0x0000000000000000000000000000000000000000000000000000000000000000' v: 27 vaultAddress: null responses: '200': description: USDC withdrawal result content: application/json: schema: type: object properties: status: type: string description: Request status response: type: object properties: type: type: string data: type: object properties: status: type: string description: Withdrawal status example: status: ok response: type: withdraw data: status: success /info_activeassetdata: post: tags: - General summary: info (activeAssetData) operationId: infoActiveAssetData requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: activeAssetData enum: - activeAssetData description: Request type to retrieve active asset data for a specific user and coin user: type: string default: '0x31ca8395cf837de08b24da3f660e77761dfb974b' description: Address in 42-character hexadecimal format coin: type: string default: BTC description: Asset symbol to retrieve data for (e.g., 'BTC', 'ETH', 'SOL') required: - type - user - coin responses: '200': description: Active asset data for the specified user and coin content: application/json: schema: type: object description: Active asset data for a user and coin (perpetuals only) properties: user: type: string description: User address coin: type: string description: Asset symbol leverage: type: object properties: type: type: string description: cross or isolated value: type: number description: Leverage value maxTradeSzs: type: array description: Maximum trade sizes [long, short] items: type: string availableToTrade: type: array description: Available amounts to trade [long, short] items: type: string markPx: type: string description: Current mark price required: - user - coin - leverage - maxTradeSzs - availableToTrade - markPx example: user: '0x31ca8395cf837de08b24da3f660e77761dfb974b' coin: BTC leverage: type: cross value: 20 maxTradeSzs: - '22046.53864' - '22099.95768' availableToTrade: - '128889576.5241000056' - '129201877.5867000073' markPx: '116925.0' /info_aligned_quote_token_info: post: tags: - General summary: info (alignedQuoteTokenInfo) operationId: infoAlignedQuoteTokenInfo requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: Request type default: alignedQuoteTokenInfo enum: - alignedQuoteTokenInfo token: type: integer description: Spot token index from the spotMeta universe. Only tokens registered as aligned quote assets return data. default: 1 required: - type - token responses: '200': description: Aligned quote token information or null content: application/json: schema: nullable: true type: object properties: isAligned: type: boolean description: Whether the token is currently aligned firstAlignedTime: type: integer description: Unix timestamp in milliseconds when the token was first aligned evmMintedSupply: type: string description: Total EVM minted supply as reported by CoreWriter dailyAmountOwed: type: array description: Array of [date, amount] tuples showing daily owed amounts items: type: array items: type: string predictedRate: type: string description: Predicted alignment rate as a decimal string /info_all_borrow_lend_reserve_states: post: tags: - General summary: info (allBorrowLendReserveStates) operationId: infoAllBorrowLendReserveStates requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: Request type default: allBorrowLendReserveStates enum: - allBorrowLendReserveStates required: - type responses: '200': description: Array of all token reserve states content: application/json: schema: type: object /info_all_perp_metas: post: tags: - General summary: info (allPerpMetas) operationId: infoAllPerpMetas requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: Request type default: allPerpMetas enum: - allPerpMetas required: - type responses: '200': description: Array of perp metadata for all DEXes content: application/json: schema: type: object /info_allmids: post: tags: - General summary: info (allMids) operationId: infoAllMids requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: allMids enum: - allMids description: Request type to retrieve mid prices for all coins dex: type: string default: '' description: Perp dex name. Defaults to the empty string which represents the first perp dex. Spot mids are only included with the first perp dex. required: - type responses: '200': description: Mid prices for all available coins content: application/json: schema: type: object description: Object containing mid prices for all coins with coin symbols as keys and prices as values additionalProperties: type: string description: Mid price for the coin as a string example: '@142': '116849.5' BTC: '116845.5' ETH: '3915.35' HYPE: '40.7915' /info_batch_clearinghouse_states: post: tags: - General summary: info (batchClearinghouseStates) operationId: infoBatchClearinghouseStates requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: batchClearinghouseStates example: batchClearinghouseStates enum: - batchClearinghouseStates description: Request type to retrieve multiple users' perpetuals account summaries users: type: array description: Array of onchain addresses in 42-character hexadecimal format default: - '0x5e9ee1089755c3435139848e47e6635505d5a13a' - '0xb7b6f3cea3f66bf525f5d8f965f6dbf6d9b017b2' example: - '0x5e9ee1089755c3435139848e47e6635505d5a13a' - '0xb7b6f3cea3f66bf525f5d8f965f6dbf6d9b017b2' items: type: string example: '0x0000000000000000000000000000000000000001' minItems: 1 dex: type: string default: '' example: '' description: Perp dex name. Defaults to empty string which represents the first perp dex required: - type - users default: type: batchClearinghouseStates users: - '0x5e9ee1089755c3435139848e47e6635505d5a13a' - '0xb7b6f3cea3f66bf525f5d8f965f6dbf6d9b017b2' dex: '' example: type: batchClearinghouseStates users: - '0x5e9ee1089755c3435139848e47e6635505d5a13a' - '0xb7b6f3cea3f66bf525f5d8f965f6dbf6d9b017b2' dex: '' responses: '200': description: Array of users' perpetuals account summaries including positions and margin information content: application/json: schema: type: array nullable: true items: type: object properties: assetPositions: type: array description: Array of user's asset positions items: type: object properties: position: type: object properties: coin: type: string description: Asset symbol cumFunding: type: object description: Cumulative funding information properties: allTime: type: string sinceChange: type: string sinceOpen: type: string entryPx: type: string description: Entry price leverage: type: object description: Leverage information properties: rawUsd: type: string type: type: string value: type: number liquidationPx: type: string marginUsed: type: string maxLeverage: type: number positionValue: type: string returnOnEquity: type: string szi: type: string unrealizedPnl: type: string type: type: string description: Position type crossMaintenanceMarginUsed: type: string crossMarginSummary: type: object properties: accountValue: type: string totalMarginUsed: type: string totalNtlPos: type: string totalRawUsd: type: string marginSummary: type: object properties: accountValue: type: string totalMarginUsed: type: string totalNtlPos: type: string totalRawUsd: type: string time: type: number withdrawable: type: string /info_borrow_lend_reserve_state: post: tags: - General summary: info (borrowLendReserveState) operationId: infoBorrowLendReserveState requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: Request type default: borrowLendReserveState enum: - borrowLendReserveState token: type: integer description: Token index (e.g., 0 for USDC) default: 0 required: - type - token responses: '200': description: Reserve state for the specified token content: application/json: schema: type: object /info_borrow_lend_user_state: post: tags: - General summary: info (borrowLendUserState) operationId: infoBorrowLendUserState requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: Request type default: borrowLendUserState enum: - borrowLendUserState user: type: string description: Onchain address in 42-character hexadecimal format default: '0x31ca8395cf837de08b24da3f660e77761dfb974b' required: - type - user responses: '200': description: User's borrow/lend state including positions and health content: application/json: schema: type: object /info_candle_snapshot: post: summary: Candle snapshot description: Retrieve historical candlestick (OHLCV) data for a specific asset within a time range. Only the most recent 5000 candles are available. requestBody: required: true content: application/json: schema: type: object required: - type - req properties: type: type: string enum: - candleSnapshot default: candleSnapshot description: The request type. Must be 'candleSnapshot' to retrieve candle data. req: type: object required: - coin - interval - startTime - endTime default: coin: BTC interval: 1h startTime: 1754300000000 endTime: 1754400000000 properties: coin: type: string default: BTC description: Asset identifier (simple names like 'BTC', 'ETH' for perpetuals; spot format like '@107' for spot trades) interval: type: string enum: - 1m - 3m - 5m - 15m - 30m - 1h - 2h - 4h - 8h - 12h - 1d - 3d - 1w - 1M default: 1h description: Candle interval/timeframe startTime: type: integer format: int64 default: 1754300000000 description: Start time in milliseconds (epoch timestamp) endTime: type: integer format: int64 default: 1754400000000 description: End time in milliseconds (epoch timestamp) description: Request parameters object containing coin, interval, and time range example: type: candleSnapshot req: coin: BTC interval: 1h startTime: 1754300000000 endTime: 1754400000000 responses: '200': description: Successful response with candlestick data content: application/json: schema: type: array items: type: object properties: T: type: integer format: int64 description: Close time timestamp in milliseconds c: type: string description: Close price as a string for precision h: type: string description: High price as a string for precision i: type: string description: Interval/timeframe of the candle l: type: string description: Low price as a string for precision n: type: integer description: Number of trades during this candle period o: type: string description: Open price as a string for precision s: type: string description: Symbol/asset identifier t: type: integer format: int64 description: Open time timestamp in milliseconds v: type: string description: Volume traded during this candle period required: - T - c - h - i - l - n - o - s - t - v example: - T: 1681924499999 c: '29258.0' h: '29309.0' i: 15m l: '29250.0' n: 189 o: '29295.0' s: BTC t: 1681923600000 v: '0.98639' tags: - General operationId: info_candle_snapshot /info_clearinghousestate: post: tags: - General summary: info (clearinghouseState) operationId: infoClearinghouseState requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: clearinghouseState enum: - clearinghouseState description: Request type to retrieve user's perpetuals account summary user: type: string default: '0x31ca8395cf837de08b24da3f660e77761dfb974b' description: Onchain address in 42-character hexadecimal format dex: type: string default: '' description: Perp dex name. Defaults to empty string which represents the first perp dex required: - type - user responses: '200': description: User's perpetuals account summary including positions and margin information content: application/json: schema: type: object properties: assetPositions: type: array description: Array of user's asset positions items: type: object properties: position: type: object properties: coin: type: string description: Asset symbol cumFunding: type: object description: Cumulative funding information properties: allTime: type: string description: All-time cumulative funding sinceChange: type: string description: Funding since last position change sinceOpen: type: string description: Funding since position opened entryPx: type: string description: Entry price leverage: type: object description: Leverage information properties: rawUsd: type: string description: Raw USD value type: type: string description: Leverage type (isolated/cross) value: type: number description: Leverage value liquidationPx: type: string description: Liquidation price marginUsed: type: string description: Margin used for this position maxLeverage: type: number description: Maximum leverage allowed positionValue: type: string description: Current position value returnOnEquity: type: string description: Return on equity szi: type: string description: Position size unrealizedPnl: type: string description: Unrealized profit and loss type: type: string description: Position type crossMaintenanceMarginUsed: type: string description: Cross maintenance margin used crossMarginSummary: type: object description: Cross margin account summary properties: accountValue: type: string description: Total account value totalMarginUsed: type: string description: Total margin used totalNtlPos: type: string description: Total notional position totalRawUsd: type: string description: Total raw USD marginSummary: type: object description: Overall margin summary properties: accountValue: type: string description: Total account value totalMarginUsed: type: string description: Total margin used totalNtlPos: type: string description: Total notional position totalRawUsd: type: string description: Total raw USD time: type: number description: Timestamp of the data withdrawable: type: string description: Amount available for withdrawal /info_delegations: post: tags: - General summary: Info (Delegations) operationId: infoDelegations requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: delegations enum: - delegations description: Request type to retrieve user's delegation information user: type: string default: '0x2ba553d9f990a3b66b03b2dc0d030dfc1c061036' description: Address in 42-character hexadecimal format required: - type - user responses: '200': description: Active delegations for the user content: application/json: schema: type: array description: List of active delegations items: type: object properties: validator: type: string description: Validator address amount: type: string description: Delegated amount lockedUntilTimestamp: type: integer description: Lock expiration timestamp (ms) required: - validator - amount - lockedUntilTimestamp example: - validator: '0xb8f45222a3246a2b0104696a1df26842007c5bc5' amount: '100233.20588006' lockedUntilTimestamp: 1751468638782 /info_delegator_history: post: summary: Query a user's staking history description: Retrieve comprehensive staking history for a specific user, including delegation and undelegation events with timestamps, transaction hashes, and detailed delta information. requestBody: required: true content: application/json: schema: type: object required: - type - user properties: type: type: string enum: - delegatorHistory default: delegatorHistory description: The request type. Must be 'delegatorHistory' to retrieve staking history. user: type: string pattern: ^0x[a-fA-F0-9]{40}$ default: '0x2ba553d9f990a3b66b03b2dc0d030dfc1c061036' description: Address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000. example: type: delegatorHistory user: '0x2ba553d9f990a3b66b03b2dc0d030dfc1c061036' responses: '200': description: Successful response with staking history data content: application/json: schema: type: array description: Array of staking history events items: type: object properties: time: type: integer format: int64 description: Timestamp of the staking event in milliseconds hash: type: string description: Transaction hash of the staking event delta: type: object description: Details of the staking change properties: delegate: type: object description: Delegation event details properties: validator: type: string description: Address of the validator being delegated to or undelegated from amount: type: string description: Amount being delegated or undelegated isUndelegate: type: boolean description: Whether this is an undelegation event (true) or delegation event (false) required: - time - hash - delta example: - time: 1735380381353 hash: '0x55492465cb523f90815a041a226ba90147008d4b221a24ae8dc35a0dbede4ea4' delta: delegate: validator: '0x5ac99df645f3414876c816caa18b2d234024b487' amount: '10000.0' isUndelegate: false - time: 1735380281353 hash: '0x44492465cb523f90815a041a226ba90147008d4b221a24ae8dc35a0dbede4ea3' delta: delegate: validator: '0x5ac99df645f3414876c816caa18b2d234024b487' amount: '5000.0' isUndelegate: true tags: - General operationId: info_delegator_history /info_delegator_rewards: post: summary: Query a user's staking rewards description: Retrieve comprehensive staking rewards history for a specific user, including delegation rewards and commission earnings with timestamps and reward sources. requestBody: required: true content: application/json: schema: type: object required: - type - user properties: type: type: string enum: - delegatorRewards default: delegatorRewards description: The request type. Must be 'delegatorRewards' to retrieve staking rewards. user: type: string pattern: ^0x[a-fA-F0-9]{40}$ default: '0x2ba553d9f990a3b66b03b2dc0d030dfc1c061036' description: Address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000. example: type: delegatorRewards user: '0x2ba553d9f990a3b66b03b2dc0d030dfc1c061036' responses: '200': description: Successful response with staking rewards data content: application/json: schema: type: array description: Array of staking reward events items: type: object properties: time: type: integer format: int64 description: Timestamp of the reward event in milliseconds source: type: string enum: - delegation - commission description: 'Source of the reward: ''delegation'' for staking rewards or ''commission'' for validator commission' totalAmount: type: string description: Total amount of rewards received required: - time - source - totalAmount example: - time: 1736726400073 source: delegation totalAmount: '0.73117184' - time: 1736726400073 source: commission totalAmount: '130.76445876' - time: 1736640000073 source: delegation totalAmount: '0.68234567' tags: - General operationId: info_delegator_rewards /info_delegator_summary: post: tags: - General summary: info (delegatorSummary) operationId: infoDelegatorSummary requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: delegatorSummary enum: - delegatorSummary description: Request type to retrieve user's delegation summary user: type: string default: '0x2ba553d9f990a3b66b03b2dc0d030dfc1c061036' description: Address in 42-character hexadecimal format required: - type - user responses: '200': description: User's delegation summary with key staking metrics content: application/json: schema: type: object description: Summary of user's delegation status and pending withdrawals properties: delegated: type: string description: Total amount currently delegated by the user undelegated: type: string description: Total amount that has been undelegated totalPendingWithdrawal: type: string description: Total amount pending withdrawal (unbonding) nPendingWithdrawals: type: integer description: Number of pending withdrawal transactions required: - delegated - undelegated - totalPendingWithdrawal - nPendingWithdrawals /info_exchangestatus: post: tags: - General summary: info (exchangeStatus) operationId: infoExchangeStatus requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: exchangeStatus enum: - exchangeStatus description: Request type to retrieve exchange status information required: - type responses: '200': description: Exchange status information content: application/json: schema: type: object description: Current status of the Hyperliquid exchange properties: universe: type: array description: List of available assets on the exchange items: type: object properties: name: type: string description: Asset name (e.g., 'BTC', 'ETH') szDecimals: type: integer description: Number of decimal places for size precision required: - universe /info_extraagents: post: tags: - General summary: info (extraAgents) operationId: infoExtraAgents requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: extraAgents enum: - extraAgents description: Request type to retrieve extra agents associated with a user user: type: string default: '0x2ba553d9f990a3b66b03b2dc0d030dfc1c061036' description: Address in 42-character hexadecimal format required: - type - user responses: '200': description: List of extra agents associated with the user content: application/json: schema: type: array description: List of extra agents associated with the user items: type: object properties: name: type: string description: Label for the agent address: type: string description: Agent address in 42-character hexadecimal format validUntil: type: integer format: int64 description: Timestamp in milliseconds until which the agent is valid required: - name - address - validUntil example: - name: Mobile QR address: '0x1715462edd45a87eea74e402428392ffc744eb20' validUntil: 1756349176478 - name: p1 address: '0xd56a73c11336d712403d346c7502f5af29027cda' validUntil: 1766846919956 /info_frontendopenorders: post: tags: - General summary: info (frontendOpenOrders) operationId: infoFrontendOpenOrders requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: frontendOpenOrders enum: - frontendOpenOrders description: Request type to retrieve user's open orders with frontend-specific formatting user: type: string default: '0x31ca8395cf837de08b24da3f660e77761dfb974b' description: Address in 42-character hexadecimal format dex: type: string default: '' description: Perp dex name. Defaults to the empty string which represents the first perp dex. Spot open orders are only included with the first perp dex. required: - type - user responses: '200': description: Array of user's open orders with frontend-specific formatting content: application/json: schema: type: array description: List of open orders formatted for frontend display items: type: object properties: coin: type: string description: Trading pair or asset symbol (e.g., 'BTC', 'ETH') limitPx: type: string description: Limit price of the order oid: type: integer description: Order ID - unique identifier for the order side: type: string description: 'Order side: ''A'' for ask (sell), ''B'' for bid (buy)' sz: type: string description: Order size timestamp: type: integer description: Order creation timestamp in milliseconds triggerCondition: type: string description: Trigger condition for conditional orders triggerPx: type: string description: Trigger price for conditional orders orderType: type: string description: Type of order (e.g., 'Limit', 'Market', 'Stop') reduceOnly: type: boolean description: Whether this is a reduce-only order required: - coin - limitPx - oid - side - sz - timestamp /info_funding_history: post: tags: - General summary: info (fundingHistory) operationId: infoFundingHistory description: Retrieve historical funding rates and premiums for a specific perpetual contract, providing insight into market sentiment and carry costs over time. requestBody: required: true content: application/json: schema: type: object required: - type - coin - startTime properties: type: type: string enum: - fundingHistory default: fundingHistory description: The request type. Must be 'fundingHistory' to retrieve funding rate history. coin: type: string default: BTC description: Asset symbol to retrieve funding history for (e.g., 'BTC', 'ETH', 'SOL') startTime: type: integer default: 1681923833000 description: Start timestamp in milliseconds, inclusive. endTime: type: integer description: End timestamp in milliseconds, inclusive. Defaults to current time if not provided. example: type: fundingHistory coin: BTC startTime: 1681923833000 responses: '200': description: Historical funding rates and premiums data content: application/json: schema: type: array description: Array of funding rate records for the specified asset items: type: object properties: coin: type: string fundingRate: type: string premium: type: string time: type: integer format: int64 required: - coin - fundingRate - premium - time example: - coin: BTC fundingRate: '-0.0006133368' premium: '-0.0009133368' time: 1683849600048 - coin: BTC fundingRate: '-0.000745027' premium: '-0.001045027' time: 1683878400388 - coin: BTC fundingRate: '0.0000125' premium: '0.0001068963' time: 1686204000106 /info_gossip_root_ips: post: tags: - General summary: info (gossipRootIps) operationId: infoGossipRootIps requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: gossipRootIps enum: - gossipRootIps required: - type responses: '200': description: Successful response content: application/json: schema: type: array items: type: string /info_historical_orders: post: summary: Retrieve a user's historical orders description: Retrieve the most recent historical orders for a specific user. Returns at most 2000 most recent historical orders with their current status and detailed order information. requestBody: required: true content: application/json: schema: type: object required: - type - user properties: type: type: string enum: - historicalOrders default: historicalOrders description: The request type. Must be 'historicalOrders' to retrieve historical orders. user: type: string pattern: ^0x[a-fA-F0-9]{40}$ default: '0x31ca8395cf837de08b24da3f660e77761dfb974b' description: Address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000. example: type: historicalOrders user: '0x31ca8395cf837de08b24da3f660e77761dfb974b' responses: '200': description: Successful response with historical orders data content: application/json: schema: type: array items: type: object properties: order: type: object properties: coin: type: string description: Asset identifier (simple names like 'BTC', 'ETH' for perpetuals; spot format like '@107' for spot trades) side: type: string enum: - A - B description: 'Order side: ''A'' for Ask/Sell, ''B'' for Bid/Buy' limitPx: type: string description: Limit price as a string for precision sz: type: string description: Current order size (remaining quantity) oid: type: integer format: int64 description: Order ID timestamp: type: integer format: int64 description: Order creation timestamp in milliseconds triggerCondition: type: string description: Trigger condition for conditional orders isTrigger: type: boolean description: Whether this is a trigger order triggerPx: type: string description: Trigger price for conditional orders children: type: array items: {} description: Child orders (for TP/SL orders) isPositionTpsl: type: boolean description: Whether this is a position-level TP/SL order reduceOnly: type: boolean description: Whether this is a reduce-only order orderType: type: string description: Order type (e.g., 'Market', 'Limit') origSz: type: string description: Original order size tif: type: string description: Time in force (e.g., 'FrontendMarket', 'Gtc', 'Ioc') cloid: type: string nullable: true description: Client order ID if provided status: type: string enum: - filled - open - canceled - triggered - rejected - marginCanceled - vaultWithdrawalCanceled - openInterestCapCanceled - selfTradeCanceled - reduceOnlyCanceled - siblingFilledCanceled - delistedCanceled - liquidatedCanceled - scheduledCancel - tickRejected - minTradeNtlRejected - perpMarginRejected - reduceOnlyRejected - badAloPxRejected - iocCancelRejected - badTriggerPxRejected - marketOrderNoLiquidityRejected - positionIncreaseAtOpenInterestCapRejected - positionFlipAtOpenInterestCapRejected - tooAggressiveAtOpenInterestCapRejected - openInterestIncreaseRejected - insufficientSpotBalanceRejected - oracleRejected - perpMaxPositionRejected description: Current order status statusTimestamp: type: integer format: int64 description: Timestamp when the status was last updated required: - order - status - statusTimestamp example: - order: coin: ETH side: A limitPx: '2412.7' sz: '0.0' oid: 1 timestamp: 1724361546645 triggerCondition: N/A isTrigger: false triggerPx: '0.0' children: [] isPositionTpsl: false reduceOnly: true orderType: Market origSz: '0.0076' tif: FrontendMarket cloid: null status: filled statusTimestamp: 1724361546645 tags: - General operationId: info_historical_orders /info_l2_book: post: summary: L2 book snapshot description: Retrieve the Level 2 order book snapshot for a specific asset. Returns at most 20 levels per side (bids and asks) with price, size, and order count information. requestBody: required: true content: application/json: schema: type: object required: - type - coin properties: type: type: string enum: - l2Book default: l2Book description: The request type. Must be 'l2Book' to retrieve order book snapshot. coin: type: string default: ETH description: Asset identifier (simple names like 'BTC', 'ETH' for perpetuals; spot format like '@107' for spot trades) nSigFigs: type: integer enum: - 2 - 3 - 4 - 5 - null nullable: true description: Optional field to aggregate levels to nSigFigs significant figures. Valid values are 2, 3, 4, 5, and null (full precision) mantissa: type: integer enum: - 1 - 2 - 5 description: Optional field to aggregate levels. This field is only allowed if nSigFigs is 5. Accepts values of 1, 2 or 5 example: type: l2Book coin: ETH responses: '200': description: Successful response with L2 order book data content: application/json: schema: type: array minItems: 2 maxItems: 2 items: type: array items: type: object properties: px: type: string description: Price level as a string for precision sz: type: string description: Total size (quantity) at this price level n: type: integer description: The number of different orders that comprise this level required: - px - sz - n description: 'Array containing two arrays: [bids, asks]. Each side contains up to 20 price levels.' example: - - px: '19900' sz: '1' n: 1 - px: '19800' sz: '2' n: 2 - px: '19700' sz: '3' n: 3 - - px: '20100' sz: '1' n: 1 - px: '20200' sz: '2' n: 2 - px: '20300' sz: '3' n: 3 tags: - General operationId: info_l2_book /info_leadingvaults: post: tags: - General summary: info (leadingVaults) operationId: infoLeadingVaults requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: leadingVaults enum: - leadingVaults description: Request type to retrieve vaults led by a specific user user: type: string default: '0x31ca8395cf837de08b24da3f660e77761dfb974b' description: Address in 42-character hexadecimal format of the vault leader required: - type - user responses: '200': description: Information about vaults led by the specified user content: application/json: schema: type: array description: List of vaults managed by the specified vault leader items: type: object properties: vaultAddress: type: string description: Contract address of the vault name: type: string description: Human-readable name of the vault leader: type: string description: Address of the vault leader (should match the requested user) totalShares: type: string description: Total number of shares issued by the vault tvl: type: string description: Total value locked in the vault (USD) sharePrice: type: string description: Current price per share pnl1D: type: string description: 1-day profit and loss percentage pnl7D: type: string description: 7-day profit and loss percentage pnl30D: type: string description: 30-day profit and loss percentage pnlAllTime: type: string description: All-time profit and loss percentage maxDD: type: string description: Maximum drawdown percentage isOpen: type: boolean description: Whether the vault is open for new deposits minDeposit: type: string description: Minimum deposit amount required createdTime: type: integer description: Vault creation timestamp in milliseconds leaderCommission: type: string description: Commission percentage taken by the vault leader required: - vaultAddress - name - leader /info_liquidatable: post: tags: - General summary: Info (Liquidatable) operationId: infoLiquidatable requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: liquidatable enum: - liquidatable description: Request type to check if user positions are liquidatable user: type: string default: '0x31ca8395cf837de08b24da3f660e77761dfb974b' description: Address in 42-character hexadecimal format required: - type - user responses: '200': description: Liquidation status information for the user content: application/json: schema: type: object description: Information about user's liquidation status and risk metrics properties: liquidatable: type: boolean description: Whether the user's positions are currently liquidatable leverage: type: string description: Current leverage ratio of the user's positions marginUsed: type: string description: Amount of margin currently used marginRemaining: type: string description: Amount of margin remaining before liquidation accountValue: type: string description: Total account value including unrealized PnL totalRawUsd: type: string description: Total raw USD value of the account totalNtlPos: type: string description: Total notional position value required: - liquidatable /info_margin_table: post: tags: - General summary: info (marginTable) operationId: infoMarginTable requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: Request type default: marginTable enum: - marginTable id: type: integer description: Margin table ID default: 1 required: - type - id responses: '200': description: Margin table configuration content: application/json: schema: type: object /info_max_builder_fee: post: tags: - General summary: info (maxBuilderFee) operationId: infoMaxBuilderFee requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: maxBuilderFee enum: - maxBuilderFee description: Request type to retrieve maximum builder fee approved by user user: type: string default: '0x47fc45cebfc47cef07a09a98405b6ebaef00ef75' description: User address in 42-character hexadecimal format builder: type: string default: '0x1922810825c90f4270048b96da7b1803cd8609ef' description: Builder address in 42-character hexadecimal format required: - type - user - builder responses: '200': description: Maximum builder fee approved by the user for the specified builder content: application/json: schema: type: integer description: Maximum fee approved in tenths of a basis point (e.g., 1 means 0.001%) example: 1 /info_maxmarketorderntls: post: tags: - General summary: info (maxMarketOrderNtls) operationId: infoMaxMarketOrderNtls requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: maxMarketOrderNtls enum: - maxMarketOrderNtls description: Request type to retrieve maximum market order notional values for all assets required: - type responses: '200': description: Maximum market order notional values for all assets content: application/json: schema: type: array description: List of maximum market order notional values by asset items: type: object properties: coin: type: string description: Asset symbol (e.g., 'BTC', 'ETH', 'SOL') maxNtl: type: string description: Maximum notional value allowed for market orders in USD maxSz: type: string description: Maximum size allowed for market orders in asset units required: - coin - maxNtl /info_meta: post: tags: - General summary: Info (Meta) operationId: infoMeta requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: meta enum: - meta dex: type: string default: '' required: - type responses: '200': description: Successful response content: application/json: schema: type: object /info_meta_and_asset_ctxs: post: tags: - General summary: info (metaAndAssetCtxs) operationId: infoMetaAndAssetCtxs description: Retrieve comprehensive asset contexts for perpetuals trading, including universe metadata and real-time market data such as mark prices, funding rates, open interest, and volume metrics. requestBody: required: true content: application/json: schema: type: object required: - type properties: type: type: string enum: - metaAndAssetCtxs default: metaAndAssetCtxs description: The request type. Must be 'metaAndAssetCtxs' to retrieve asset contexts. example: type: metaAndAssetCtxs responses: '200': description: Successful response with asset contexts data content: application/json: schema: type: array description: Array containing universe metadata and asset contexts example: - universe: - name: BTC szDecimals: 5 maxLeverage: 50 - name: ETH szDecimals: 4 maxLeverage: 50 - name: HPOS szDecimals: 0 maxLeverage: 3 onlyIsolated: true - - dayNtlVlm: '1169046.29406' funding: '0.0000125' impactPxs: - '14.3047' - '14.3444' markPx: '14.3161' midPx: '14.314' openInterest: '688.11' oraclePx: '14.32' premium: '0.00031774' prevDayPx: '15.322' - dayNtlVlm: '1426126.295175' funding: '0.0000125' impactPxs: - '6.0386' - '6.0562' markPx: '6.0436' midPx: '6.0431' openInterest: '1882.55' oraclePx: '6.0457' premium: '0.00028119' prevDayPx: '6.3611' - dayNtlVlm: '809774.565507' funding: '0.0000125' impactPxs: - '8.4505' - '8.4722' markPx: '8.4542' midPx: '8.4557' openInterest: '2912.05' oraclePx: '8.4585' premium: '0.00033694' prevDayPx: '8.8097' /info_openorders: post: tags: - General summary: info (openOrders) operationId: infoOpenOrders requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: openOrders enum: - openOrders description: Request type to retrieve user's open orders user: type: string default: '0x31ca8395cf837de08b24da3f660e77761dfb974b' description: Address in 42-character hexadecimal format dex: type: string default: '' description: Perp dex name. Defaults to empty string which represents the first perp dex. Spot open orders are only included with the first perp dex required: - type - user responses: '200': description: Array of user's open orders content: application/json: schema: type: array description: List of open orders for the user items: type: object properties: coin: type: string description: Trading pair or asset symbol (e.g., 'BTC', 'ETH', '@107' for spot) limitPx: type: string description: Limit price of the order oid: type: integer description: Order ID - unique identifier for the order side: type: string description: 'Order side: ''A'' for ask (sell), ''B'' for bid (buy)' sz: type: string description: Remaining size of the order (unfilled amount) timestamp: type: integer description: Order creation timestamp in milliseconds required: - coin - limitPx - oid - side - sz - timestamp /info_order_status: post: summary: Query order status by oid or cloid description: Retrieve the current status of an order using either the order ID (oid) or client order ID (cloid). This endpoint provides detailed information about order state, execution status, and timestamps. requestBody: required: true content: application/json: schema: type: object required: - type - user - oid properties: type: type: string enum: - orderStatus default: orderStatus description: The request type. Must be 'orderStatus' to query order status. user: type: string pattern: ^0x[a-fA-F0-9]{40}$ default: '0x31ca8395cf837de08b24da3f660e77761dfb974b' description: Address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000. oid: oneOf: - type: integer format: int64 description: Order ID as a 64-bit unsigned integer - type: string pattern: ^[a-fA-F0-9]{32}$ description: Client order ID as a 16-byte hex string default: 127244980388 description: Either u64 representing the order id or 16-byte hex string representing the client order id example: type: orderStatus user: '0x31ca8395cf837de08b24da3f660e77761dfb974b' oid: 127244980388 responses: '200': description: Successful response content: application/json: schema: oneOf: - type: object properties: status: type: string enum: - order description: Indicates that order information is available order: type: object properties: order: type: object properties: coin: type: string description: Asset identifier (simple names like 'BTC', 'ETH' for perpetuals; spot format like '@107' for spot trades) side: type: string enum: - A - B description: 'Order side: ''A'' for Ask/Sell, ''B'' for Bid/Buy' limitPx: type: string description: Limit price as a string for precision sz: type: string description: Current order size (remaining quantity) oid: type: integer format: int64 description: Order ID timestamp: type: integer format: int64 description: Order creation timestamp in milliseconds triggerCondition: type: string description: Trigger condition for conditional orders isTrigger: type: boolean description: Whether this is a trigger order triggerPx: type: string description: Trigger price for conditional orders children: type: array items: {} description: Child orders (for TP/SL orders) isPositionTpsl: type: boolean description: Whether this is a position-level TP/SL order reduceOnly: type: boolean description: Whether this is a reduce-only order orderType: type: string description: Order type (e.g., 'Market', 'Limit') origSz: type: string description: Original order size tif: type: string description: Time in force (e.g., 'FrontendMarket', 'Gtc', 'Ioc') cloid: type: string nullable: true description: Client order ID if provided status: type: string enum: - open - filled - canceled - triggered - rejected - marginCanceled - vaultWithdrawalCanceled - openInterestCapCanceled - selfTradeCanceled - reduceOnlyCanceled - siblingFilledCanceled - delistedCanceled - liquidatedCanceled - scheduledCancel - tickRejected - minTradeNtlRejected - perpMarginRejected - reduceOnlyRejected - badAloPxRejected - iocCancelRejected - badTriggerPxRejected - marketOrderNoLiquidityRejected - positionIncreaseAtOpenInterestCapRejected - positionFlipAtOpenInterestCapRejected - tooAggressiveAtOpenInterestCapRejected - openInterestIncreaseRejected - insufficientSpotBalanceRejected - oracleRejected - perpMaxPositionRejected description: Current order status statusTimestamp: type: integer format: int64 description: Timestamp when the status was last updated - type: object properties: status: type: string enum: - unknownOid description: Indicates that the order ID was not found tags: - General operationId: info_order_status /info_outcomemeta: post: tags: - General summary: info (outcomeMeta) operationId: infoOutcomeMeta requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: outcomeMeta enum: - outcomeMeta description: Request type to retrieve HIP-4 outcome market metadata required: - type responses: '200': description: Live HIP-4 outcome markets and categorical questions content: application/json: schema: type: object properties: outcomes: type: array description: Array of live outcome markets items: type: object properties: outcome: type: integer description: Outcome id; combine with side index to derive the asset encoding name: type: string description: Human-readable market name description: type: string description: For recurring binary markets, a pipe-separated key:value string (class, underlying, expiry, targetPrice, period). For other market types, free-form text. sideSpecs: type: array description: Two-element array describing the YES (index 0) and NO (index 1) sides items: type: object properties: name: type: string description: Side name (for example, 'Yes' or 'No') questions: type: array description: Array of categorical multi-outcome questions; mainnet returns an empty array at the time of writing items: type: object properties: question: type: integer description: Question id name: type: string description: Question text description: type: string description: Free-form description fallbackOutcome: type: integer description: Outcome id used if none of the named outcomes matches namedOutcomes: type: array description: Outcome ids for the named legs items: type: integer settledNamedOutcomes: type: array description: Outcome ids that have already settled items: type: integer example: outcomes: - outcome: 1 name: Recurring description: class:priceBinary|underlying:BTC|expiry:20260504-0600|targetPrice:78213|period:1d sideSpecs: - name: 'Yes' - name: 'No' questions: [] /info_perp_annotation: post: tags: - General summary: info (perpAnnotation) operationId: infoPerpAnnotation requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: Request type default: perpAnnotation enum: - perpAnnotation coin: type: string description: HIP-3 asset symbol in deployer:TICKER format (e.g., "xyz:GOLD"). Native perps like "BTC" always return null. default: xyz:GOLD required: - type - coin responses: '200': description: Annotation metadata for the perpetual or null content: application/json: schema: nullable: true type: object properties: category: type: string description: Category label, at most 15 characters description: type: string description: Description text, at most 400 characters /info_perp_categories: post: tags: - General summary: info (perpCategories) operationId: infoPerpCategories requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: Request type default: perpCategories enum: - perpCategories required: - type responses: '200': description: Array of perpetual category classifications content: application/json: schema: type: array items: type: array items: type: string description: Two-element array of [coin, category] /info_perp_dex_limits: post: tags: - General summary: info (perpDexLimits) operationId: infoPerpDexLimits requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: Request type default: perpDexLimits enum: - perpDexLimits required: - type responses: '200': description: Perp DEX limit configuration content: application/json: schema: type: object /info_perp_dex_status: post: tags: - General summary: info (perpDexStatus) operationId: infoPerpDexStatus requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: Request type default: perpDexStatus enum: - perpDexStatus dex: type: string description: Perp DEX name default: xyz required: - type - dex responses: '200': description: Status of the specified perp DEX content: application/json: schema: type: object /info_perpdeployauctionstatus: post: tags: - General summary: info (perpDeployAuctionStatus) operationId: infoPerpDeployAuctionStatus requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: perpDeployAuctionStatus enum: - perpDeployAuctionStatus description: Request type to retrieve perpetual deployment auction status required: - type responses: '200': description: Current status of perpetual deployment auctions content: application/json: schema: type: object description: Perpetual deployment auction timing and gas information properties: startTimeSeconds: type: integer description: Auction start time in seconds since epoch durationSeconds: type: integer description: Duration of the auction in seconds startGas: type: string description: Starting gas amount for the auction currentGas: type: string description: Current gas amount endGas: type: string nullable: true description: Ending gas amount (null if auction is ongoing) required: - startTimeSeconds - durationSeconds - startGas - currentGas - endGas example: startTimeSeconds: 1747656000 durationSeconds: 111600 startGas: '500.0' currentGas: '500.0' endGas: null /info_perpdexs: post: tags: - General summary: info (perpDexs) operationId: infoPerpDexs requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: perpDexs enum: - perpDexs description: Request type to retrieve available perpetual DEXs information required: - type responses: '200': description: List of available perpetual DEXs and their configurations content: application/json: schema: type: array description: List of perpetual DEXs. The first element is null to represent the default DEX. items: type: object nullable: true properties: name: type: string description: Short name of the perpetual DEX full_name: type: string description: Full descriptive name of the DEX deployer: type: string description: Address of the DEX deployer (42-char hex) oracle_updater: type: string nullable: true description: Address responsible for oracle updates, or null if not applicable example: - null - name: test full_name: test dex deployer: '0x5e89b26d8d66da9888c835c9bfcc2aa51813e152' oracle_updater: null /info_perps_at_open_interest_cap: post: tags: - General summary: info (perpsAtOpenInterestCap) operationId: infoPerpsAtOpenInterestCap requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: perpsAtOpenInterestCap enum: - perpsAtOpenInterestCap description: Request type to retrieve perpetuals at open interest cap required: - type responses: '200': description: List of perpetual contracts currently at their open interest cap content: application/json: schema: type: array description: Array of perpetual contract symbols that have reached their open interest limit items: type: string description: Symbol of the perpetual contract at open interest cap example: - BADGER - CANTO - FTM - LOOM - PURR /info_portfolio: post: summary: Query a user's portfolio description: Retrieve comprehensive portfolio performance data for a specific user across different time periods, including account value history, PnL history, and volume metrics. requestBody: required: true content: application/json: schema: type: object required: - type - user properties: type: type: string enum: - portfolio default: portfolio description: The request type. Must be 'portfolio' to retrieve portfolio data. user: type: string pattern: ^0x[a-fA-F0-9]{40}$ default: '0x31ca8395cf837de08b24da3f660e77761dfb974b' description: Address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000. example: type: portfolio user: '0x31ca8395cf837de08b24da3f660e77761dfb974b' responses: '200': description: Successful response with portfolio data content: application/json: schema: type: array description: Array of portfolio performance data across different time periods items: type: array description: Tuple containing period name and performance data minItems: 2 maxItems: 2 example: - - day - accountValueHistory: - - 1741886630493 - '0.0' - - 1741895270493 - '0.0' pnlHistory: - - 1741886630493 - '0.0' - - 1741895270493 - '0.0' vlm: '0.0' - - week - accountValueHistory: - - 1741886630493 - '0.0' pnlHistory: - - 1741886630493 - '0.0' vlm: '0.0' - - month - accountValueHistory: - - 1741886630493 - '0.0' pnlHistory: - - 1741886630493 - '0.0' vlm: '0.0' - - allTime - accountValueHistory: - - 1741886630493 - '0.0' pnlHistory: - - 1741886630493 - '0.0' vlm: '0.0' - - perpDay - accountValueHistory: - - 1741886630493 - '0.0' pnlHistory: - - 1741886630493 - '0.0' vlm: '0.0' - - perpWeek - accountValueHistory: - - 1741886630493 - '0.0' pnlHistory: - - 1741886630493 - '0.0' vlm: '0.0' - - perpMonth - accountValueHistory: - - 1741886630493 - '0.0' pnlHistory: - - 1741886630493 - '0.0' vlm: '0.0' - - perpAllTime - accountValueHistory: - - 1741886630493 - '0.0' pnlHistory: - - 1741886630493 - '0.0' vlm: '0.0' tags: - General operationId: info_portfolio /info_predicted_fundings: post: tags: - General summary: info (predictedFundings) operationId: infoPredictedFundings description: Retrieve predicted funding rates for all perpetual contracts across different exchanges, providing insight into upcoming funding costs and cross-exchange arbitrage opportunities. requestBody: required: true content: application/json: schema: type: object required: - type properties: type: type: string default: predictedFundings description: The request type for predicted funding rates example: type: predictedFundings responses: '200': description: Successfully retrieved predicted funding rates for all assets across exchanges content: application/json: schema: type: array description: Array of asset funding predictions containing rates across different perpetual exchanges example: - - BTC - - - BinPerp - fundingRate: '0.00008786' nextFundingTime: 1754496000000 - - HlPerp - fundingRate: '0.0000125' nextFundingTime: 1754470800000 - - BybitPerp - fundingRate: '0.0001' nextFundingTime: 1754496000000 - - ETH - - - BinPerp - fundingRate: '0.00008147' nextFundingTime: 1754496000000 - - HlPerp - fundingRate: '0.0000104019' nextFundingTime: 1754470800000 - - BybitPerp - fundingRate: '0.0001' nextFundingTime: 1754496000000 /info_recent_trades: post: summary: Retrieve recent trades description: Retrieve the most recent public trades for a specific asset. This endpoint provides real-time trade data including price, size, and timing information for market analysis. requestBody: required: true content: application/json: schema: type: object required: - type - coin properties: type: type: string enum: - recentTrades default: recentTrades description: The request type. Must be 'recentTrades' to retrieve recent trades. coin: type: string default: BTC description: Asset identifier (simple names like 'BTC', 'ETH' for perpetuals; spot format like '@107' for spot trades) example: type: recentTrades coin: BTC responses: '200': description: Successful response with recent trades data content: application/json: schema: type: array items: type: object properties: px: type: string description: Trade price as a string for precision sz: type: string description: Trade size (quantity traded) side: type: string enum: - A - B description: 'Trade side: ''A'' for Ask/Sell, ''B'' for Bid/Buy' time: type: integer format: int64 description: Trade timestamp in milliseconds tid: type: integer format: int64 description: Unique trade ID required: - px - sz - side - time - tid example: - px: '43250.5' sz: '0.1234' side: B time: 1681924499999 tid: 118906512037719 - px: '43248.0' sz: '0.5678' side: A time: 1681924489999 tid: 118906512037718 tags: - General operationId: info_recent_trades /info_referral: post: summary: Query a user's referral information description: Retrieve comprehensive referral information for a specific user, including referrer details, referral rewards, volume metrics, and referrer state with referred users data. requestBody: required: true content: application/json: schema: type: object required: - type - user properties: type: type: string enum: - referral default: referral description: The request type. Must be 'referral' to retrieve referral information. user: type: string pattern: ^0x[a-fA-F0-9]{40}$ default: '0x1442ad477ded1b0028b57621aa7b6f7eadb8f568' description: Address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000. example: type: referral user: '0x1442ad477ded1b0028b57621aa7b6f7eadb8f568' responses: '200': description: Successful response with referral information content: application/json: schema: type: object properties: referredBy: type: object description: Information about who referred this user properties: referrer: type: string description: Address of the user who made the referral code: type: string description: Referral code used cumVlm: type: string description: Cumulative volume traded by this user unclaimedRewards: type: string description: Amount of unclaimed referral rewards claimedRewards: type: string description: Amount of claimed referral rewards builderRewards: type: string description: Builder rewards earned referrerState: type: object description: State information if this user is a referrer properties: stage: type: string description: Current stage of the referrer (e.g., 'ready') data: type: object properties: code: type: string description: This user's referral code referralStates: type: array description: List of users referred by this user items: type: object properties: cumVlm: type: string description: Cumulative volume traded by the referred user cumRewardedFeesSinceReferred: type: string description: Total fees that generated rewards since referral cumFeesRewardedToReferrer: type: string description: Total fees rewarded to the referrer from this user timeJoined: type: integer format: int64 description: Timestamp when the user joined via referral user: type: string description: Address of the referred user rewardHistory: type: array description: Legacy reward history (now returned in nonFundingLedgerUpdate) example: referredBy: referrer: '0x5ac99df645f3414876c816caa18b2d234024b487' code: TESTNET cumVlm: '149428030.6628420055' unclaimedRewards: '11.047361' claimedRewards: '22.743781' builderRewards: '0.027802' referrerState: stage: ready data: code: TEST referralStates: - cumVlm: '960652.017122' cumRewardedFeesSinceReferred: '196.838825' cumFeesRewardedToReferrer: '19.683748' timeJoined: 1679425029416 user: '0x11af2b93dcb3568b7bf2b6bd6182d260a9495728' - cumVlm: '438278.672653' cumRewardedFeesSinceReferred: '97.628107' cumFeesRewardedToReferrer: '9.762562' timeJoined: 1679423947882 user: '0x3f69d170055913103a034a418953b8695e4e42fa' rewardHistory: [] tags: - General operationId: info_referral /info_spot_meta_and_asset_ctxs: post: tags: - General summary: info (spotMetaAndAssetCtxs) operationId: infoSpotMetaAndAssetCtxs description: Retrieve comprehensive spot market metadata and asset contexts, including token details, trading pairs, market prices, volumes, and circulating supply information for all spot assets on Hyperliquid. requestBody: required: true content: application/json: schema: type: object required: - type properties: type: type: string default: spotMetaAndAssetCtxs description: The request type for spot market metadata and asset contexts example: type: spotMetaAndAssetCtxs responses: '200': description: Successfully retrieved spot market metadata and asset contexts content: application/json: schema: type: array description: Array containing spot token metadata and market contexts example: - - name: PURR szDecimals: 1 weiDecimals: 6 index: 0 tokenId: '0x00000000000000000000000000000000' isCanonical: true evmContract: null fullName: Hypurrfun deployerTradingFeeShare: '0.0' - name: HYPE szDecimals: 2 weiDecimals: 8 index: 150 tokenId: '0x0d01dc56dcaaca66ad901c959b4011ec' isCanonical: false evmContract: null fullName: Hyperliquid deployerTradingFeeShare: '0.0' - - prevDayPx: '0.15719' dayNtlVlm: '3558163.5799899995' markPx: '0.14967' midPx: '0.14966' circulatingSupply: '596449455.7842600346' coin: PURR/USDC totalSupply: '596449462.3070399761' dayBaseVlm: '22964913.0' - prevDayPx: '1.0011' dayNtlVlm: '1607716.7693469997' markPx: '1.0006' midPx: '1.00065' circulatingSupply: '99999929715.1255493164' coin: '@150' totalSupply: '99999929715.1255493164' dayBaseVlm: '1606605.0899999994' /info_spot_pair_deploy_auction_status: post: tags: - General summary: info (spotPairDeployAuctionStatus) operationId: infoSpotPairDeployAuctionStatus requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: Request type default: spotPairDeployAuctionStatus enum: - spotPairDeployAuctionStatus required: - type responses: '200': description: Current spot pair deployment auction status content: application/json: schema: type: object /info_spotclearinghousestate: post: tags: - General summary: info (spotClearinghouseState) operationId: infoSpotClearinghouseState requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: spotClearinghouseState enum: - spotClearinghouseState description: Request type to retrieve user's spot token balances user: type: string default: '0x2ba553d9f990a3b66b03b2dc0d030dfc1c061036' description: Onchain address in 42-character hexadecimal format required: - type - user responses: '200': description: User's spot token balances content: application/json: schema: type: object properties: balances: type: array description: Array of user's spot token balances items: type: object properties: coin: type: string description: Token symbol (e.g., 'USDC', 'PURR') token: type: integer description: Token index identifier hold: type: string description: Amount on hold (locked in open orders) total: type: string description: Total balance including held amount entryNtl: type: string description: Entry notional value required: - coin - token - hold - total - entryNtl required: - balances /info_spotdeploystate: post: tags: - General summary: info (spotDeployState) operationId: infoSpotDeployState requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: spotDeployState enum: - spotDeployState description: Request type to retrieve spot token deployment state information user: type: string default: '0x0000000000000000000000000000000000000000' description: Address in 42-character hexadecimal format (can be zero address for global state) required: - type - user responses: '200': description: Spot token deployment state and configuration information content: application/json: schema: type: object description: Current state of spot token deployment system properties: deploymentEnabled: type: boolean description: Whether new spot token deployments are currently enabled totalDeployments: type: integer description: Total number of tokens deployed on the spot system deploymentCost: type: string description: Cost to deploy a new spot token (in USD) maxSupply: type: string description: Maximum token supply allowed for new deployments minSupply: type: string description: Minimum token supply required for new deployments deploymentQueue: type: array description: Queue of pending token deployments items: type: object properties: deployer: type: string description: Address of the token deployer tokenName: type: string description: Name of the token to be deployed tokenSymbol: type: string description: Symbol of the token to be deployed supply: type: string description: Initial supply of the token queuePosition: type: integer description: Position in the deployment queue estimatedDeployTime: type: integer description: Estimated deployment timestamp in milliseconds recentDeployments: type: array description: Recently deployed tokens items: type: object properties: tokenAddress: type: string description: Contract address of the deployed token tokenName: type: string description: Name of the deployed token tokenSymbol: type: string description: Symbol of the deployed token deployer: type: string description: Address of the token deployer deployTime: type: integer description: Deployment timestamp in milliseconds initialSupply: type: string description: Initial supply of the deployed token systemStatus: type: string description: Current status of the deployment system (e.g., 'active', 'maintenance', 'paused') /info_spotmeta: post: tags: - General summary: info (spotMeta) operationId: infoSpotMeta requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: spotMeta enum: - spotMeta required: - type responses: '200': description: Spot metadata including tokens and universe content: application/json: schema: type: object properties: tokens: type: array description: Array of spot tokens with their metadata items: type: object properties: name: type: string description: Token name szDecimals: type: integer description: Number of decimal places for size weiDecimals: type: integer description: Number of decimal places for wei representation index: type: integer description: Token index tokenId: type: string description: Unique token identifier isCanonical: type: boolean description: Whether the token is canonical evmContract: type: object nullable: true description: EVM contract metadata if token has an L1 contract properties: address: type: string description: Contract address evm_extra_wei_decimals: type: integer description: Extra wei decimals adjustment; may be negative fullName: type: string nullable: true description: Full descriptive token name deployerTradingFeeShare: type: string description: Deployer trading fee share universe: type: array description: Array of spot trading pairs items: type: object properties: name: type: string description: Trading pair name tokens: type: array description: Array of token indices for the pair items: type: integer index: type: integer description: Pair index isCanonical: type: boolean description: Whether the pair is canonical /info_subaccounts: post: tags: - General summary: info (subAccounts) operationId: infoSubAccounts requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: subAccounts enum: - subAccounts description: Request type to retrieve sub-accounts associated with a user user: type: string default: '0x2ba553d9f990a3b66b03b2dc0d030dfc1c061036' description: Address in 42-character hexadecimal format required: - type - user responses: '200': description: List of sub-accounts associated with the user content: application/json: schema: type: array description: List of sub-account details and their configurations items: type: object properties: subAccountUser: type: string description: Address of the sub-account in 42-character hexadecimal format name: type: string description: Human-readable name assigned to the sub-account master: type: string description: Address of the master account (should match the requested user) clearinghouseState: type: object description: Current perpetuals trading state of the sub-account properties: marginSummary: type: object properties: accountValue: type: string totalNtlPos: type: string totalRawUsd: type: string totalMarginUsed: type: string crossMarginSummary: type: object properties: accountValue: type: string totalNtlPos: type: string totalRawUsd: type: string totalMarginUsed: type: string crossMaintenanceMarginUsed: type: string withdrawable: type: string assetPositions: type: array items: type: object time: type: integer description: Snapshot timestamp (ms) spotState: type: object description: Current spot trading state of the sub-account properties: balances: type: array items: type: object properties: coin: type: string token: type: integer total: type: string hold: type: string entryNtl: type: string required: - subAccountUser - master /info_token_details: post: tags: - General summary: info (tokenDetails) operationId: infoTokenDetails description: Retrieve comprehensive details for a specific token including supply metrics, pricing data, deployment information, and circulation details on the Hyperliquid exchange. requestBody: required: true content: application/json: schema: type: object required: - type - tokenId properties: type: type: string default: tokenDetails description: The request type for token details tokenId: type: string default: '0x6d1e7cde53ba9467b783cb7c530ce054' description: The hexadecimal token identifier to retrieve details for example: type: tokenDetails tokenId: '0x6d1e7cde53ba9467b783cb7c530ce054' responses: '200': description: Successfully retrieved token details content: application/json: schema: type: object description: Comprehensive token information including supply, pricing, and deployment data example: name: USDC maxSupply: '1000000000000.0' totalSupply: '4352925534.7421636581' circulatingSupply: '4352925534.7421636581' szDecimals: 8 weiDecimals: 0 midPx: '1.0' markPx: '1.0' prevDayPx: '1.0' genesis: null deployer: null deployGas: null deployTime: null seededUsdc: '0.0' nonCirculatingUserBalances: [] futureEmissions: '0.0' /info_user_abstraction: post: tags: - General summary: info (userAbstraction) operationId: infoUserAbstraction requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: Request type default: userAbstraction enum: - userAbstraction user: type: string description: Onchain address in 42-character hexadecimal format default: '0x31ca8395cf837de08b24da3f660e77761dfb974b' required: - type - user responses: '200': description: User's abstraction setting content: application/json: schema: type: object /info_user_dex_abstraction: post: tags: - General summary: info (userDexAbstraction) operationId: infoUserDexAbstraction requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: Request type default: userDexAbstraction enum: - userDexAbstraction user: type: string description: Onchain address in 42-character hexadecimal format default: '0x31ca8395cf837de08b24da3f660e77761dfb974b' required: - type - user responses: '200': description: User's DEX abstraction setting or null content: application/json: schema: type: object /info_user_fills: post: tags: - General summary: info (userFills) operationId: infoUserFills description: Returns at most 2000 most recent fills for a specified user address requestBody: required: true content: application/json: schema: type: object required: - type - user properties: type: type: string enum: - userFills default: userFills description: The request type. Must be "userFills" to retrieve user fills. user: type: string pattern: ^0x[a-fA-F0-9]{40}$ default: '0x31ca8395cf837de08b24da3f660e77761dfb974b' description: Address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000. aggregateByTime: type: boolean description: When true, partial fills are combined when a crossing order gets filled by multiple different resting orders. Resting orders filled by multiple crossing orders will not be aggregated. example: type: userFills user: '0x31ca8395cf837de08b24da3f660e77761dfb974b' responses: '200': description: Successful response with user fills data content: application/json: schema: type: array items: type: object properties: closedPnl: type: string description: Closed profit and loss for the fill coin: type: string description: Asset symbol (e.g., 'BTC', 'ETH') for perpetuals or spot format (e.g., '@107') for spot trades crossed: type: boolean description: Whether this was a crossing order dir: type: string description: Direction of the trade (e.g., 'Open Long', 'Close Short', 'Buy', 'Sell') hash: type: string description: Transaction hash oid: type: integer description: Order ID px: type: string description: Fill price side: type: string enum: - A - B description: 'Side of the trade: ''A'' for Ask/Sell, ''B'' for Bid/Buy' startPosition: type: string description: Position size before this fill sz: type: string description: Fill size time: type: integer description: Fill timestamp in milliseconds fee: type: string description: Trading fee paid feeToken: type: string description: Token used to pay the fee (typically 'USDC') builderFee: type: string description: Builder fee (optional, only present if non-zero) tid: type: integer description: Trade ID examples: perpFill: summary: Perpetual fill example value: - closedPnl: '0.0' coin: AVAX crossed: false dir: Open Long hash: '0xa166e3fa63c25663024b03f2e0da011a00307e4017465df020210d3d432e7cb8' oid: 90542681 px: '18.435' side: B startPosition: '26.86' sz: '93.53' time: 1681222254710 fee: '0.01' feeToken: USDC builderFee: '0.01' tid: 118906512037719 spotFill: summary: Spot fill example value: - coin: '@107' px: '18.62041381' sz: '43.84' side: A time: 1735969713869 startPosition: '10659.65434798' dir: Sell closedPnl: '8722.988077' hash: '0x2222138cc516e3fe746c0411dd733f02e60086f43205af2ae37c93f6a792430b' oid: 59071663721 crossed: true fee: '0.304521' tid: 907359904431134 feeToken: USDC /info_user_fills_by_time: post: tags: - General summary: info (userFillsByTime) operationId: infoUserFillsByTime description: Returns at most 2000 fills per response and only the 10000 most recent fills are available requestBody: required: true content: application/json: schema: type: object required: - type - user - startTime properties: type: type: string enum: - userFillsByTime default: userFillsByTime description: The request type. Must be "userFillsByTime" to retrieve user fills by time range. user: type: string pattern: ^0x[a-fA-F0-9]{40}$ default: '0x31ca8395cf837de08b24da3f660e77761dfb974b' description: Address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000. startTime: type: integer default: 1754380000000 description: Start time in milliseconds, inclusive endTime: type: integer default: 1754380200000 description: End time in milliseconds, inclusive. Defaults to current time. aggregateByTime: type: boolean description: When true, partial fills are combined when a crossing order gets filled by multiple different resting orders. Resting orders filled by multiple crossing orders will not be aggregated. example: type: userFillsByTime user: '0x31ca8395cf837de08b24da3f660e77761dfb974b' startTime: 1754380000000 endTime: 1754380200000 responses: '200': description: Successful response with user fills data within the specified time range content: application/json: schema: type: array items: type: object properties: closedPnl: type: string description: Closed profit and loss for the fill coin: type: string description: Asset symbol (e.g., 'BTC', 'ETH') for perpetuals or spot format (e.g., '@107') for spot trades crossed: type: boolean description: Whether this was a crossing order dir: type: string description: Direction of the trade (e.g., 'Open Long', 'Close Short', 'Buy', 'Sell') hash: type: string description: Transaction hash oid: type: integer description: Order ID px: type: string description: Fill price side: type: string enum: - A - B description: 'Side of the trade: ''A'' for Ask/Sell, ''B'' for Bid/Buy' startPosition: type: string description: Position size before this fill sz: type: string description: Fill size time: type: integer description: Fill timestamp in milliseconds fee: type: string description: Trading fee paid feeToken: type: string description: Token used to pay the fee (typically 'USDC') builderFee: type: string description: Builder fee (optional, only present if non-zero) tid: type: integer description: Trade ID examples: perpFill: summary: Perpetual fill example value: - closedPnl: '0.0' coin: AVAX crossed: false dir: Open Long hash: '0xa166e3fa63c25663024b03f2e0da011a00307e4017465df020210d3d432e7cb8' oid: 90542681 px: '18.435' side: B startPosition: '26.86' sz: '93.53' time: 1681222254710 fee: '0.01' feeToken: USDC builderFee: '0.01' tid: 118906512037719 spotFill: summary: Spot fill example value: - coin: '@107' px: '18.62041381' sz: '43.84' side: A time: 1735969713869 startPosition: '10659.65434798' dir: Sell closedPnl: '8722.988077' hash: '0x2222138cc516e3fe746c0411dd733f02e60086f43205af2ae37c93f6a792430b' oid: 59071663721 crossed: true fee: '0.304521' tid: 907359904431134 feeToken: USDC /info_user_funding: post: tags: - General summary: info (userFunding) operationId: infoUserFunding description: Retrieve funding history for a specific user account, including funding payments and receipts across all perpetual positions over time. requestBody: required: true content: application/json: schema: type: object required: - type - user - startTime properties: type: type: string enum: - userFunding default: userFunding description: The request type. Must be 'userFunding' to retrieve user funding history. user: type: string default: '0x2ba553d9f990a3b66b03b2dc0d030dfc1c061036' description: User wallet address (0x...) startTime: type: integer default: 1681923833000 description: Start time in milliseconds, inclusive endTime: type: integer description: End time in milliseconds, inclusive. Defaults to current time. example: type: userFunding user: '0x2ba553d9f990a3b66b03b2dc0d030dfc1c061036' startTime: 1681923833000 endTime: 1681924833000 responses: '200': description: User funding history data content: application/json: schema: type: array description: Array of funding events for the user example: - time: 1732233600000 hash: '0x0000000000000000000000000000000000000000000000000000000000000000' delta: type: funding coin: BTC usdc: '-2851.187296' szi: '45.0' fundingRate: '0.00005566' - time: 1732320000000 hash: '0x0000000000000000000000000000000000000000000000000000000000000000' delta: type: funding coin: ETH usdc: '-7267.176499' szi: '1300.0' fundingRate: '0.00006885' /info_user_non_funding_ledger_updates: post: tags: - General summary: info (userNonFundingLedgerUpdates) operationId: infoUserNonFundingLedgerUpdates description: Retrieve non-funding ledger updates for a specific user account, including deposits, withdrawals, transfers, liquidations, and other account activities excluding funding payments. requestBody: required: true content: application/json: schema: type: object required: - type - user - startTime properties: type: type: string enum: - userNonFundingLedgerUpdates default: userNonFundingLedgerUpdates description: The request type. Must be 'userNonFundingLedgerUpdates' to retrieve user ledger updates. user: type: string default: '0x2ba553d9f990a3b66b03b2dc0d030dfc1c061036' description: User wallet address (0x...) startTime: type: integer default: 1681923833000 description: Start time in milliseconds, inclusive endTime: type: integer description: End time in milliseconds, inclusive. Defaults to current time. example: type: userNonFundingLedgerUpdates user: '0x2ba553d9f990a3b66b03b2dc0d030dfc1c061036' startTime: 1681923833000 endTime: 1681924833000 responses: '200': description: User non-funding ledger updates data content: application/json: schema: type: array description: Array of ledger update events for the user example: - time: 1731999196516 hash: '0x09ddd9f712b5df0945af34b055bbb3329c88ca001aff41bbfd4341d80bc760ce' delta: type: deposit usdc: '2703997.4500000002' - time: 1732834706761 hash: '0x1ddfe341d6a65a05392a0417f410fd014100a311417ccf11da13fcddea1429c9' delta: type: accountClassTransfer usdc: '12.0' toPerp: false - time: 1732834825313 hash: '0x2ceac78e94d15a1af8660417f418400175003b84f5f2d86615b352360e4d48ac' delta: type: spotTransfer token: USDC amount: '10.5' usdcValue: '10.5' user: '0x2ba553d9f990a3b66b03b2dc0d030dfc1c061036' destination: '0xaaa0c2769cb990f4f37db951a9e48de2385c2733' fee: '1.0' nativeTokenFee: '0.0' nonce: null /info_user_role: post: tags: - General summary: info (userRole) operationId: infoUserRole requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: userRole enum: - userRole description: Request type to retrieve user's role information user: type: string default: '0x31ca8395cf837de08b24da3f660e77761dfb974b' description: User address in 42-character hexadecimal format required: - type - user responses: '200': description: User's role information and associated data content: application/json: schema: oneOf: - type: object description: Regular user role properties: role: type: string enum: - user description: User role type required: - role - type: object description: Agent role with associated user properties: role: type: string enum: - agent description: Agent role type data: type: object properties: user: type: string description: Address of the user this agent represents required: - user required: - role - data - type: object description: Vault role properties: role: type: string enum: - vault description: Vault role type required: - role - type: object description: Sub-account role with master account properties: role: type: string enum: - subAccount description: Sub-account role type data: type: object properties: master: type: string description: Address of the master account required: - master required: - role - data - type: object description: Missing or unrecognized role properties: role: type: string enum: - missing description: Missing role type required: - role /info_user_to_multi_sig_signers: post: tags: - General summary: info (userToMultiSigSigners) operationId: infoUserToMultiSigSigners requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: userToMultiSigSigners enum: - userToMultiSigSigners description: Request type to retrieve multi-signature signers for a user user: type: string default: '0x3710f20c8a8b2781D878105Fbd61CC0c20fE0411' description: User address in 42-character hexadecimal format required: - type - user responses: '200': description: Multi-signature signers associated with the user content: application/json: schema: type: array description: List of signer addresses associated with the user's multi-signature setup items: type: string description: Signer address in hexadecimal format /info_user_twap_slice_fills: post: summary: Retrieve a user's TWAP slice fills description: Retrieve the most recent TWAP (Time-Weighted Average Price) slice fills for a specific user. Returns at most 2000 most recent TWAP slice fills with detailed execution information. requestBody: required: true content: application/json: schema: type: object required: - type - user properties: type: type: string enum: - userTwapSliceFills default: userTwapSliceFills description: The request type. Must be 'userTwapSliceFills' to retrieve TWAP slice fills. user: type: string pattern: ^0x[a-fA-F0-9]{40}$ default: '0x31ca8395cf837de08b24da3f660e77761dfb974b' description: Address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000. example: type: userTwapSliceFills user: '0x31ca8395cf837de08b24da3f660e77761dfb974b' responses: '200': description: Successful response with TWAP slice fills data content: application/json: schema: type: array items: type: object properties: fill: type: object properties: closedPnl: type: string description: Realized profit/loss from this fill coin: type: string description: Asset identifier (simple names like 'BTC', 'ETH' for perpetuals; spot format like '@107' for spot trades) crossed: type: boolean description: Boolean indicating if this was a crossing order dir: type: string description: Trade direction (e.g., 'Open Long', 'Close Short', 'Buy', 'Sell') hash: type: string description: Transaction hash (TWAP fills have a hash of 0x0000000000000000000000000000000000000000000000000000000000000000) oid: type: integer format: int64 description: Order ID that generated this fill px: type: string description: Fill price as a string for precision side: type: string enum: - A - B description: 'Trade side: ''A'' for Ask/Sell, ''B'' for Bid/Buy' startPosition: type: string description: Position size before this fill sz: type: string description: Fill size (quantity traded) time: type: integer format: int64 description: Fill timestamp in milliseconds fee: type: string description: Trading fee paid for this fill feeToken: type: string description: Token used to pay the fee (typically 'USDC') tid: type: integer format: int64 description: Unique trade ID required: - closedPnl - coin - crossed - dir - hash - oid - px - side - startPosition - sz - time - fee - feeToken - tid twapId: type: integer format: int64 description: Unique identifier for the TWAP order that generated this slice fill required: - fill - twapId example: - fill: closedPnl: '0.0' coin: AVAX crossed: true dir: Open Long hash: '0x0000000000000000000000000000000000000000000000000000000000000000' oid: 90542681 px: '18.435' side: B startPosition: '26.86' sz: '93.53' time: 1681222254710 fee: '0.01' feeToken: USDC tid: 118906512037719 twapId: 3156 tags: - General operationId: info_user_twap_slice_fills /info_userfees: post: tags: - General summary: info (userFees) operationId: infoUserFees requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: userFees enum: - userFees description: Request type to retrieve user's fee structure and trading costs user: type: string default: '0x31ca8395cf837de08b24da3f660e77761dfb974b' description: Address in 42-character hexadecimal format required: - type - user responses: '200': description: User's fee structure and trading cost information content: application/json: schema: type: object description: User fee information including daily volumes, fee schedule, effective rates, discounts, and staking link properties: dailyUserVlm: type: array description: Array of daily volume data items: type: object properties: date: type: string description: YYYY-MM-DD userCross: type: string userAdd: type: string exchange: type: string feeSchedule: type: object properties: cross: type: string add: type: string spotCross: type: string spotAdd: type: string tiers: type: object properties: vip: type: array items: type: object properties: ntlCutoff: type: string cross: type: string add: type: string spotCross: type: string spotAdd: type: string mm: type: array items: type: object properties: makerFractionCutoff: type: string add: type: string referralDiscount: type: string stakingDiscountTiers: type: array items: type: object properties: bpsOfMaxSupply: type: string discount: type: string userCrossRate: type: string userAddRate: type: string userSpotCrossRate: type: string userSpotAddRate: type: string activeReferralDiscount: type: string trial: type: object nullable: true feeTrialReward: type: string nextTrialAvailableTimestamp: type: integer nullable: true stakingLink: type: object properties: type: type: string stakingUser: type: string activeStakingDiscount: type: object properties: bpsOfMaxSupply: type: string discount: type: string example: dailyUserVlm: - date: '2025-05-23' userCross: '0.0' userAdd: '0.0' exchange: '2852367.0770729999' feeSchedule: cross: '0.00045' add: '0.00015' spotCross: '0.0007' spotAdd: '0.0004' tiers: vip: - ntlCutoff: '5000000.0' cross: '0.0004' add: '0.00012' spotCross: '0.0006' spotAdd: '0.0003' mm: - makerFractionCutoff: '0.005' add: '-0.00001' referralDiscount: '0.04' stakingDiscountTiers: - bpsOfMaxSupply: '0.0001' discount: '0.05' userCrossRate: '0.000315' userAddRate: '0.000105' userSpotCrossRate: '0.00049' userSpotAddRate: '0.00028' activeReferralDiscount: '0.0' trial: null feeTrialReward: '0.0' nextTrialAvailableTimestamp: null stakingLink: type: tradingUser stakingUser: '0x54c049d9c7d3c92c2462bf3d28e083f3d6805061' activeStakingDiscount: bpsOfMaxSupply: '4.7577998927' discount: '0.3' /info_userratelimit: post: tags: - General summary: info (userRateLimit) operationId: infoUserRateLimit requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: userRateLimit enum: - userRateLimit description: Request type to retrieve user's API rate limit information user: type: string default: '0x31ca8395cf837de08b24da3f660e77761dfb974b' description: Address in 42-character hexadecimal format required: - type - user responses: '200': description: User's API rate limit information and current usage content: application/json: schema: type: object description: Rate limit usage summary properties: cumVlm: type: string nRequestsUsed: type: integer nRequestsCap: type: integer example: cumVlm: '2854574.593578' nRequestsUsed: 2890 nRequestsCap: 2864574 /info_uservaultequities: post: tags: - General summary: info (userVaultEquities) operationId: infoUserVaultEquities requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: userVaultEquities enum: - userVaultEquities description: Request type to retrieve user's vault equity positions user: type: string default: '0x2b804617c6f63c040377e95bb276811747006f4b' description: Address in 42-character hexadecimal format required: - type - user responses: '200': description: User's vault equity positions and investment details content: application/json: schema: type: array description: List of user's vault investments with equity details items: type: object properties: vaultAddress: type: string description: Contract address of the vault equity: type: string description: Current equity value of user's position (USD) required: - vaultAddress - equity example: - vaultAddress: '0xdfc24b077bc1425ad1dea75bcb6f8158e10df303' equity: '742500.082809' /info_validator_l1_votes: post: tags: - General summary: info (validatorL1Votes) operationId: infoValidatorL1Votes requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: validatorL1Votes enum: - validatorL1Votes description: Request type to retrieve validator L1 voting information required: - type responses: '200': description: Validator L1 voting information and consensus data content: application/json: schema: type: array description: List of validator L1 votes and consensus participation items: type: object properties: validator: type: string description: Validator address in hexadecimal format votingPower: type: string description: Validator's voting power in the consensus l1Votes: type: array description: List of L1 votes cast by the validator items: type: object properties: proposalId: type: string description: Unique identifier for the proposal vote: type: string enum: - 'yes' - 'no' - abstain description: Vote cast by the validator timestamp: type: integer description: Timestamp when the vote was cast blockHeight: type: integer description: Block height at which the vote was recorded participationRate: type: string description: Validator's participation rate in L1 governance /info_vault_details: post: summary: Retrieve vault details description: Retrieve detailed information about a specific vault including portfolio performance, followers, leader information, and vault configuration settings. requestBody: required: true content: application/json: schema: type: object required: - type - vaultAddress properties: type: type: string enum: - vaultDetails default: vaultDetails description: The request type. Must be 'vaultDetails' to retrieve vault details. vaultAddress: type: string pattern: ^0x[a-fA-F0-9]{40}$ default: '0xdfc24b077bc1425ad1dea75bcb6f8158e10df303' description: Address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000. user: type: string pattern: ^0x[a-fA-F0-9]{40}$ description: Optional user address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000. example: type: vaultDetails vaultAddress: '0xdfc24b077bc1425ad1dea75bcb6f8158e10df303' responses: '200': description: Successful response with vault details content: application/json: schema: type: object properties: name: type: string description: The name of the vault vaultAddress: type: string description: The vault's address leader: type: string description: Address of the vault leader description: type: string description: Description of the vault's strategy and purpose portfolio: type: array description: Portfolio performance data across different time periods apr: type: number description: Annual percentage return followerState: description: State information for followers, null if not applicable leaderFraction: type: number description: Fraction of the vault controlled by the leader leaderCommission: type: number description: Commission rate charged by the leader followers: type: array description: List of vault followers items: type: object properties: user: type: string description: Follower's address vaultEquity: type: string description: Follower's equity in the vault pnl: type: string description: Current profit and loss allTimePnl: type: string description: All-time profit and loss daysFollowing: type: integer description: Number of days following the vault vaultEntryTime: type: integer format: int64 description: Timestamp when the user entered the vault lockupUntil: type: integer format: int64 description: Timestamp until which funds are locked maxDistributable: type: number description: Maximum amount that can be distributed maxWithdrawable: type: number description: Maximum amount that can be withdrawn isClosed: type: boolean description: Whether the vault is closed to new deposits relationship: type: object description: Vault relationship information properties: type: type: string enum: - parent - child description: Type of relationship data: type: object properties: childAddresses: type: array items: type: string description: Array of child vault addresses (for parent vaults) parentAddress: type: string description: Parent vault address (for child vaults) allowDeposits: type: boolean description: Whether the vault allows new deposits alwaysCloseOnWithdraw: type: boolean description: Whether positions are always closed on withdrawal example: name: Test vaultAddress: '0xdfc24b077bc1425ad1dea75bcb6f8158e10df303' leader: '0x677d831aef5328190852e24f13c46cac05f984e7' description: This community-owned vault provides liquidity to Hyperliquid through multiple market making strategies, performs liquidations, and accrues platform fees. portfolio: - - day - accountValueHistory: - - 1734397526634 - '329265410.90790099' pnlHistory: - - 1734397526634 - '0.0' vlm: '0.0' apr: 0.36387129259090006 followerState: null leaderFraction: 0.0007904828725729887 leaderCommission: 0 followers: - user: '0x005844b2ffb2e122cf4244be7dbcb4f84924907c' vaultEquity: '714491.71026243' pnl: '3203.43026143' allTimePnl: '79843.74476743' daysFollowing: 388 vaultEntryTime: 1700926145201 lockupUntil: 1734824439201 maxDistributable: 94856870.164485 maxWithdrawable: 742557.680863 isClosed: false relationship: type: parent data: childAddresses: - '0x010461c14e146ac35fe42271bdc1134ee31c703a' - '0x2e3d94f0562703b25c83308a05046ddaf9a8dd14' - '0x31ca8395cf837de08b24da3f660e77761dfb974b' allowDeposits: true alwaysCloseOnWithdraw: false tags: - General operationId: info_vault_details /info_vaultsummaries: post: tags: - General summary: info (vaultSummaries) operationId: infoVaultSummaries requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: vaultSummaries enum: - vaultSummaries description: Request type to retrieve vault summaries for all available vaults required: - type responses: '200': description: Summary information for all available vaults content: application/json: schema: type: array description: List of vault summaries items: type: object properties: name: type: string description: Name of the vault vaultAddress: type: string description: Vault's blockchain address leader: type: string description: Address of the vault leader/manager tvl: type: string description: Total Value Locked in the vault isClosed: type: boolean description: Whether the vault is closed to new deposits relationship: type: object description: Vault relationship information properties: type: type: string enum: - normal - child - parent description: Type of vault relationship data: type: object properties: childAddresses: type: array items: type: string description: Addresses of child vaults (if parent vault) required: - type createTimeMillis: type: number description: Timestamp when vault was created (in milliseconds) required: - name - vaultAddress - leader - tvl - isClosed - relationship - createTimeMillis /info_web_data2: post: tags: - General summary: info (webData2) operationId: infoWebData2 requestBody: required: true content: application/json: schema: type: object properties: type: type: string default: webData2 enum: - webData2 description: Request type to retrieve web application data required: - type responses: '200': description: Web application data and interface configuration content: application/json: schema: type: object description: Comprehensive web application data for frontend interfaces properties: marketData: type: object description: Market information and trading data properties: markets: type: array description: List of available markets items: type: object properties: symbol: type: string description: Market symbol price: type: string description: Current market price volume24h: type: string description: 24-hour trading volume change24h: type: string description: 24-hour price change percentage totalVolume: type: string description: Total platform trading volume totalOpenInterest: type: string description: Total open interest across all markets networkStats: type: object description: Network statistics and health metrics properties: blockHeight: type: integer description: Current block height activeUsers: type: integer description: Number of active users totalTransactions: type: integer description: Total number of transactions uiConfig: type: object description: User interface configuration settings properties: features: type: array description: Enabled features for the web interface items: type: string maintenance: type: boolean description: Whether the platform is in maintenance mode /info_web_data3: post: tags: - General summary: info (webData3) operationId: infoWebData3 requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: Request type default: webData3 enum: - webData3 user: type: string description: Onchain address in 42-character hexadecimal format default: '0x31ca8395cf837de08b24da3f660e77761dfb974b' required: - type - user responses: '200': description: Comprehensive user state including account data and perp dex states content: application/json: schema: type: object /getAccountInfo: post: tags: - General summary: getAccountInfo operationId: getAccountInfo requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getAccountInfo params: type: array items: anyOf: - type: string description: The public key of the account default: 9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM - type: object properties: encoding: type: string default: jsonParsed commitment: type: string default: finalized default: - 9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM - encoding: jsonParsed commitment: finalized responses: '200': description: Account information content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /getBalance: post: tags: - General summary: getBalance operationId: getBalance requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getBalance params: type: array items: type: string description: The public key of the account default: 9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM default: - 9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM responses: '200': description: Account balance content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /getBlock: post: tags: - General summary: getBlock operationId: getBlock requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getBlock params: type: array items: oneOf: - type: integer description: The slot of the block default: 239462061 - type: object properties: encoding: type: string default: jsonParsed maxSupportedTransactionVersion: type: integer default: 0 default: - 239462061 - encoding: jsonParsed maxSupportedTransactionVersion: 0 responses: '200': description: Block details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /getBlockCommitment: post: tags: - General summary: getBlockCommitment operationId: getBlockCommitment requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getBlockCommitment params: type: array items: type: integer description: The slot of the block default: 166974442 default: - 166974442 responses: '200': description: Block commitment details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /getBlockHeight: post: tags: - General summary: getBlockHeight operationId: getBlockHeight requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getBlockHeight responses: '200': description: Block height content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: integer /getBlockProduction: post: tags: - General summary: getBlockProduction operationId: getBlockProduction requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getBlockProduction responses: '200': description: Block production details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /getBlockTime: post: tags: - General summary: getBlockTime operationId: getBlockTime requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getBlockTime params: type: array items: type: integer description: The slot of the block default: 166974442 default: - 166974442 responses: '200': description: Block time details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: integer /getBlocks: post: tags: - General summary: getBlocks operationId: getBlocks requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getBlocks params: type: array items: type: integer description: The start slot of the blocks default: 166974442 default: - 166974442 responses: '200': description: Blocks details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: integer /getBlocksWithLimit: post: tags: - General summary: getBlocksWithLimit operationId: getBlocksWithLimit requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getBlocksWithLimit params: type: array items: type: integer description: The start slot of the blocks and the maximum number of blocks default: 166974442 default: - 166974442 - 100 responses: '200': description: Blocks details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: integer /getClusterNodes: post: tags: - General summary: getClusterNodes operationId: getClusterNodes requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getClusterNodes responses: '200': description: Cluster nodes details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: object properties: pubkey: type: string gossip: type: string tpu: type: string rpc: type: string version: type: string /getEpochInfo: post: tags: - General summary: getEpochInfo operationId: getEpochInfo requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getEpochInfo responses: '200': description: Epoch info details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object properties: absoluteSlot: type: integer blockHeight: type: integer epoch: type: integer slotIndex: type: integer slotsInEpoch: type: integer /getEpochSchedule: post: tags: - General summary: getEpochSchedule operationId: getEpochSchedule requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getEpochSchedule responses: '200': description: Epoch schedule details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object properties: slotsPerEpoch: type: integer leaderScheduleSlotOffset: type: integer warmup: type: boolean firstNormalEpoch: type: integer firstNormalSlot: type: integer /getFeeForMessage: post: tags: - General summary: getFeeForMessage operationId: getFeeForMessage requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getFeeForMessage params: type: array items: anyOf: - type: string description: The serialized message default: AQABA36MCIdgv94d3c8ywX8gm4JC7lKq8TH6zYjQ6ixtCwbyhwEgP0xzGjSa7QhxjYGUHwUPDgYsz9S8Mb/9c7ejFiwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAIOnEi/spkCilDriqSI6o2AneB2xk65o4Xm9EM+yGyiPAQICAAEMAgAAAADKmjsAAAAA - type: object properties: commitment: type: string default: finalized default: - AQABA36MCIdgv94d3c8ywX8gm4JC7lKq8TH6zYjQ6ixtCwbyhwEgP0xzGjSa7QhxjYGUHwUPDgYsz9S8Mb/9c7ejFiwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAIOnEi/spkCilDriqSI6o2AneB2xk65o4Xm9EM+yGyiPAQICAAEMAgAAAADKmjsAAAAA - commitment: finalized responses: '200': description: Fee details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: integer /getFirstAvailableBlock: post: tags: - General summary: getFirstAvailableBlock operationId: getFirstAvailableBlock requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getFirstAvailableBlock params: type: array default: [] responses: '200': description: First available block details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: integer /getGenesisHash: post: tags: - General summary: getGenesisHash operationId: getGenesisHash requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getGenesisHash params: type: array default: [] responses: '200': description: Genesis hash details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string /getHealth: post: tags: - General summary: getHealth operationId: getHealth requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getHealth params: type: array default: [] responses: '200': description: Node health status content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string description: Returns 'ok' if the node is healthy /getHighestSnapshotSlot: post: tags: - General summary: getHighestSnapshotSlot operationId: getHighestSnapshotSlot requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getHighestSnapshotSlot params: type: array default: [] responses: '200': description: Highest snapshot slot details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: integer /getIdentity: post: tags: - General summary: getIdentity operationId: getIdentity requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getIdentity params: type: array default: [] responses: '200': description: Identity details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object properties: identity: type: string /getInflationGovernor: post: tags: - General summary: getInflationGovernor operationId: getInflationGovernor requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getInflationGovernor params: type: array default: [] responses: '200': description: Inflation governor details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object properties: foundation: type: number foundationTerm: type: number initial: type: number taper: type: number terminal: type: number /getInflationRate: post: tags: - General summary: getInflationRate operationId: getInflationRate requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getInflationRate params: type: array default: [] responses: '200': description: Inflation rate details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object properties: epoch: type: integer foundation: type: number total: type: number validator: type: number /getInflationReward: post: tags: - General summary: getInflationReward operationId: getInflationReward requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getInflationReward params: type: array default: - - 6D2jqw9hyVCpppZexquxa74Fn33rJzzBx38T58VucHx9 - epoch: 554 responses: '200': description: Inflation reward details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: object properties: epoch: type: integer effectiveSlot: type: integer amount: type: integer postBalance: type: integer /getLargestAccounts: post: tags: - General summary: getLargestAccounts operationId: getLargestAccounts requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getLargestAccounts params: type: array items: type: object properties: filter: type: string default: circulating responses: '200': description: Largest accounts details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: object properties: lamports: type: integer address: type: string /getLatestBlockhash: post: tags: - General summary: getLatestBlockhash operationId: getLatestBlockhash requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getLatestBlockhash params: type: array responses: '200': description: Latest blockhash details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object properties: blockhash: type: string feeCalculator: type: object properties: lamportsPerSignature: type: integer /getLeaderSchedule: post: tags: - General summary: getLeaderSchedule operationId: getLeaderSchedule requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getLeaderSchedule params: type: array responses: '200': description: Leader schedule details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object additionalProperties: type: array items: type: integer /getMaxRetransmitSlot: post: tags: - General summary: getMaxRetransmitSlot operationId: getMaxRetransmitSlot requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getMaxRetransmitSlot params: type: array responses: '200': description: Max retransmit slot details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: integer /getMaxShredInsertSlot: post: tags: - General summary: getMaxShredInsertSlot operationId: getMaxShredInsertSlot requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getMaxShredInsertSlot params: type: array responses: '200': description: Max shred insert slot details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: integer /getMinimumBalanceForRentExemption: post: tags: - General summary: getMinimumBalanceForRentExemption operationId: getMinimumBalanceForRentExemption requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getMinimumBalanceForRentExemption params: type: array items: type: integer default: - 50 responses: '200': description: Minimum balance for rent exemption details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: integer /getMultipleAccounts: post: tags: - General summary: getMultipleAccounts operationId: getMultipleAccounts requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getMultipleAccounts params: type: array default: - - 9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM - 7mhcgF1DVsj5iv4CxZDgp51H6MBBwqamsH1KnqXhSRc5 - encoding: base58 responses: '200': description: Multiple accounts details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: object /getProgramAccounts: post: tags: - General summary: getProgramAccounts operationId: getProgramAccounts requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getProgramAccounts params: type: array default: - FsJ3A3u2vn5cTVofAjvy6y5kwABJAqYWpe4975bi2epH - encoding: jsonParsed filters: [] description: Array containing the program public key (base-58 string) and an optional configuration object with encoding, filters, dataSlice, commitment, withContext, and minContextSlot fields. responses: '200': description: Program accounts details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: object /getRecentBlockhash: post: tags: - General summary: getRecentBlockhash operationId: getRecentBlockhash requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getRecentBlockhash responses: '200': description: Recent blockhash details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object properties: context: type: object properties: slot: type: integer value: type: object properties: blockhash: type: string feeCalculator: type: object properties: lamportsPerSignature: type: integer /getRecentPerformanceSamples: post: tags: - General summary: getRecentPerformanceSamples operationId: getRecentPerformanceSamples requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getRecentPerformanceSamples params: type: array default: - 5 responses: '200': description: Recent performance samples details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: object /getRecentPrioritizationFees: post: tags: - General summary: getRecentPrioritizationFees operationId: getRecentPrioritizationFees requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getRecentPrioritizationFees params: type: array default: - - CxELquR1gPP8wHe33gZ4QxqGB3sZ9RSwsJ2KshVewkFY responses: '200': description: Recent prioritization fees details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: object /getSignatureStatuses: post: tags: - General summary: getSignatureStatuses operationId: getSignatureStatuses requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getSignatureStatuses params: type: array default: - - 5VERv8NMvzbJMEkV8xnrLkEaWRtSz9CosKDYjCJjBRnbJLgp8uirBgmQpjKhoR4tjF3ZpRzrFmBV6UjKdiSZkQUW - searchTransactionHistory: true responses: '200': description: Signature statuses details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: object /getSignaturesForAddress: post: tags: - General summary: getSignaturesForAddress operationId: getSignaturesForAddress requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getSignaturesForAddress params: type: array default: - 9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM responses: '200': description: Signatures for address details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: object /getSlot: post: tags: - General summary: getSlot operationId: getSlot requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getSlot params: type: array default: [] responses: '200': description: Slot details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: integer /getSlotLeader: post: tags: - General summary: getSlotLeader operationId: getSlotLeader requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getSlotLeader params: type: array default: [] responses: '200': description: Slot leader details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string /getSlotLeaders: post: tags: - General summary: getSlotLeaders operationId: getSlotLeaders requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getSlotLeaders params: type: array default: - 100 - 10 responses: '200': description: Slot leaders content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array items: type: string /getStakeMinimumDelegation: post: tags: - General summary: getStakeMinimumDelegation operationId: getStakeMinimumDelegation requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getStakeMinimumDelegation params: type: array default: [] responses: '200': description: Minimum delegation details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: integer /getSupply: post: tags: - General summary: getSupply operationId: getSupply requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getSupply params: type: array default: [] responses: '200': description: Supply details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /getTokenAccountBalance: post: tags: - General summary: getTokenAccountBalance operationId: getTokenAccountBalance requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getTokenAccountBalance params: type: array default: - 3emsAVdmGKERbHjmGfQ6oZ1e35dkf5iYcS6U4CPKFVaa responses: '200': description: Token account balance details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /getTokenAccountsByDelegate: post: tags: - General summary: getTokenAccountsByDelegate operationId: getTokenAccountsByDelegate requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getTokenAccountsByDelegate params: type: array items: anyOf: - type: string description: Pubkey of the delegate to query, as base58 encoded string - type: object properties: mint: type: string description: Pubkey of the specific token mint to limit accounts to - type: object properties: encoding: type: string default: jsonParsed default: - 4Nd1mBQtrMJVYVfKf2PJy9NZUZdTAsp7D4xWLs4gDB4T - mint: EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v - encoding: jsonParsed responses: '200': description: Token accounts by delegate content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /getTokenAccountsByOwner: post: tags: - General summary: getTokenAccountsByOwner operationId: getTokenAccountsByOwner requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getTokenAccountsByOwner params: type: array default: - CEXq1uy9y15PL2Wb4vDQwQfcJakBGjaAjeuR2nKLj8dk - mint: 8wXtPeU6557ETkp9WHFY1n1EcU6NxDvbAggHGsMYiHsB - encoding: jsonParsed responses: '200': description: Token accounts by owner details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /getTokenLargestAccounts: post: tags: - General summary: getTokenLargestAccounts operationId: getTokenLargestAccounts requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getTokenLargestAccounts params: type: array default: - JUPyiwrYJFskUPiHa7hkeR8VUtAeFoSYbKedZNsDvCN responses: '200': description: Largest token accounts details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /getTokenSupply: post: tags: - General summary: getTokenSupply operationId: getTokenSupply requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getTokenSupply params: type: array default: - EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v responses: '200': description: Token supply details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /getTransaction: post: tags: - General summary: getTransaction operationId: getTransaction requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getTransaction params: type: array items: anyOf: - type: string description: Transaction signature default: 4VAGET7z5g7ogVGmbmZ6KBtF6DS8ftLWzD65BXZWQJjwASUqLod7LhGB6mqThcqo97QcC7r7uNmBY8GwsnLAA52n - type: object properties: encoding: type: string default: jsonParsed maxSupportedTransactionVersion: type: integer default: 0 default: - 4VAGET7z5g7ogVGmbmZ6KBtF6DS8ftLWzD65BXZWQJjwASUqLod7LhGB6mqThcqo97QcC7r7uNmBY8GwsnLAA52n - encoding: jsonParsed maxSupportedTransactionVersion: 0 responses: '200': description: Transaction details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /getTransactionCount: post: tags: - General summary: getTransactionCount operationId: getTransactionCount requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getTransactionCount params: type: array default: [] responses: '200': description: Transaction count content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: integer description: Total number of transactions processed /getVersion: post: tags: - General summary: getVersion operationId: getVersion requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getVersion params: type: array default: [] responses: '200': description: Version information content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /getVoteAccounts: post: tags: - General summary: getVoteAccounts operationId: getVoteAccounts requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: getVoteAccounts params: type: array default: [] responses: '200': description: Vote account information content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /isBlockhashValid: post: tags: - General summary: isBlockhashValid operationId: isBlockhashValid requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 45 jsonrpc: type: string default: '2.0' method: type: string default: isBlockhashValid params: type: array items: anyOf: - type: string description: The blockhash to validate, as a base-58 encoded string default: AspJzsEukGPuLYsebpUSSeS79GtYVVh6Bn4478qWXqBK - type: object properties: commitment: type: string default: processed default: - AspJzsEukGPuLYsebpUSSeS79GtYVVh6Bn4478qWXqBK - commitment: processed responses: '200': description: Blockhash validity status content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: boolean /minimumLedgerSlot: post: tags: - General summary: minimumLedgerSlot operationId: minimumLedgerSlot requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: minimumLedgerSlot params: type: array default: [] responses: '200': description: Minimum ledger slot content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: integer description: Minimum ledger slot number /sendTransaction: post: tags: - General summary: sendTransaction operationId: sendTransaction requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: sendTransaction params: type: array items: anyOf: - type: string description: Fully signed transaction, as an encoded string - type: object properties: encoding: type: string default: base64 skipPreflight: type: boolean default: false preflightCommitment: type: string default: finalized maxRetries: type: integer minContextSlot: type: integer default: - AQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAEDArczbMia1tLmq7zz4DinMNN0pJ1JtLdqIJPUw3YrGCzYAMHBsgN27lcgB6H2WQvFgyZuJYHa46puOQo9yQ8CVQbd9uHXZaGT2cvhRs7reawctIXtX1s3kTqM9YV+/wCp20C7Wj2aiuk5TReAXo+VTVg8QTHjs0UjNMMKCvpzZ+ABAgEBARU= - encoding: base64 skipPreflight: false preflightCommitment: finalized responses: '200': description: Transaction signature content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string description: First transaction signature embedded in the transaction (base58 encoded) /simulateTransaction: post: tags: - General summary: simulateTransaction operationId: simulateTransaction requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: simulateTransaction params: type: array items: anyOf: - type: string description: Transaction, as an encoded string - type: object properties: encoding: type: string default: base64 default: - AQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAEDArczbMia1tLmq7zz4DinMNN0pJ1JtLdqIJPUw3YrGCzYAMHBsgN27lcgB6H2WQvFgyZuJYHa46puOQo9yQ8CVQbd9uHXZaGT2cvhRs7reawctIXtX1s3kTqM9YV+/wCp20C7Wj2aiuk5TReAXo+VTVg8QTHjs0UjNMMKCvpzZ+ABAgEBARU= - encoding: base64 responses: '200': description: Simulated transaction details content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object /starknet_call: post: summary: Starknet_Call description: starknet_call operationId: starknetCall requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: starknet_call params: type: array items: anyOf: - type: object properties: calldata: type: array items: $ref: '#/components/schemas/FELT' default: - '0x03a20d4f7b4229e7c4863dab158b4d076d7f454b893d90a62011882dc4caca2a' contract_address: type: string default: '0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7' entry_point_selector: type: string default: '0x2e4263afad30923c891518314c3c95dbe830a16874e8abc5777a9a20b54c76e' - type: string enum: - pending default: - calldata: - '0x03a20d4f7b4229e7c4863dab158b4d076d7f454b893d90a62011882dc4caca2a' contract_address: '0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7' entry_point_selector: '0x2e4263afad30923c891518314c3c95dbe830a16874e8abc5777a9a20b54c76e' - pending responses: '200': description: Successful response tags: - General /starknet_estimateFee: post: summary: starknet_estimateFee description: starknet_estimateFee operationId: starknetEstimateFee requestBody: required: true content: application/json: schema: type: object properties: id: type: integer jsonrpc: type: string method: type: string params: type: object properties: request: type: array items: type: object properties: type: type: string max_fee: $ref: '#/components/schemas/FELT' version: type: string signature: type: array items: $ref: '#/components/schemas/FELT' sender_address: type: string calldata: type: array items: $ref: '#/components/schemas/FELT' nonce: $ref: '#/components/schemas/FELT' block_id: type: object properties: block_number: type: integer default: id: 0 jsonrpc: '2.0' method: starknet_estimateFee params: request: - type: INVOKE max_fee: '0xb3a2f1ab6d632' version: '0x1' signature: - '0x54c2201c7b9021777389e208e28eafc67e4ba1f1aa7016a1123b61c6ff79c29' - '0x58c2d97614e5abfd9668b314f344c945d16ea154cb32a7b08b4445204f1f1d3' sender_address: '0x0569b13e8164bc8000c0bbcf4887856516643af123c5bc3b01e229e92f9cfd10' calldata: - '0x3' - '0x49d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7' - '0x219209e083275171774dab1df80982e9df2096516f06319c5c6d71ae0a8480c' - '0x3' - '0xfff107e2403123c7df78d91728a7ee5cfd557aec0fa2d2bdc5891c286bbfff' - '0x984e103a8acd6' - '0x0' - '0x68f5c6a61780768455de69077e07e89787839bf8166decfbf92b645209c0fb8' - '0x219209e083275171774dab1df80982e9df2096516f06319c5c6d71ae0a8480c' - '0x3' - '0xfff107e2403123c7df78d91728a7ee5cfd557aec0fa2d2bdc5891c286bbfff' - '0x4c4b40' - '0x0' - '0xfff107e2403123c7df78d91728a7ee5cfd557aec0fa2d2bdc5891c286bbfff' - '0x2f0b3c5710379609eb5495f1ecd348cb28167711b73609fe565a72734550354' - '0xe' - '0x569b13e8164bc8000c0bbcf4887856516643af123c5bc3b01e229e92f9cfd10' - '0x49d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7' - '0x68f5c6a61780768455de69077e07e89787839bf8166decfbf92b645209c0fb8' - '0x1f4' - '0xa76cc' - '0xa7b5e' - '0x984e103a8acd6' - '0x0' - '0x4c4b40' - '0x0' - '0x9542431aa6bf1' - '0x0' - '0x4ac4a0' - '0x0' nonce: '0x51' block_id: block_number: 385940 responses: '200': description: Successful response tags: - General /starknet_estimateMessageFee: post: summary: starknet_estimateMessageFee description: starknet_estimateMessageFee operationId: starknetEstimateMessageFee requestBody: required: true content: application/json: schema: type: object properties: id: type: integer jsonrpc: type: string method: type: string params: type: array items: anyOf: - type: object properties: from_address: type: string to_address: type: string entry_point_selector: type: string payload: type: array items: $ref: '#/components/schemas/FELT' - type: object properties: block_number: type: integer default: id: 0 jsonrpc: '2.0' method: starknet_estimateMessageFee params: - from_address: '0xae0ee0a63a2ce6baeeffe56e7714fb4efe48d419' to_address: '0x073314940630fd6dcda0d772d4c972c4e0a9946bef9dabf4ef84eda8ef542b82' entry_point_selector: '0x02d757788a8d8d6f21d1cd40bce38a8222d70654214e96ff95d8086e684fbee5' payload: - '0x1cf4ca56a4841f8a7d39d22d5369434f74e480b370be7bc5a814384b758e604' - '0x6a94d74f430000' - '0x0' - block_number: 387702 responses: '200': description: Successful response tags: - General /starknet_getClassAt: post: summary: starknet_getClassAt description: starknet_getClassAt operationId: starknetGetClassAt requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: starknet_getClassAt params: type: array items: anyOf: - type: object properties: block_number: type: integer default: 385940 - type: string default: '0x073314940630fd6dcda0d772d4c972c4e0a9946bef9dabf4ef84eda8ef542b82' default: id: 1 jsonrpc: '2.0' method: starknet_getClassAt params: - block_number: 385940 - '0x073314940630fd6dcda0d772d4c972c4e0a9946bef9dabf4ef84eda8ef542b82' responses: '200': description: Successful response tags: - General /starknet_getClassHashAt: post: summary: starknet_getClassHashAt description: starknet_getClassHashAt operationId: starknetGetClassHashAt requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: starknet_getClassHashAt params: type: array items: anyOf: - type: object properties: block_number: type: integer default: 385940 - type: string default: '0x073314940630fd6dcda0d772d4c972c4e0a9946bef9dabf4ef84eda8ef542b82' default: id: 1 jsonrpc: '2.0' method: starknet_getClassHashAt params: - block_number: 385940 - '0x073314940630fd6dcda0d772d4c972c4e0a9946bef9dabf4ef84eda8ef542b82' responses: '200': description: Successful response tags: - General /starknet_getNonce: post: summary: starknet_getNonce description: starknet_getNonce operationId: starknetGetNonce requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: starknet_getNonce params: type: array items: anyOf: - type: object properties: block_number: type: integer default: 385940 - type: string default: '0x0569b13e8164bc8000c0bbcf4887856516643af123c5bc3b01e229e92f9cfd10' default: id: 1 jsonrpc: '2.0' method: starknet_getNonce params: - block_number: 385940 - '0x0569b13e8164bc8000c0bbcf4887856516643af123c5bc3b01e229e92f9cfd10' responses: '200': description: Successful response tags: - General /starknet_getStorageAt: post: summary: starknet_getStorageAt description: starknet_getStorageAt operationId: starknetGetStorageAt requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: starknet_getStorageAt params: type: array items: type: string default: - '0x00dA114221cb83fa859DBdb4C44bEeaa0BB37C7537ad5ae66Fe5e0efD20E6eB3' - '0x2de7ac669936cc3b4e9784ff23826dc9056c74d54d3f41f1b0d28b36966369e' - latest responses: '200': description: Successful response tags: - General /starknet_getTransactionByBlockIdAndIndex: post: summary: starknet_getTransactionByBlockIdAndIndex description: starknet_getTransactionByBlockIdAndIndex operationId: starknetGetTransactionByBlockIdAndIndex requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: starknet_getTransactionByBlockIdAndIndex params: type: array items: anyOf: - type: object properties: block_number: type: integer default: 7015 - type: integer default: 19 default: id: 1 jsonrpc: '2.0' method: starknet_getTransactionByBlockIdAndIndex params: - block_number: 7015 - 19 responses: '200': description: Successful response tags: - General /starknet_getTransactionByHash: post: summary: starknet_getTransactionByHash description: starknet_getTransactionByHash operationId: starknetGetTransactionByHash requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: starknet_getTransactionByHash params: type: array items: type: string default: - '0x295ee040949bd23a4bba5d5fa0d9d776c3b1fc7cafd511d025e689e665d05b2' responses: '200': description: Successful response tags: - General /starknet_simulateTransactions: post: summary: starknet_simulateTransactions description: starknet_simulateTransactions operationId: starknetSimulateTransactions requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 0 jsonrpc: type: string default: '2.0' method: type: string default: starknet_simulateTransactions params: type: array items: anyOf: - type: object properties: block_number: type: integer - type: array items: type: object properties: type: type: string max_fee: $ref: '#/components/schemas/FELT' version: type: string signature: type: array items: $ref: '#/components/schemas/FELT' sender_address: type: string calldata: type: array items: $ref: '#/components/schemas/FELT' nonce: $ref: '#/components/schemas/FELT' - type: array items: type: string default: id: 0 jsonrpc: '2.0' method: starknet_simulateTransactions params: - block_number: 385940 - - type: INVOKE max_fee: '0xb3a2f1ab6d632' version: '0x1' signature: - '0x54c2201c7b9021777389e208e28eafc67e4ba1f1aa7016a1123b61c6ff79c29' - '0x58c2d97614e5abfd9668b314f344c945d16ea154cb32a7b08b4445204f1f1d3' sender_address: '0x0569b13e8164bc8000c0bbcf4887856516643af123c5bc3b01e229e92f9cfd10' calldata: - '0x3' - '0x49d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7' - '0x219209e083275171774dab1df80982e9df2096516f06319c5c6d71ae0a8480c' - '0x3' - '0xfff107e2403123c7df78d91728a7ee5cfd557aec0fa2d2bdc5891c286bbfff' - '0x984e103a8acd6' - '0x0' - '0x68f5c6a61780768455de69077e07e89787839bf8166decfbf92b645209c0fb8' - '0x219209e083275171774dab1df80982e9df2096516f06319c5c6d71ae0a8480c' - '0x3' - '0xfff107e2403123c7df78d91728a7ee5cfd557aec0fa2d2bdc5891c286bbfff' - '0x4c4b40' - '0x0' - '0xfff107e2403123c7df78d91728a7ee5cfd557aec0fa2d2bdc5891c286bbfff' - '0x2f0b3c5710379609eb5495f1ecd348cb28167711b73609fe565a72734550354' - '0xe' - '0x569b13e8164bc8000c0bbcf4887856516643af123c5bc3b01e229e92f9cfd10' - '0x49d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7' - '0x68f5c6a61780768455de69077e07e89787839bf8166decfbf92b645209c0fb8' - '0x1f4' - '0xa76cc' - '0xa7b5e' - '0x984e103a8acd6' - '0x0' - '0x4c4b40' - '0x0' - '0x9542431aa6bf1' - '0x0' - '0x4ac4a0' - '0x0' nonce: '0x51' - - SKIP_VALIDATE - SKIP_FEE_CHARGE responses: '200': description: Successful response tags: - General /starknet_traceBlockTransactions: post: summary: starknet_traceBlockTransactions description: starknet_traceBlockTransactions operationId: starknetTraceBlockTransactions requestBody: required: true content: application/json: schema: type: object properties: id: type: integer default: 1 jsonrpc: type: string default: '2.0' method: type: string default: starknet_traceBlockTransactions params: type: object properties: block_id: type: object properties: block_number: type: integer default: 456600 default: id: 1 jsonrpc: '2.0' method: starknet_traceBlockTransactions params: block_id: block_number: 456600 responses: '200': description: Successful response tags: - General /accountpermissionupdate: post: tags: - General summary: Wallet/Accountpermissionupdate operationId: accountPermissionUpdate requestBody: required: true content: application/json: schema: type: object required: - owner_address properties: owner_address: type: string default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g owner: type: object properties: type: type: integer default: 0 permission_name: type: string default: owner threshold: type: integer default: 1 keys: type: array items: type: object properties: address: type: string default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g weight: type: integer default: 1 default: - address: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g weight: 1 witness: type: object properties: type: type: integer default: 1 permission_name: type: string default: witness threshold: type: integer default: 1 keys: type: array items: type: object properties: address: type: string default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g weight: type: integer default: 1 default: - address: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g weight: 1 actives: type: array items: type: object properties: type: type: integer default: 2 permission_name: type: string default: active threshold: type: integer default: 1 operations: type: string description: 32-byte hex bitmask of allowed operations default: FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF keys: type: array items: type: object properties: address: type: string default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g weight: type: integer default: 1 default: - address: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g weight: 1 default: - type: 2 permission_name: active threshold: 1 operations: FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF keys: - address: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g weight: 1 visible: type: boolean default: true responses: '200': description: Unsigned account permission update transaction content: application/json: schema: type: object properties: visible: type: boolean txID: type: string raw_data: type: object raw_data_hex: type: string /broadcasthex: post: tags: - General summary: Wallet/Broadcasthex operationId: broadcastHex requestBody: required: true content: application/json: schema: type: object properties: transaction: type: string description: The transaction data in hexadecimal format required: - transaction example: transaction: 0a84010a025e4b220847c9dc89341b300d40f8fed3a2a72e5a66080112620a2d747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e5472616e73666572436f6e747261637412310a1541608f8da72479edc7dd921e4c30bb7e7cddbe722e121541e9d79cc47518930bc322d9bf7cddd260a0260a8d18e8077093afd0a2a72e1241deadbeefcafebabefacec0011234abcd0badf00d9999777755553333222211114321dcba0f0ff0f013579bdf2468ace0987654321a2b3c4d5e6f7a8b9c0deeff1b responses: '200': description: Transaction broadcast result content: application/json: schema: type: object properties: result: type: boolean description: Whether the broadcast was successful txid: type: string description: Transaction ID if successful message: type: string description: Status message /broadcasttransaction: post: tags: - General summary: Wallet/Broadcasttransaction operationId: broadcastTransaction requestBody: required: true content: application/json: schema: type: object required: - raw_data - raw_data_hex properties: raw_data: type: object default: contract: - parameter: value: amount: 1000 owner_address: 41608f8da72479edc7dd921e4c30bb7e7cddbe722e to_address: 41e9d79cc47518930bc322d9bf7cddd260a0260a8d type_url: type.googleapis.com/protocol.TransferContract type: TransferContract ref_block_bytes: 5e4b ref_block_hash: 47c9dc89341b300d expiration: 1591089627000 timestamp: 1591089567635 raw_data_hex: type: string default: 0a025e4b220847c9dc89341b300d40f8fed3a2a72e5a66080112620a2d747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e5472616e73666572436f6e747261637412310a1541608f8da72479edc7dd921e4c30bb7e7cddbe722e121541e9d79cc47518930bc322d9bf7cddd260a0260a8d18e8077093afd0a2a72e signature: type: array description: Array of hex-encoded signatures (65-byte secp256k1). items: type: string default: - deadbeefcafebabefacec0011234abcd0badf00d9999777755553333222211114321dcba0f0ff0f013579bdf2468ace0987654321a2b3c4d5e6f7a8b9c0deeff1b visible: type: boolean default: false responses: '200': description: Transaction broadcast result content: application/json: schema: type: object properties: result: type: boolean code: type: string message: type: string txid: type: string /cancelallunfreezev2: post: tags: - General summary: Wallet/Cancelallunfreezev2 operationId: cancelAllUnfreezeV2 requestBody: required: true content: application/json: schema: type: object required: - owner_address properties: owner_address: type: string default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g visible: type: boolean default: true responses: '200': description: Unsigned cancel all unfreeze transaction content: application/json: schema: type: object properties: visible: type: boolean txID: type: string raw_data: type: object raw_data_hex: type: string /clearabi: post: tags: - General summary: Wallet/Clearabi operationId: clearAbi requestBody: required: true content: application/json: schema: type: object properties: owner_address: type: string description: Address of the contract owner contract_address: type: string description: Address of the smart contract visible: type: boolean description: Whether to use visible (Base58) address format required: - owner_address - contract_address example: owner_address: THPvaUhoh2Qn2y9THCZML3H815hhFhn5YC contract_address: TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t visible: true responses: '200': description: Contract ABI clearing transaction content: application/json: schema: type: object properties: visible: type: boolean description: Whether addresses are in visible format txID: type: string description: Transaction ID for the ABI clearing raw_data: type: object properties: contract: type: array description: Contract ABI clearing details ref_block_bytes: type: string description: Reference block bytes ref_block_hash: type: string description: Reference block hash expiration: type: number description: Transaction expiration timestamp timestamp: type: number description: Transaction creation timestamp raw_data_hex: type: string description: Raw transaction data in hex format /createaccount: post: tags: - General summary: Wallet/Createaccount operationId: createAccount requestBody: required: true content: application/json: schema: type: object required: - owner_address - account_address properties: owner_address: type: string description: The existing account that pays the account creation fee. Must have sufficient TRX. default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g account_address: type: string description: The new account address to be activated. default: TFgY1uN8buRxAtV2r6Zy5sG3ACko6pJT1y visible: type: boolean description: When true, addresses are base58; when false, hex. default: true responses: '200': description: Unsigned account creation transaction content: application/json: schema: type: object properties: visible: type: boolean txID: type: string raw_data: type: object raw_data_hex: type: string '400': description: Validation error (e.g., insufficient fee) content: application/json: schema: type: object properties: Error: type: string example: Error: 'class org.tron.core.exception.ContractValidateException : Validate CreateAccountActuator error, insufficient fee.' /createassetissue: post: tags: - General summary: Wallet/Createassetissue operationId: createAssetIssue requestBody: required: true content: application/json: schema: type: object required: - owner_address - name - abbr - total_supply - trx_num - num - start_time - end_time - description - url properties: owner_address: type: string description: Address that will issue the token default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g name: type: string description: Token name default: MyToken abbr: type: string description: Token symbol/abbreviation default: MTK total_supply: type: integer description: Total supply of tokens default: 1000000000000 trx_num: type: integer description: TRX amount for exchange rate default: 1 num: type: integer description: Token amount for exchange rate default: 1000 precision: type: integer description: Token decimal places (0-6) default: 6 start_time: type: integer description: ICO start time (timestamp) default: 1640995200000 end_time: type: integer description: ICO end time (timestamp) default: 1672531200000 description: type: string description: Token description default: A new TRC10 token for the TRON ecosystem url: type: string description: Token project website default: https://example.com free_asset_net_limit: type: integer description: Free bandwidth for token operations default: 1000000 public_free_asset_net_limit: type: integer description: Public free bandwidth limit default: 1000000 frozen_supply: type: array description: Frozen supply configurations items: type: object properties: frozen_amount: type: integer frozen_days: type: integer visible: type: boolean description: Use base58 address format default: true responses: '200': description: Unsigned TRC10 asset issue transaction content: application/json: schema: type: object properties: visible: type: boolean description: Address format indicator txID: type: string description: Transaction hash raw_data: type: object description: Raw transaction data properties: contract: type: array description: Contract array ref_block_bytes: type: string description: Reference block bytes ref_block_hash: type: string description: Reference block hash expiration: type: number description: Transaction expiration timestamp timestamp: type: number description: Transaction creation timestamp fee_limit: type: number description: Maximum fee allowed raw_data_hex: type: string description: Hexadecimal raw transaction /createshieldedcontractparameters: post: tags: - General summary: Wallet/Createshieldedcontractparameters operationId: createShieldedContractParameters requestBody: required: true content: application/json: schema: type: object required: - spend_authority_signature - view_signature - proof_generation_key - payment_address - rcm - ar - alpha - rsk - ask properties: spend_authority_signature: type: string description: Spending authority signature (128 hex characters, no 0x prefix) example: 08a1b2c3d4e5f6789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890 view_signature: type: string description: View signature component (64 hex characters, no 0x prefix) example: 1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b proof_generation_key: type: string description: Proof generation key (64 hex characters, no 0x prefix) example: 2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3 payment_address: type: string description: Recipient's shielded payment address (ztron1 format, 78 characters) example: ztron1768kf7dy4qquefp46szk978d65eeua66yhr4zv260c0uzj68t3tfjl3en9lhyyfxalv4jus30xs rcm: type: string description: Randomness commitment value (64 hex characters, no 0x prefix) example: 3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4 ar: type: string description: Authentication randomness value (64 hex characters, no 0x prefix) example: 4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5 alpha: type: string description: Alpha parameter for proof generation (64 hex characters, no 0x prefix) example: 5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6 rsk: type: string description: Randomness for spending key (64 hex characters, no 0x prefix) example: 6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7 ask: type: string description: Authentication secret key (64 hex characters, no 0x prefix) example: 7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8 responses: '200': description: Successfully created shielded contract parameters content: application/json: schema: type: object properties: receive_description: type: object description: Receive description for shielded transaction spend_description: type: object description: Spend description for shielded transaction binding_signature: type: string description: Binding signature for transaction /createshieldedcontractparameterswithoutask: post: tags: - General summary: Wallet/Createshieldedcontractparameterswithoutask operationId: createShieldedContractParametersWithoutAsk requestBody: required: true content: application/json: schema: type: object required: - ovk - from_address - to_address - amount properties: ovk: type: string description: Outgoing viewing key (64 hex characters, no 0x prefix) example: 09b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1 from_address: type: string description: Sender's shielded address example: ztron1a2b3c4d5e6f7g8h9j0k1l2m3n4p5q6r7s8t9u0v1w2x3y4z5a6b7c8d9e0f1g2h3j4k5l6m7n8p9 to_address: type: string description: Recipient's shielded address example: ztron1z9y8x7w6v5u4t3s2r1q0p9n8m7l6k5j4h3g2f1e0d9c8b7a6z5y4x3w2v1u0t9s8r7q6p5n4m3 amount: type: string description: Amount to transfer example: '1000000' transparent_from_address: type: string description: Optional transparent sender address example: TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE transparent_to_address: type: string description: Optional transparent recipient address example: TXYZoPYKcJJvXWc2WqJcqWvHqCqvqP5h3X responses: '200': description: Successfully created shielded contract parameters content: application/json: schema: type: object properties: receive_description: type: object description: Receive description for shielded transaction spend_description: type: object description: Spend description for shielded transaction binding_signature: type: string description: Binding signature for transaction /createspendauthsig: post: tags: - General summary: Wallet/Createspendauthsig operationId: createSpendAuthSig requestBody: required: true content: application/json: schema: type: object required: - ask - alpha - tx_hash properties: ask: type: string description: Authentication secret key for signing (32 bytes, hex without 0x prefix) example: 0f63eabdfe2bbfe08012f6bb2db024e6809c16e8ed055aa41a6095424f192005 alpha: type: string description: Alpha parameter for randomization (32 bytes, hex without 0x prefix) example: d0f0768664f5c807f9e70d05993f029c71da529afaa5c037b44c63d6e13bc907 tx_hash: type: string description: Transaction hash being authorized (32 bytes, hex without 0x prefix) example: 7fb99e66df052f430d50e80a3f197c319a4e35184ed48a433d6219e025741337 responses: '200': description: Successfully created spending authorization signature content: application/json: schema: type: object properties: value: type: string description: Generated spending authorization signature (hex string without 0x prefix) example: 66c806bc592a7599e65833bf25c3c7005c8b21b7895dd835a84c97d7bec49d0f1493d2c73a68eeb9b9699b92cae42406f9e44ebe19acaea3d5febfe28de57109 /createtransaction: post: tags: - General summary: Wallet/Createtransaction operationId: createTransaction requestBody: required: true content: application/json: schema: type: object required: - to_address - owner_address - amount properties: to_address: type: string default: 41e9d79cc47518930bc322d9bf7cddd260a0260a8d owner_address: type: string default: 41608f8da72479edc7dd921e4c30bb7e7cddbe722e amount: type: integer default: 1000 visible: type: boolean default: false responses: '200': description: Unsigned transaction object content: application/json: schema: type: object properties: visible: type: boolean txID: type: string raw_data: type: object properties: contract: type: array ref_block_bytes: type: string ref_block_hash: type: string expiration: type: integer timestamp: type: integer raw_data_hex: type: string /createwitness: post: tags: - General summary: Wallet/Createwitness operationId: createWitness requestBody: required: true content: application/json: schema: type: object properties: owner_address: type: string description: 'Address that will become a witness. Use base58 with `visible: true`, or hex with `visible: false`.' url: type: string description: Witness website URL (must be a valid URL) visible: type: boolean description: When true, addresses are base58; when false, hex. default: true required: - owner_address - url example: owner_address: THPvaUhoh2Qn2y9THCZML3H815hhFhn5YC url: https://mywitness.example.com visible: true responses: '200': description: Witness creation transaction content: application/json: schema: type: object properties: visible: type: boolean description: Whether addresses are in visible format txID: type: string description: Transaction ID for witness creation raw_data: type: object properties: contract: type: array description: Contract details for witness creation ref_block_bytes: type: string description: Reference block bytes ref_block_hash: type: string description: Reference block hash expiration: type: number description: Transaction expiration timestamp timestamp: type: number description: Transaction creation timestamp raw_data_hex: type: string description: Raw transaction data in hex format /delegateresource: post: tags: - General summary: Wallet/Delegateresource operationId: delegateResource requestBody: required: true content: application/json: schema: type: object required: - owner_address - receiver_address - balance - resource properties: owner_address: type: string default: 41608f8da72479edc7dd921e4c30bb7e7cddbe722e receiver_address: type: string default: 41e9d79cc47518930bc322d9bf7cddd260a0260a8d balance: type: integer default: 1000000 resource: type: string enum: - BANDWIDTH - ENERGY default: BANDWIDTH lock: type: boolean default: false lock_period: type: integer default: 0 visible: type: boolean default: false responses: '200': description: Resource delegation transaction content: application/json: schema: type: object properties: visible: type: boolean txID: type: string raw_data: type: object properties: contract: type: array ref_block_bytes: type: string ref_block_hash: type: string expiration: type: integer timestamp: type: integer raw_data_hex: type: string /deploycontract: post: tags: - General summary: Wallet/Deploycontract operationId: deployContract requestBody: required: true content: application/json: schema: type: object properties: owner_address: type: string description: Address deploying the contract in hex format abi: type: string description: Contract ABI (Application Binary Interface) as JSON string bytecode: type: string description: Contract bytecode in hex format parameter: type: string description: Constructor parameters encoded in hex format call_value: type: number description: Amount of TRX to transfer to contract (in SUN) consume_user_resource_percent: type: number description: Percentage of caller's resources used (0-100) fee_limit: type: number description: Maximum energy fee willing to pay (in SUN) origin_energy_limit: type: number description: Energy limit provided by contract creator name: type: string description: Human-readable contract name required: - owner_address - abi - bytecode example: owner_address: 41b487cdb2d8dc7b2a8e5e7e7b4e3e8b8b8b8b8b abi: '[{"inputs":[],"name":"name","outputs":[{"name":"","type":"string"}],"type":"function"}]' bytecode: 608060405234801561001057600080fd5b5061012a806100206000396000f3fe6080604052 parameter: '' call_value: 0 consume_user_resource_percent: 100 fee_limit: 1000000000 origin_energy_limit: 10000000 name: MyContract responses: '200': description: Contract deployment transaction content: application/json: schema: type: object properties: visible: type: boolean description: Whether addresses are in visible format txID: type: string description: Transaction ID of the deployment raw_data: type: object description: Raw transaction data raw_data_hex: type: string description: Raw transaction data in hex format /estimateenergy: post: tags: - General summary: Wallet/Estimateenergy operationId: estimateEnergy requestBody: required: true content: application/json: schema: type: object properties: owner_address: type: string description: Address executing the contract call contract_address: type: string description: Address of the smart contract function_selector: type: string description: Function signature to call parameter: type: string description: Hex-encoded parameters for the function visible: type: boolean description: Whether to use visible (Base58) address format required: - owner_address - contract_address - function_selector - parameter example: owner_address: THPvaUhoh2Qn2y9THCZML3H815hhFhn5YC contract_address: TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t function_selector: balanceOf(address) parameter: 000000000000000000000000a614f803b6fd780986a42c78ec9c7f77e6ded13c visible: true responses: '200': description: Energy consumption estimation content: application/json: schema: type: object properties: result: type: object properties: result: type: boolean description: Whether estimation was successful energy_required: type: number description: Estimated energy consumption energy_used: type: number description: Total energy that would be consumed constant_result: type: array description: Return values for view/pure functions transaction: type: object description: Transaction object with estimated costs /exchangecreate: post: summary: Create a new exchange trading pair description: Creates a new trading pair on the TRON decentralized exchange with initial liquidity provision operationId: exchangeCreate requestBody: required: true content: application/json: schema: type: object required: - owner_address - first_token_id - first_token_balance - second_token_id - second_token_balance properties: owner_address: type: string description: The address that will own and control the exchange pair first_token_id: type: string description: Token ID of the first token in the trading pair first_token_balance: type: integer description: Initial balance to provide for the first token (integer amount in the token's base units) second_token_id: type: string description: Token ID of the second token in the trading pair. Use '_' to denote TRX. second_token_balance: type: integer description: Initial balance to provide for the second token (integer amount; if TRX, specify in sun) permission_id: type: integer description: Optional permission ID for multi-signature accounts visible: type: boolean description: Whether to return human-readable addresses default: false examples: default: summary: Create TRC10–TRX exchange pair value: owner_address: TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH first_token_id: '1000001' first_token_balance: 1000000000000 second_token_id: _ second_token_balance: 5000000000 visible: true responses: '200': description: Successful response with transaction details content: application/json: schema: type: object properties: txID: type: string description: Unique transaction identifier raw_data: type: object description: Raw transaction data including contract details properties: contract: type: array items: type: object properties: parameter: type: object properties: value: type: object properties: owner_address: type: string first_token_id: type: string first_token_balance: type: string second_token_id: type: string second_token_balance: type: string type_url: type: string type: type: string ref_block_bytes: type: string ref_block_hash: type: string expiration: type: integer timestamp: type: integer raw_data_hex: type: string description: Hexadecimal representation of raw transaction data examples: success: summary: Successful response value: txID: f7d5c2e8a1b9f3d4c5e6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8 raw_data: contract: - parameter: value: owner_address: TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH first_token_id: '1000001' first_token_balance: '1000000000000' second_token_id: _ second_token_balance: '5000000000' type_url: type.googleapis.com/protocol.ExchangeCreateContract type: ExchangeCreateContract ref_block_bytes: ab90 ref_block_hash: f5d4c3b2a1 expiration: 1672531260000 timestamp: 1672531200000 raw_data_hex: 0a02ab901220f5d4c3b2a140e0b8e2f6e30f5a68081112620a32747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e45786368616e6765437265617465436f6e747261637412280a154c7971797a56474c5631737266b7dd4afc8eagg61534522083131306b30303131 '400': description: Bad request content: application/json: schema: type: object properties: Error: type: string examples: error: summary: Error response value: Error: Invalid token balance or insufficient funds tags: - General /exchangeinject: post: summary: Add liquidity to an exchange pair description: Adds liquidity to an existing exchange trading pair on the TRON decentralized exchange operationId: exchangeInject requestBody: required: true content: application/json: schema: type: object required: - owner_address - exchange_id - token_id - quant properties: owner_address: type: string description: The address providing liquidity to the exchange pair exchange_id: type: integer description: Unique identifier of the exchange pair to add liquidity to token_id: type: string description: Token ID being added to the liquidity pool. Use '_' to denote TRX. quant: type: integer description: Amount to add as an integer (token base units; if TRX, specify in sun) permission_id: type: integer description: Optional permission ID for multi-signature accounts visible: type: boolean description: Whether to return human-readable addresses default: false examples: default: summary: Add TRC10 tokens to liquidity pool value: owner_address: TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH exchange_id: 1 token_id: '1000001' quant: 500000000000 visible: true responses: '200': description: Successful response with transaction details content: application/json: schema: type: object properties: txID: type: string description: Unique transaction identifier raw_data: type: object description: Raw transaction data including contract details properties: contract: type: array items: type: object properties: parameter: type: object properties: value: type: object properties: owner_address: type: string exchange_id: type: integer token_id: type: string quant: type: string type_url: type: string type: type: string ref_block_bytes: type: string ref_block_hash: type: string expiration: type: integer timestamp: type: integer raw_data_hex: type: string description: Hexadecimal representation of raw transaction data examples: success: summary: Successful response value: txID: a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2 raw_data: contract: - parameter: value: owner_address: TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH exchange_id: 1 token_id: '1000001' quant: '500000000000' type_url: type.googleapis.com/protocol.ExchangeInjectContract type: ExchangeInjectContract ref_block_bytes: ab91 ref_block_hash: f5d4c3b2a2 expiration: 1672531320000 timestamp: 1672531260000 raw_data_hex: 0a02ab911220f5d4c3b2a240a0c9e2f6e30f5a68081112620a32747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e45786368616e6765496e6a656374436f6e747261637412280a154c7971797a56474c5631737266b7dd4afc8eagg615349220831310313530303031 '400': description: Bad request content: application/json: schema: type: object properties: Error: type: string examples: error: summary: Error response value: Error: Exchange not found or insufficient token balance tags: - General /exchangetransaction: post: summary: Execute a token swap transaction description: Executes a token swap transaction on the TRON decentralized exchange operationId: exchangeTransaction requestBody: required: true content: application/json: schema: type: object required: - owner_address - exchange_id - token_id - quant - expected properties: owner_address: type: string description: The address performing the token swap transaction exchange_id: type: integer description: Unique identifier of the exchange pair to trade on token_id: type: string description: Token ID being sold. Use '_' to denote TRX. quant: type: integer description: Amount being sold as an integer (token base units; if TRX, specify in sun) expected: type: integer description: Minimum amount to receive as an integer (token base units; if TRX, sun). Protects against slippage. permission_id: type: integer description: Optional permission ID for multi-signature accounts visible: type: boolean description: Whether to return human-readable addresses default: false examples: default: summary: Swap TRC10 tokens for TRX value: owner_address: TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH exchange_id: 1 token_id: '1000001' quant: 100000000000 expected: 95000000 visible: true responses: '200': description: Successful response with transaction details content: application/json: schema: type: object properties: txID: type: string description: Unique transaction identifier raw_data: type: object description: Raw transaction data including contract details properties: contract: type: array items: type: object properties: parameter: type: object properties: value: type: object properties: owner_address: type: string exchange_id: type: integer token_id: type: string quant: type: string expected: type: string type_url: type: string type: type: string ref_block_bytes: type: string ref_block_hash: type: string expiration: type: integer timestamp: type: integer raw_data_hex: type: string description: Hexadecimal representation of raw transaction data examples: success: summary: Successful response value: txID: c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2c3d4 raw_data: contract: - parameter: value: owner_address: TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH exchange_id: 1 token_id: '1000001' quant: '100000000000' expected: '95000000' type_url: type.googleapis.com/protocol.ExchangeTransactionContract type: ExchangeTransactionContract ref_block_bytes: ab93 ref_block_hash: f5d4c3b2a4 expiration: 1672531440000 timestamp: 1672531380000 raw_data_hex: 0a02ab931220f5d4c3b2a440a0fee2f6e30f5a68081112620a32747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e45786368616e67655472616e73616374696f6e436f6e747261637412280a154c7971797a56474c5631737266b7dd4afc8eagg61535422083931303030303030303030 '400': description: Bad request content: application/json: schema: type: object properties: Error: type: string examples: error: summary: Error response value: Error: Insufficient liquidity or slippage exceeded expected amount tags: - General /exchangewithdraw: post: summary: Remove liquidity from an exchange pair description: Removes liquidity from an existing exchange trading pair on the TRON decentralized exchange operationId: exchangeWithdraw requestBody: required: true content: application/json: schema: type: object required: - owner_address - exchange_id - token_id - quant properties: owner_address: type: string description: The address withdrawing liquidity from the exchange pair exchange_id: type: integer description: Unique identifier of the exchange pair to remove liquidity from token_id: type: string description: Token ID being withdrawn from the liquidity pool. Use '_' to denote TRX. quant: type: integer description: Amount to withdraw as an integer (token base units; if TRX, specify in sun) permission_id: type: integer description: Optional permission ID for multi-signature accounts visible: type: boolean description: Whether to return human-readable addresses default: false examples: default: summary: Withdraw TRC10 tokens from liquidity pool value: owner_address: TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH exchange_id: 1 token_id: '1000001' quant: 250000000000 visible: true responses: '200': description: Successful response with transaction details content: application/json: schema: type: object properties: txID: type: string description: Unique transaction identifier raw_data: type: object description: Raw transaction data including contract details properties: contract: type: array items: type: object properties: parameter: type: object properties: value: type: object properties: owner_address: type: string exchange_id: type: integer token_id: type: string quant: type: string type_url: type: string type: type: string ref_block_bytes: type: string ref_block_hash: type: string expiration: type: integer timestamp: type: integer raw_data_hex: type: string description: Hexadecimal representation of raw transaction data examples: success: summary: Successful response value: txID: b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2c3 raw_data: contract: - parameter: value: owner_address: TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH exchange_id: 1 token_id: '1000001' quant: '250000000000' type_url: type.googleapis.com/protocol.ExchangeWithdrawContract type: ExchangeWithdrawContract ref_block_bytes: ab92 ref_block_hash: f5d4c3b2a3 expiration: 1672531380000 timestamp: 1672531320000 raw_data_hex: 0a02ab921220f5d4c3b2a340e0ebe2f6e30f5a68081112620a32747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e45786368616e67655769746864726177436f6e747261637412280a154c7971797a56474c5631737266b7dd4afc8eagg615352220832353030303030303030 '400': description: Bad request content: application/json: schema: type: object properties: Error: type: string examples: error: summary: Error response value: Error: Exchange not found or insufficient liquidity to withdraw tags: - General /freezebalance: post: tags: - General summary: Wallet/Freezebalance operationId: freezeBalance deprecated: true requestBody: required: true content: application/json: schema: type: object required: - owner_address - frozen_balance - frozen_duration - resource properties: owner_address: type: string default: 41608f8da72479edc7dd921e4c30bb7e7cddbe722e frozen_balance: type: integer default: 1000000 frozen_duration: type: integer default: 3 resource: type: string enum: - BANDWIDTH - ENERGY default: BANDWIDTH receiver_address: type: string description: Optional. Address to receive the resources. Omit to freeze for yourself. Must not equal `owner_address`. visible: type: boolean default: false example: owner_address: 41608f8da72479edc7dd921e4c30bb7e7cddbe722e frozen_balance: 1000000 frozen_duration: 3 resource: BANDWIDTH visible: false responses: '200': description: Freeze balance transaction content: application/json: schema: type: object properties: visible: type: boolean txID: type: string raw_data: type: object properties: contract: type: array ref_block_bytes: type: string ref_block_hash: type: string expiration: type: integer timestamp: type: integer raw_data_hex: type: string '400': description: Validation error (legacy freeze disabled) content: application/json: schema: type: object properties: Error: type: string example: Error: 'class org.tron.core.exception.ContractValidateException : freeze v2 is open, old freeze is closed' /freezebalancev2: post: tags: - General summary: Wallet/Freezebalancev2 operationId: freezeBalanceV2 requestBody: required: true content: application/json: schema: type: object required: - owner_address - frozen_balance - resource properties: owner_address: type: string default: 41608f8da72479edc7dd921e4c30bb7e7cddbe722e frozen_balance: type: integer default: 1000000 resource: type: string enum: - BANDWIDTH - ENERGY default: BANDWIDTH visible: type: boolean default: false responses: '200': description: Freeze balance v2 transaction content: application/json: schema: type: object properties: visible: type: boolean txID: type: string raw_data: type: object properties: contract: type: array ref_block_bytes: type: string ref_block_hash: type: string expiration: type: integer timestamp: type: integer raw_data_hex: type: string /getaccount: post: tags: - General summary: Wallet/Getaccount operationId: getAccount requestBody: required: true content: application/json: schema: type: object required: - address properties: address: type: string default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g visible: type: boolean default: true responses: '200': description: Account information content: application/json: schema: type: object properties: address: type: string balance: type: integer create_time: type: integer latest_operation_time: type: integer free_net_usage: type: integer account_resource: type: object owner_permission: type: object active_permission: type: array /getaccountbalance: post: tags: - General summary: Wallet/Getaccountbalance operationId: getAccountBalance requestBody: required: true content: application/json: schema: type: object required: - account_identifier - block_identifier properties: account_identifier: type: object required: - address properties: address: type: string description: Account address. Use hex when `visible` is false, or base58 when `visible` is true. default: 41608f8da72479edc7dd921e4c30bb7e7cddbe722e block_identifier: type: object properties: hash: type: string description: Optional 32-byte block hash as 64 hex characters. pattern: ^[0-9a-fA-F]{64}$ number: type: integer required: - hash - number description: Block to query the balance at. Provide both the 32-byte block hash (64 hex chars) and its number; the node validates they match. visible: type: boolean default: false example: account_identifier: address: 41608f8da72479edc7dd921e4c30bb7e7cddbe722e block_identifier: hash: 0000000004986736812cbf15ffbcdd229bd3d76a595db895719867cc2da3a5bd number: 77096758 visible: false responses: '200': description: Account balance information content: application/json: schema: type: object properties: balance: type: integer description: Available TRX balance in sun frozen: type: array description: Frozen balance information items: type: object properties: frozen_balance: type: integer expire_time: type: integer delegated_frozenV2: type: array description: Delegated frozen balance v2 items: type: object properties: type: type: string frozen_balance: type: integer undelegated_frozenV2: type: array description: Undelegated frozen balance v2 items: type: object properties: type: type: string unfreeze_amount: type: integer unfreeze_expire_time: type: integer /getaccountnet: post: tags: - General summary: Wallet/Getaccountnet operationId: getAccountNet requestBody: required: true content: application/json: schema: type: object required: - address properties: address: type: string default: 41608f8da72479edc7dd921e4c30bb7e7cddbe722e visible: type: boolean default: false responses: '200': description: Account network resource information content: application/json: schema: type: object properties: freeNetUsed: type: integer description: Free bandwidth used freeNetLimit: type: integer description: Free bandwidth limit NetUsed: type: integer description: Staked bandwidth used NetLimit: type: integer description: Staked bandwidth limit TotalNetLimit: type: integer description: Total network bandwidth limit TotalNetWeight: type: integer description: Total network weight netUsed: type: integer description: Current bandwidth usage netLimit: type: integer description: Current bandwidth limit TotalEnergyLimit: type: integer description: Total energy limit TotalEnergyWeight: type: integer description: Total energy weight /getaccountresource: post: tags: - General summary: Wallet/Getaccountresource operationId: getAccountResource requestBody: required: true content: application/json: schema: type: object required: - address properties: address: type: string description: Account address in hex or base58check format example: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g visible: type: boolean description: Whether the address is in readable format default: true responses: '200': description: Account resource information content: application/json: schema: type: object properties: freeNetUsed: type: integer description: Free bandwidth used by the account example: 0 freeNetLimit: type: integer description: Total free bandwidth example: 5000 NetUsed: type: integer description: Used amount of bandwidth obtained by staking example: 0 NetLimit: type: integer description: Total bandwidth obtained by staking example: 0 TotalNetLimit: type: integer description: Total network bandwidth limit example: 43200000000 TotalNetWeight: type: integer description: Total network weight example: 84687233463517 EnergyUsed: type: integer description: Energy used by the account example: 0 EnergyLimit: type: integer description: Total energy obtained by staking example: 0 TotalEnergyLimit: type: integer description: Total energy limit on network example: 90000000000 TotalEnergyWeight: type: integer description: Total energy weight on network example: 13369831825062 tronPowerLimit: type: integer description: TRON Power (voting power) example: 0 tronPowerUsed: type: integer description: TRON Power used for voting example: 0 totalTronPowerWeight: type: integer description: Total TRON Power weight on network example: 0 assetNetUsed: type: array description: Bandwidth used for TRC10 assets items: type: object properties: key: type: string description: Asset ID value: type: integer description: Bandwidth used for this asset assetNetLimit: type: array description: Bandwidth limit for TRC10 assets items: type: object properties: key: type: string description: Asset ID value: type: integer description: Bandwidth limit for this asset /getapprovedlist: post: tags: - General summary: Wallet/Getapprovedlist operationId: getApprovedList requestBody: required: true content: application/json: schema: type: object required: - txID - raw_data - raw_data_hex - signature properties: txID: type: string description: Transaction ID (hash) raw_data: type: object description: Raw transaction data raw_data_hex: type: string description: Raw transaction data in hex signature: type: array items: type: string description: Array of 65-byte hex signatures visible: type: boolean default: false example: txID: 4ad97d49409cfff338d2f9e71d4019c70e82030b52e15e208b1808f2f3ea782e raw_data: contract: - parameter: value: data: a9059cbb0000000000000000000000415d4a41a3b0cdda5c03df72b38a20aa1b88777c7500000000000000000000000000000000000000000000000000000000f9cd95c0 owner_address: 41cf2e99409d2a9a9190197ab0bff35ca87818c41e contract_address: 41a614f803b6fd780986a42c78ec9c7f77e6ded13c type_url: type.googleapis.com/protocol.TriggerSmartContract type: TriggerSmartContract ref_block_bytes: 68bd ref_block_hash: bc830d2c09fa23d1 expiration: 1761952567698 fee_limit: 225000000 timestamp: 1761952507695 raw_data_hex: 0a0268bd2208bc830d2c09fa23d14092a3bae4a3335aae01081f12a9010a31747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e54726967676572536d617274436f6e747261637412740a1541cf2e99409d2a9a9190197ab0bff35ca87818c41e121541a614f803b6fd780986a42c78ec9c7f77e6ded13c2244a9059cbb0000000000000000000000415d4a41a3b0cdda5c03df72b38a20aa1b88777c7500000000000000000000000000000000000000000000000000000000f9cd95c070afceb6e4a3339001c0f4a46b signature: - c99cdc8af6f47dc65a75aa0c6da1c5be8510736e581043162c3e8525c6e0ed8f592adaa74ba250136ea6e1fb125b3d3d024ac6abd3e24c28097d66a8e2a0c0aa01 visible: false responses: '200': description: Approved addresses (derived from signatures) and the echoed transaction content: application/json: schema: type: object properties: result: type: object approved_list: type: array items: type: string transaction: type: object /getassetissuebyid: post: tags: - General summary: Wallet/Getassetissuebyid operationId: getAssetIssueById requestBody: required: true content: application/json: schema: type: object properties: value: type: string description: TRC10 token ID to query required: - value example: value: '1000001' responses: '200': description: TRC10 token information content: application/json: schema: type: object properties: owner_address: type: string description: Address that issued the token name: type: string description: Token name abbr: type: string description: Token symbol/abbreviation total_supply: type: number description: Total supply of tokens trx_num: type: number description: TRX amount for exchange rate precision: type: number description: Token decimal places num: type: number description: Token amount for exchange rate start_time: type: number description: ICO start time (timestamp) end_time: type: number description: ICO end time (timestamp) description: type: string description: Token description url: type: string description: Token project website id: type: string description: Unique token ID free_asset_net_limit: type: number description: Free bandwidth for token operations public_free_asset_net_limit: type: number description: Public free bandwidth limit public_free_asset_net_usage: type: number description: Used public bandwidth public_latest_free_net_time: type: number description: Latest free bandwidth usage time /getassetissuebyname: post: tags: - General summary: Wallet/Getassetissuebyname operationId: getAssetIssueByName requestBody: required: true content: application/json: schema: type: object required: - value properties: value: type: string description: Token name. When `visible` is true, provide the plain UTF‑8 name. When `visible` is false, provide the UTF‑8 name hex‑encoded. default: TOKEN_NAME visible: type: boolean description: When true, `value` is plain text. When false, `value` is hex‑encoded UTF‑8. default: false example: value: 54525854657374436f696e visible: false responses: '200': description: TRC10 token information content: application/json: schema: type: object properties: assetIssue: type: array items: type: object properties: owner_address: type: string name: type: string abbr: type: string total_supply: type: integer trx_num: type: integer num: type: integer start_time: type: integer end_time: type: integer description: type: string url: type: string id: type: string /getassetissuelist: post: tags: - General summary: Wallet/Getassetissuelist operationId: getAssetIssueList requestBody: required: true content: application/json: schema: type: object example: {} responses: '200': description: List of all TRC10 tokens content: application/json: schema: type: object properties: assetIssue: type: array items: type: object properties: owner_address: type: string description: Address that issued the token name: type: string description: Token name abbr: type: string description: Token symbol/abbreviation total_supply: type: number description: Total supply of tokens trx_num: type: number description: TRX amount for exchange rate precision: type: number description: Token decimal places num: type: number description: Token amount for exchange rate start_time: type: number description: ICO start time (timestamp) end_time: type: number description: ICO end time (timestamp) description: type: string description: Token description url: type: string description: Token project website id: type: string description: Unique token ID free_asset_net_limit: type: number description: Free bandwidth for token operations public_free_asset_net_limit: type: number description: Public free bandwidth limit public_free_asset_net_usage: type: number description: Used public bandwidth public_latest_free_net_time: type: number description: Latest free bandwidth usage time /getassetissuelistbyname: post: tags: - General summary: Wallet/Getassetissuelistbyname operationId: getAssetIssueListByName requestBody: required: true content: application/json: schema: type: object properties: value: type: string description: Token name or pattern. When `visible` is true, provide plain UTF‑8. When `visible` is false, provide hex‑encoded UTF‑8. visible: type: boolean description: When true, `value` is plain text; when false, hex‑encoded. default: true required: - value example: value: SEED visible: true responses: '200': description: List of TRC10 tokens matching the name pattern content: application/json: schema: type: object properties: assetIssue: type: array description: Array of TRC10 token information items: type: object properties: id: type: string description: Unique token ID owner_address: type: string description: Address of token issuer name: type: string description: Token name in hex format abbr: type: string description: Token abbreviation in hex format total_supply: type: number description: Total supply of the token trx_num: type: number description: TRX amount in exchange ratio precision: type: number description: Token decimal places num: type: number description: Token amount in exchange ratio start_time: type: number description: Token sale start timestamp end_time: type: number description: Token sale end timestamp description: type: string description: Token description in hex format url: type: string description: Token website URL in hex format free_asset_net_limit: type: number description: Free bandwidth allocation public_free_asset_net_limit: type: number description: Public free bandwidth limit frozen_supply: type: array description: Frozen token supply details /getavailableunfreezecount: post: tags: - General summary: Wallet/Getavailableunfreezecount operationId: getAvailableUnfreezeCount requestBody: required: true content: application/json: schema: type: object required: - owner_address properties: owner_address: type: string default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g visible: type: boolean default: true responses: '200': description: Available unfreeze count content: application/json: schema: type: object properties: count: type: integer /getbandwidthprices: post: tags: - General summary: Wallet/Getbandwidthprices operationId: getBandwidthPrices requestBody: required: false content: application/json: schema: type: object properties: {} responses: '200': description: Current bandwidth prices content: application/json: schema: type: object properties: prices: type: string /getblockbalance: post: tags: - General summary: Wallet/Getblockbalance operationId: getBlockBalance requestBody: required: true content: application/json: schema: type: object required: - hash - number properties: hash: type: string description: Block hash (64 hex chars) pattern: ^[0-9a-fA-F]{64}$ number: type: integer description: Block number (must match the hash) visible: type: boolean default: true example: hash: 0000000004986736812cbf15ffbcdd229bd3d76a595db895719867cc2da3a5bd number: 77096758 visible: true responses: '200': description: Block balance changes information content: application/json: schema: type: object properties: timestamp: type: integer block_identifier: type: object properties: hash: type: string number: type: integer transaction_balance_trace: type: array description: Per-transaction balance deltas within the block items: type: object properties: transaction_identifier: type: string operation: type: array items: type: object properties: operation_identifier: type: integer address: type: string amount: type: integer description: Delta in sun; negative for debits, positive for credits type: type: string status: type: string /getblockbyid: post: tags: - General summary: Wallet/Getblockbyid operationId: getBlockById requestBody: required: true content: application/json: schema: type: object properties: value: type: string description: The block ID (hash) in hexadecimal format required: - value example: value: 0000000000f4245300b88ffeb9bdb95b88c66b5ce6bb0ee79d85d5ce14b6a2a7ca responses: '200': description: Block information content: application/json: schema: type: object properties: blockID: type: string description: Block ID (hash) block_header: type: object properties: raw_data: type: object properties: timestamp: type: number description: Block timestamp in milliseconds txTrieRoot: type: string description: Transaction trie root hash parentHash: type: string description: Hash of the parent block number: type: number description: Block height/number witness_address: type: string description: Address of the block producer version: type: number description: Block version witness_signature: type: string description: Block producer's signature transactions: type: array description: Array of transactions in the block items: type: object /getblockbylatestnum: post: tags: - General summary: Wallet/Getblockbylatestnum operationId: getBlockByLatestNum requestBody: required: true content: application/json: schema: type: object required: - num properties: num: type: integer default: 5 description: Number of latest blocks to retrieve (max 100) visible: type: boolean default: true responses: '200': description: Latest blocks information content: application/json: schema: type: object properties: block: type: array items: type: object properties: blockID: type: string block_header: type: object transactions: type: array items: type: object /getblockbylimitnext: post: tags: - General summary: Wallet/Getblockbylimitnext operationId: getBlockByLimitNext requestBody: required: true content: application/json: schema: type: object required: - startNum - endNum properties: startNum: type: integer default: 66677870 endNum: type: integer default: 66677880 visible: type: boolean default: true responses: '200': description: Blocks within specified range content: application/json: schema: type: object properties: block: type: array items: type: object properties: blockID: type: string block_header: type: object transactions: type: array items: type: object /getblockbynum: post: tags: - General summary: Wallet/Getblockbynum operationId: getBlockByNum requestBody: required: true content: application/json: schema: type: object required: - num properties: num: type: integer default: 1000 visible: type: boolean default: false responses: '200': description: Block information content: application/json: schema: type: object properties: blockID: type: string block_header: type: object properties: raw_data: type: object properties: number: type: integer timestamp: type: integer parentHash: type: string witness_signature: type: string transactions: type: array items: type: object visible: type: boolean /getbrokerage: get: tags: - General summary: wallet/getBrokerage operationId: getBrokerage parameters: - name: address in: query required: true schema: type: string description: Witness address in hex format (21-byte, starts with 41) example: 41928c9af0651632157ef27a2cf17ca72c575a4d21 responses: '200': description: Brokerage percentage for witness rewards content: application/json: schema: type: object properties: brokerage: type: number description: Brokerage percentage (0-100) example: brokerage: 20 /getburntrx: post: tags: - General summary: Wallet/Getburntrx operationId: getBurnTrx requestBody: required: false content: application/json: schema: type: object properties: {} responses: '200': description: Burned TRX information content: application/json: schema: type: object properties: burnTrxAmount: type: integer /getcandelegatedmaxsize: post: tags: - General summary: Wallet/Getcandelegatedmaxsize operationId: getCanDelegatedMaxSize requestBody: required: true content: application/json: schema: type: object required: - owner_address - type properties: owner_address: type: string default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g type: type: integer default: 0 description: 0 for bandwidth, 1 for energy visible: type: boolean default: true responses: '200': description: Maximum delegatable amount content: application/json: schema: type: object properties: max_size: type: integer /getcanwithdrawunfreezeamount: post: tags: - General summary: Wallet/Getcanwithdrawunfreezeamount operationId: getCanWithdrawUnfreezeAmount requestBody: required: true content: application/json: schema: type: object required: - owner_address properties: owner_address: type: string default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g timestamp: type: integer description: Timestamp in milliseconds visible: type: boolean default: true responses: '200': description: Withdrawable unfreeze amount content: application/json: schema: type: object properties: amount: type: integer /getchainparameters: get: tags: - General summary: Wallet/Getchainparameters operationId: getChainParameters responses: '200': description: Blockchain parameters and configuration content: application/json: schema: type: object properties: chainParameter: type: array description: Array of blockchain parameters items: type: object properties: key: type: string description: Parameter name value: type: integer description: Parameter value example: - key: getMaintenanceTimeInterval value: 21600000 - key: getAccountUpgradeCost value: 9999000000 - key: getCreateAccountFee value: 100000 - key: getTransactionFee value: 10 - key: getAssetIssueFee value: 1024000000 - key: getWitnessPayPerBlock value: 16000000 - key: getWitnessStandbyAllowance value: 115200000000 - key: getCreateNewAccountFeeInSystemContract value: 1000000 - key: getCreateNewAccountBandwidthRate value: 1 - key: getAllowCreationOfContracts value: 1 - key: getRemoveThePowerOfTheGr value: 1 - key: getEnergyFee value: 140 - key: getExchangeCreateFee value: 1024000000 - key: getMaxCpuTimeOfOneTx value: 80 - key: getAllowUpdateAccountName value: 0 - key: getAllowSameTokenName value: 1 - key: getAllowDelegateResource value: 1 - key: getTotalEnergyLimit value: 90000000000 - key: getAllowTvmTransferTrc10 value: 1 - key: getTotalEnergyCurrentLimit value: 90000000000 - key: getAllowMultiSign value: 1 - key: getAllowAdaptiveEnergy value: 1 - key: getUpdateAccountPermissionFee value: 100000000 - key: getMultiSignFee value: 1000000 /getcontract: post: tags: - General summary: Wallet/Getcontract operationId: getContract requestBody: required: true content: application/json: schema: type: object properties: value: type: string description: Contract address in hex format required: - value example: value: 41a614f803b6fd780986a42c78ec9c7f77e6ded13c responses: '200': description: Smart contract information content: application/json: schema: type: object properties: bytecode: type: string description: Contract bytecode in hex format name: type: string description: Contract name origin_address: type: string description: Address that deployed the contract contract_address: type: string description: Contract address in hex format abi: type: object description: Contract ABI (Application Binary Interface) origin_energy_limit: type: number description: Original energy limit set for the contract consume_user_resource_percent: type: number description: Percentage of user resources consumed by contract calls code_hash: type: string description: Hash of the contract code trx_hash: type: string description: Transaction hash of the contract deployment /getcontractinfo: post: tags: - General summary: Wallet/Getcontractinfo operationId: getContractInfo requestBody: required: true content: application/json: schema: type: object properties: value: type: string description: Contract address to get information for visible: type: boolean description: Whether to use visible (Base58) address format required: - value example: value: TG3XXyExBkPp9nzdajDZsozEu4BkaSJozs visible: true responses: '200': description: Detailed contract information content: application/json: schema: type: object properties: contract_address: type: string description: The contract address bytecode: type: string description: Contract bytecode in hex format name: type: string description: Contract name if available abi: type: object description: Application Binary Interface source_map: type: string description: Source code mapping for debugging source_code: type: string description: Original contract source code compiler_version: type: string description: Solidity compiler version used consume_user_resource_percent: type: number description: Percentage of user resources consumed origin_address: type: string description: Address that deployed the contract origin_energy_limit: type: number description: Energy limit set by contract creator contract_state: type: string description: Current state of the contract code_hash: type: string description: Hash of the contract code /getdelegatedresource: post: tags: - General summary: Wallet/Getdelegatedresource operationId: getDelegatedResource requestBody: required: true content: application/json: schema: type: object required: - fromAddress - toAddress properties: fromAddress: type: string default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g toAddress: type: string default: TFgY1uN8buRxAtV2r6Zy5sG3ACko6pJT1y visible: type: boolean default: true responses: '200': description: Delegated resource information content: application/json: schema: type: object properties: delegatedResource: type: array items: type: object properties: from: type: string to: type: string frozen_balance_for_bandwidth: type: integer frozen_balance_for_energy: type: integer expire_time_for_bandwidth: type: integer expire_time_for_energy: type: integer /getdelegatedresourceaccountindex: post: tags: - General summary: Wallet/Getdelegatedresourceaccountindex operationId: getDelegatedResourceAccountIndex requestBody: required: true content: application/json: schema: type: object required: - value properties: value: type: string default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g visible: type: boolean default: true responses: '200': description: Delegated resource account index content: application/json: schema: type: object properties: account: type: string fromAccounts: type: array items: type: string toAccounts: type: array items: type: string /getdelegatedresourceaccountindexv2: post: tags: - General summary: Wallet/Getdelegatedresourceaccountindexv2 operationId: getDelegatedResourceAccountIndexV2 requestBody: required: true content: application/json: schema: type: object required: - value properties: value: type: string default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g visible: type: boolean default: true responses: '200': description: Delegated resource account index (Stake 2.0) content: application/json: schema: type: object properties: account: type: string fromAccounts: type: array items: type: string toAccounts: type: array items: type: string /getdelegatedresourcev2: post: tags: - General summary: Wallet/Getdelegatedresourcev2 operationId: getDelegatedResourceV2 requestBody: required: true content: application/json: schema: type: object required: - fromAddress - toAddress properties: fromAddress: type: string default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g toAddress: type: string default: TFgY1uN8buRxAtV2r6Zy5sG3ACko6pJT1y visible: type: boolean default: true responses: '200': description: Delegated resource information (Stake 2.0) content: application/json: schema: type: object properties: delegatedResource: type: array items: type: object properties: from: type: string to: type: string frozen_balance_for_bandwidth: type: integer frozen_balance_for_energy: type: integer expire_time_for_bandwidth: type: integer expire_time_for_energy: type: integer /getenergyprices: post: tags: - General summary: Wallet/Getenergyprices operationId: getEnergyPrices requestBody: required: false content: application/json: schema: type: object properties: {} responses: '200': description: Current energy prices content: application/json: schema: type: object properties: prices: type: string /getexchangebyid: post: summary: Get exchange pair details by ID description: Retrieves detailed information about a specific exchange trading pair by its unique identifier operationId: getExchangeById requestBody: required: true content: application/json: schema: type: object required: - id properties: id: type: integer description: The unique exchange ID to query visible: type: boolean description: Whether to return human-readable addresses default: false examples: default: summary: Get exchange by ID value: id: 1 visible: true responses: '200': description: Successful response with exchange details content: application/json: schema: type: object properties: exchange_id: type: integer description: Unique identifier for the exchange pair creator_address: type: string description: Address that created the exchange pair create_time: type: integer description: Timestamp when the exchange was created first_token_id: type: string description: Token ID of the first token in the pair first_token_balance: type: string description: Current balance of the first token second_token_id: type: string description: Token ID of the second token in the pair second_token_balance: type: string description: Current balance of the second token examples: success: summary: Successful response value: exchange_id: 1 creator_address: TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH create_time: 1672531200000 first_token_id: '1000001' first_token_balance: '1000000000000' second_token_id: _ second_token_balance: '5000000000' '400': description: Bad request content: application/json: schema: type: object properties: Error: type: string examples: error: summary: Error response value: Error: Exchange not found tags: - General /getmarketorderbyaccount: post: tags: - General summary: Wallet/Getmarketorderbyaccount operationId: getMarketOrderByAccount requestBody: required: true content: application/json: schema: type: object properties: address: type: string description: Account address in hex format offset: type: number description: 'Starting position for pagination (default: 0)' limit: type: number description: 'Maximum number of orders to return (default: 20, max: 100)' required: - address example: address: 41b487cdb2d8dc7b2a8e5e7e7b4e3e8b8b8b8b8b offset: 0 limit: 20 responses: '200': description: Market orders for the account content: application/json: schema: type: object properties: orders: type: array items: type: object properties: order_id: type: string description: Unique identifier for the market order owner_address: type: string description: Order creator address create_time: type: number description: Order creation timestamp sell_token_id: type: string description: Token ID being sold (empty for TRX) sell_token_quantity: type: string description: Quantity of tokens being sold buy_token_id: type: string description: Token ID being purchased (empty for TRX) buy_token_quantity: type: string description: Quantity of tokens being purchased sell_token_quantity_remain: type: string description: Remaining quantity for sale buy_token_quantity_remain: type: string description: Remaining quantity to purchase state: type: string description: Order status /getmarketorderbyid: post: tags: - General summary: Wallet/Getmarketorderbyid operationId: getMarketOrderById requestBody: required: true content: application/json: schema: type: object properties: order_id: type: string description: Unique identifier of the market order (hex string) required: - order_id example: order_id: '0x1234567890abcdef1234567890abcdef12345678' responses: '200': description: Market order details content: application/json: schema: type: object properties: order_id: type: string description: Unique identifier for the market order owner_address: type: string description: Order creator address create_time: type: number description: Order creation timestamp sell_token_id: type: string description: Token ID being sold (empty for TRX) sell_token_quantity: type: string description: Original quantity of tokens being sold buy_token_id: type: string description: Token ID being purchased (empty for TRX) buy_token_quantity: type: string description: Original quantity of tokens being purchased sell_token_quantity_remain: type: string description: Remaining quantity for sale buy_token_quantity_remain: type: string description: Remaining quantity to purchase state: type: string description: Order status prev: type: string description: Previous order ID in order book next: type: string description: Next order ID in order book /getmarketorderlistbypair: post: tags: - General summary: Wallet/Getmarketorderlistbypair operationId: getMarketOrderListByPair requestBody: required: true content: application/json: schema: type: object properties: sell_token_id: type: string description: TRC10 token ID being sold, as a numeric string (for example, '1000006'). buy_token_id: type: string description: TRC10 token ID being purchased, as a numeric string. offset: type: number description: 'Starting position for pagination (default: 0)' limit: type: number description: 'Maximum number of orders to return (default: 20, max: 100)' visible: type: boolean description: 'Optional. Some node builds require `visible: true` for this endpoint.' default: true required: - sell_token_id - buy_token_id example: sell_token_id: '1000006' buy_token_id: '1000001' offset: 0 limit: 20 visible: true responses: '200': description: Market orders for trading pair content: application/json: schema: type: object properties: orders: type: array items: type: object properties: order_id: type: string description: Unique identifier for the market order owner_address: type: string description: Order creator address create_time: type: number description: Order creation timestamp sell_token_id: type: string description: Token ID being sold sell_token_quantity: type: string description: Quantity of tokens being sold buy_token_id: type: string description: Token ID being purchased buy_token_quantity: type: string description: Quantity of tokens being purchased sell_token_quantity_remain: type: string description: Remaining quantity for sale buy_token_quantity_remain: type: string description: Remaining quantity to purchase state: type: string description: Order status /getmarketpairlist: post: tags: - General summary: Wallet/Getmarketpairlist operationId: getMarketPairList requestBody: required: true content: application/json: schema: type: object example: {} responses: '200': description: All available trading pairs content: application/json: schema: type: object properties: orderPair: type: array description: Array of trading pair objects items: type: object properties: sell_token_id: type: string description: Token ID for sell side (empty for TRX) buy_token_id: type: string description: Token ID for buy side (empty for TRX) /getmarketpricebypair: post: tags: - General summary: Wallet/Getmarketpricebypair operationId: getMarketPriceByPair requestBody: required: true content: application/json: schema: type: object properties: sell_token_id: type: string description: TRC10 token ID being sold, as a numeric string (e.g., '1000006'). buy_token_id: type: string description: TRC10 token ID being purchased, as a numeric string. visible: type: boolean description: 'Optional. Some node builds require `visible: true` for this endpoint.' default: true required: - sell_token_id - buy_token_id example: sell_token_id: '1000006' buy_token_id: '1000001' visible: true responses: '200': description: Market price for trading pair content: application/json: schema: type: object properties: sell_token_id: type: string description: Token ID being sold buy_token_id: type: string description: Token ID being purchased prices: type: array description: Array of recent price points items: type: object properties: sell_token_quantity: type: string description: Quantity of sell token buy_token_quantity: type: string description: Quantity of buy token timestamp: type: number description: Price point timestamp '400': description: Validation error or unsupported pair content: application/json: schema: type: object properties: Error: type: string example: Error: 'class org.tron.core.exception.BadItemException : sellTokenId is not a valid number' /getmerkletreevoucherinfo: post: tags: - General summary: Wallet/Getmerkletreevoucherinfo operationId: getMerkleTreeVoucherInfo requestBody: required: true content: application/json: schema: type: object required: - output_point - ak - nk - position properties: output_point: type: string description: The output point for the merkle tree voucher default: 030c8c2bc59fb3eb8c12157b4d7ddd4b2d6cf2c5b3f1a2c3d4e5f6071819202122 ak: type: string description: Authentication key for the voucher default: 1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b nk: type: string description: Nullifier key for the voucher default: 9f8e7d6c5b4a39281706f5e4d3c2b1a09f8e7d6c5b4a39281706f5e4d3c2b1a0 position: type: integer description: Position in the merkle tree default: 12345 responses: '200': description: Merkle tree voucher information content: application/json: schema: type: object properties: voucher_info: type: object description: Voucher information object paths: type: array items: type: string description: Array of merkle tree path elements anchors: type: array items: type: string description: Array of anchor values for the merkle tree rt: type: string description: Merkle tree root output_point_info: type: object description: Detailed information about the output point /getnewshieldedaddress: post: tags: - General summary: Wallet/Getnewshieldedaddress operationId: getNewShieldedAddress requestBody: required: true content: application/json: schema: type: object properties: {} responses: '200': description: Successfully generated new shielded address with full key set content: application/json: schema: type: object properties: sk: type: string description: Spending key (private key, 64 hex characters, no 0x prefix) example: 02a1b2c3d4e5f67890123456789012345678901234567890123456789012345678 ask: type: string description: Authentication secret key (64 hex characters, no 0x prefix) example: 0f63eabdfe2bbfe08012f6bb2db024e6809c16e8ed055aa41a6095424f192005 nsk: type: string description: Nullifier secret key (64 hex characters, no 0x prefix) example: 590bf33f93f792be659fd404df91e75c3b08d38d4e08ee226c3f5219cf598f14 ovk: type: string description: Outgoing viewing key (64 hex characters, no 0x prefix) example: 0ff58efd75e083fe4fd759c8701e1c8cb6961c4297a12b2c800bdb7b2bcab889 ak: type: string description: Authentication key (64 hex characters, no 0x prefix) example: 8072d9110c9de9d9ade33d5d0f5890a7aa65b0cde42af7816d187297caf2fd64 nk: type: string description: Nullifier key (64 hex characters, no 0x prefix) example: 590bf33f93f792be659fd404df91e75c3b08d38d4e08ee226c3f5219cf598f14 ivk: type: string description: Incoming viewing key (64 hex characters, no 0x prefix) example: 9f8e74bb3d7188a2781dc1db38810c6914eef4570a79e8ec8404480948e4e305 d: type: string description: Diversifier (22 hex characters, no 0x prefix) example: 06e5f678901234567890ab pkD: type: string description: Payment address public key (64 hex characters, no 0x prefix) example: a1b2c3d4e5f6789012345678901234567890123456789012345678901234abcd payment_address: type: string description: Complete shielded payment address (ztron1 format, 78 characters) example: ztron1768kf7dy4qquefp46szk978d65eeua66yhr4zv260c0uzj68t3tfjl3en9lhyyfxalv4jus30xs /getnextmaintenancetime: post: tags: - General summary: Wallet/Getnextmaintenancetime operationId: getNextMaintenanceTime requestBody: required: true content: application/json: schema: type: object example: {} responses: '200': description: Next maintenance window time content: application/json: schema: type: object properties: num: type: number description: Timestamp of next maintenance window in milliseconds example: num: 1693468800000 /getnodeinfo: get: tags: - General summary: Wallet/Getnodeinfo operationId: getNodeInfo responses: '200': description: Node information and status content: application/json: schema: type: object properties: beginSyncNum: type: integer description: Block number from which sync started block: type: string description: Current block height solidityBlock: type: string description: Current solidity block height currentConnectCount: type: integer description: Current peer connections activeConnectCount: type: integer description: Active peer connections passiveConnectCount: type: integer description: Passive peer connections totalFlow: type: integer description: Total network traffic flow peerInfoList: type: array description: List of connected peers items: type: object properties: lastSyncBlock: type: string remainNum: type: integer lastBlockUpdateTime: type: integer syncFlag: type: boolean headBlockTimeWeBothHave: type: integer needSyncFromPeer: type: boolean needSyncFromUs: type: boolean host: type: string port: type: integer nodeId: type: string configNodeInfo: type: object description: Node configuration information properties: codeVersion: type: string p2pVersion: type: string listenPort: type: integer discoverEnable: type: boolean activeNodeSize: type: integer passiveNodeSize: type: integer sendNodeSize: type: integer maxConnectCount: type: integer sameIpMaxConnectCount: type: integer backupListenPort: type: integer backupMemberSize: type: integer backupPriority: type: integer dbVersion: type: integer minParticipationRate: type: integer supportConstant: type: boolean minTimeRatio: type: number maxTimeRatio: type: number allowCreationOfContracts: type: integer allowAdaptiveEnergy: type: integer machineInfo: type: object description: Machine and system information properties: threadCount: type: integer deadLockThreadCount: type: integer cpuCount: type: integer totalMemory: type: integer freeMemory: type: integer cpuRate: type: number javaVersion: type: string osName: type: string jvmTotalMemory: type: integer jvmFreeMemory: type: integer processCpuRate: type: number cheatWitnessInfoMap: type: object description: Information about witnesses flagged for cheating /getnowblock: post: tags: - General summary: Wallet/Getnowblock operationId: getNowBlock requestBody: required: false content: application/json: schema: type: object responses: '200': description: Current block information content: application/json: schema: type: object properties: blockID: type: string block_header: type: object properties: raw_data: type: object witness_signature: type: string transactions: type: array /getpaginatedassetissuelist: post: tags: - General summary: Wallet/Getpaginatedassetissuelist operationId: getPaginatedAssetIssueList requestBody: required: true content: application/json: schema: type: object properties: offset: type: number description: Number of records to skip from the beginning limit: type: number description: Maximum number of tokens to return required: - offset - limit example: offset: 0 limit: 20 responses: '200': description: Paginated list of TRC10 tokens content: application/json: schema: type: object properties: assetIssue: type: array description: Array of TRC10 token information items: type: object properties: id: type: string description: Unique token ID owner_address: type: string description: Address of token issuer name: type: string description: Token name in hex format abbr: type: string description: Token abbreviation in hex format total_supply: type: number description: Total supply of the token trx_num: type: number description: TRX amount in exchange ratio precision: type: number description: Token decimal places num: type: number description: Token amount in exchange ratio start_time: type: number description: Token sale start timestamp end_time: type: number description: Token sale end timestamp description: type: string description: Token description in hex format url: type: string description: Token website URL in hex format free_asset_net_limit: type: number description: Free bandwidth allocation per account public_free_asset_net_limit: type: number description: Total public free bandwidth limit frozen_supply: type: array description: Frozen token supply details /getpaginatedproposallist: post: tags: - General summary: Wallet/Getpaginatedproposallist operationId: getPaginatedProposalList requestBody: required: false content: application/json: schema: type: object properties: offset: type: integer default: 0 minimum: 0 limit: type: integer default: 10 minimum: 1 maximum: 100 responses: '200': description: Paginated list of proposals content: application/json: schema: type: object properties: proposals: type: array items: type: object properties: proposal_id: type: integer proposer_address: type: string parameters: type: object additionalProperties: type: integer expiration_time: type: integer create_time: type: integer approvals: type: array items: type: string state: type: string enum: - PENDING - DISAPPROVED - APPROVED - CANCELED /getpendingsize: get: tags: - General summary: Wallet/Getpendingsize operationId: getPendingSize responses: '200': description: Current size of the pending transaction pool content: application/json: schema: type: object properties: pendingSize: type: integer description: Number of pending transactions in the mempool example: 1247 /getproposalbyid: post: tags: - General summary: Wallet/Getproposalbyid operationId: getProposalById requestBody: required: true content: application/json: schema: type: object required: - id properties: id: type: integer default: 1 responses: '200': description: Proposal information content: application/json: schema: type: object properties: proposal_id: type: integer proposer_address: type: string parameters: type: object additionalProperties: type: integer expiration_time: type: integer create_time: type: integer approvals: type: array items: type: string state: type: string enum: - PENDING - DISAPPROVED - APPROVED - CANCELED /getreward: get: tags: - General summary: wallet/getReward operationId: getReward parameters: - name: address in: query required: true schema: type: string description: Account address in hex format (21-byte, starts with 41) example: 41b487cdb2d8dc7b2a8e5e7e7b4e3e8b8b8b8b8b responses: '200': description: Witness rewards information content: application/json: schema: type: object properties: reward: type: number description: Total reward amount in sun (1 TRX = 1,000,000 sun) example: reward: 1500000000 /gettransactionbyid: post: tags: - General summary: Wallet/Gettransactionbyid operationId: getTransactionById requestBody: required: true content: application/json: schema: type: object required: - value properties: value: type: string default: d5ec749ecc2a615399d6573b3550650b4e6606d9ff0d123cd5bdc0bc6a33b0a2 visible: type: boolean default: false responses: '200': description: Transaction details content: application/json: schema: type: object properties: ret: type: array items: type: object properties: contractRet: type: string fee: type: integer signature: type: array items: type: string txID: type: string net_usage: type: integer raw_data_hex: type: string net_fee: type: integer energy_usage: type: integer blockNumber: type: integer block_timestamp: type: integer contract_result: type: array items: type: string /gettransactionfrompending: post: tags: - General summary: Wallet/Gettransactionfrompending operationId: getTransactionFromPending requestBody: required: true content: application/json: schema: type: object properties: value: type: string description: Transaction ID hash of the pending transaction to retrieve required: - value example: value: f34f1c799700a9d83b67fdcadd7be697010a8dbbcd520de4ac46a648e3e7ae3d responses: '200': description: Specific pending transaction details content: application/json: schema: type: object properties: txID: type: string description: Unique transaction identifier hash example: f34f1c799700a9d83b67fdcadd7be697010a8dbbcd520de4ac46a648e3e7ae3d raw_data: type: object properties: contract: type: array description: Transaction contract details items: type: object properties: type: type: string example: TransferContract parameter: type: object properties: type_url: type: string example: type.googleapis.com/protocol.TransferContract value: type: object ref_block_bytes: type: string description: Reference block bytes for validation example: 6f80 ref_block_hash: type: string description: Hash of the reference block example: 1c9c4b8c43c5e0b1 expiration: type: integer description: Transaction expiration timestamp example: 1704067260000 timestamp: type: integer description: Transaction creation timestamp example: 1704067200000 fee_limit: type: integer description: Maximum fee allowed for this transaction example: 100000000 signature: type: array description: Array of transaction signatures items: type: string ret: type: array description: Transaction result information items: type: object properties: contractRet: type: string example: SUCCESS /gettransactioninfobyblocknum: post: tags: - General summary: Wallet/Gettransactioninfobyblocknum operationId: getTransactionInfoByBlockNum requestBody: required: true content: application/json: schema: type: object required: - num properties: num: type: integer default: 66677878 visible: type: boolean default: true responses: '200': description: Transaction information for all transactions in the block content: application/json: schema: type: array items: type: object properties: id: type: string fee: type: integer blockNumber: type: integer blockTimeStamp: type: integer contractResult: type: array items: type: string receipt: type: object log: type: array items: type: object /gettransactioninfobyid: post: tags: - General summary: Wallet/Gettransactioninfobyid operationId: getTransactionInfoById requestBody: required: true content: application/json: schema: type: object properties: value: type: string description: The transaction ID (hash) in hexadecimal format required: - value example: value: 4c85b7a5c6e1d5f6e1d5c6f7e1d5c6f7e1d5c6f7e1d5c6f7e1d5c6f7e1d5c6f7 responses: '200': description: Transaction receipt and execution information content: application/json: schema: type: object properties: id: type: string description: Transaction ID blockNumber: type: number description: Block number where transaction was included blockTimeStamp: type: number description: Block timestamp in milliseconds contractResult: type: array description: Smart contract execution results items: type: string contract_address: type: string description: Contract address if contract creation transaction receipt: type: object properties: energy_usage: type: number description: Energy consumed by the transaction energy_fee: type: number description: Energy fee in SUN origin_energy_usage: type: number description: Original energy usage energy_usage_total: type: number description: Total energy usage net_usage: type: number description: Bandwidth consumed net_fee: type: number description: Bandwidth fee in SUN result: type: string description: Transaction execution result log: type: array description: Event logs from smart contract execution items: type: object result: type: string description: Overall transaction result status resMessage: type: string description: Result message if transaction failed /gettransactionlistfrompending: get: tags: - General summary: Wallet/Gettransactionlistfrompending operationId: getTransactionListFromPending responses: '200': description: List of all pending transactions content: application/json: schema: type: object properties: transactions: type: array description: Array of pending transaction objects items: type: object properties: txID: type: string description: Unique transaction identifier hash example: f34f1c799700a9d83b67fdcadd7be697010a8dbbcd520de4ac46a648e3e7ae3d raw_data: type: object properties: contract: type: array description: Transaction contract details items: type: object properties: type: type: string example: TransferContract parameter: type: object ref_block_bytes: type: string description: Reference block bytes for validation example: 6f80 ref_block_hash: type: string description: Hash of the reference block example: 1c9c4b8c43c5e0b1 expiration: type: integer description: Transaction expiration timestamp example: 1704067260000 timestamp: type: integer description: Transaction creation timestamp example: 1704067200000 fee_limit: type: integer description: Maximum fee allowed for this transaction example: 100000000 signature: type: array description: Array of transaction signatures items: type: string ret: type: array description: Transaction result information items: type: object properties: contractRet: type: string example: SUCCESS /gettriggerinputforshieldedtrc20contract: post: tags: - General summary: Wallet/Gettriggerinputforshieldedtrc20Contract operationId: getTriggerInputForShieldedTRC20Contract requestBody: required: true content: application/json: schema: type: object required: - shielded_TRC20_Parameters - spend_authority_signature properties: shielded_TRC20_Parameters: type: object description: Shielded TRC20 transaction parameters required: - spend_description - binding_signature - message_hash - parameter_type properties: spend_description: type: array description: Array of spend descriptions for inputs items: type: object properties: value_commitment: type: string description: Value commitment (hex without 0x prefix) example: 219ed48bc4bfe14cc2953ab5027528353e177e2263479122ea97c609ce187986 anchor: type: string description: Merkle root of note commitment tree (hex without 0x prefix) example: c1dda86b7af8ce842e349347b364936baf24ad36be65046e2fd7349640bba873 nullifier: type: string description: Nullifier to prevent double spending (hex without 0x prefix) example: 79e938e0951d4d6cf6acd679fc6bb59147a6abc2f9e2828185328e93a83ab2f1 rk: type: string description: Public key for spend authorization signature verification (hex without 0x prefix) example: 99c0c1fbe3ad8a6e27d712632064fdeeb10952624c60a0ddcba0eb233bbf4e8b zkproof: type: string description: Zero-knowledge proof data (hex without 0x prefix) example: b536d0f442f6e0517930a9ccdb551c9e551a148c41fcf1e4748d1330d6c3e6f9 receive_description: type: array description: Array of receive descriptions for outputs (required for transfer operations) items: type: object properties: value_commitment: type: string description: Value commitment (hex without 0x prefix) example: 19ac352ba8d7f5167ef43a5b9c225056db2c44fb19f7fe8c63e0d2b956771656 note_commitment: type: string description: Note commitment (hex without 0x prefix) example: e40b9da38887963c8cd1e163b4b7d4b999502c32e1204b791242633aebcdbb6d epk: type: string description: Ephemeral public key (hex without 0x prefix) example: b1675f0b5331371466ff30d621991f0a30c9bc4d34c322be44619a0acf932905 c_enc: type: string description: Encrypted note ciphertext (hex without 0x prefix) example: b69f20ae969de55319d2b7617bf7351a4683098af1e7b16fa64d44ff758471f3 c_out: type: string description: Output ciphertext for auditing (hex without 0x prefix) example: 1e5333e35985d343697dcce92703c2536a861eb49722e1c83a112cf004006e9c zkproof: type: string description: Zero-knowledge proof data (hex without 0x prefix) example: a6b41694f8fa378886ef77d5bd07de56de55b9ad7c8438d05380dd5fa1ce2e7d binding_signature: type: string description: Binding signature for the transaction (hex without 0x prefix) example: c7f303709c57e49264fd5ae5922bf977ef2a57ccc84d746effc5c6937eecf36e05b09faf95e5f869aeaf1aa87b24570eb723a4d8c77edea32c31b2909c84eb04 message_hash: type: string description: Hash of the transaction message (hex without 0x prefix) example: 7fb99e66df052f430d50e80a3f197c319a4e35184ed48a433d6219e025741337 parameter_type: type: string description: Type of shielded operation enum: - mint - burn - transfer example: transfer spend_authority_signature: type: array description: Array of spend authority signatures, one for each spend description items: type: object properties: value: type: string description: Spend authorization signature (hex without 0x prefix) example: 66c806bc592a7599e65833bf25c3c7005c8b21b7895dd835a84c97d7bec49d0f1493d2c73a68eeb9b9699b92cae42406f9e44ebe19acaea3d5febfe28de57109 responses: '200': description: Successfully generated trigger input parameters content: application/json: schema: type: object properties: trigger_contract_input: type: string description: Formatted input data for triggering the shielded TRC20 contract example: a9059cbb000000000000000000000041... /isshieldedtrc20contractnotespent: post: tags: - General summary: Wallet/Isshieldedtrc20Contractnotespent operationId: isShieldedTRC20ContractNoteSpent requestBody: required: true content: application/json: schema: type: object required: - note - ak - nk - position - shielded_TRC20_contract_address properties: note: type: object description: The note to check for spending status required: - value - payment_address - rcm properties: value: type: integer description: Scaled value (multiplied by contract's scalingFactor) example: 40 payment_address: type: string description: Shielded payment address example: ztron1768kf7dy4qquefp46szk978d65eeua66yhr4zv260c0uzj68t3tfjl3en9lhyyfxalv4jus30xs rcm: type: string description: Random commitment trapdoor (64 hex characters, no 0x prefix) example: 296070782a94c6936b0b4f6daf8d7c7605a4374fe595b96148dc0f4b59015d0d ak: type: string description: Authorization key (64 hex characters, no 0x prefix) example: 8072d9110c9de9d9ade33d5d0f5890a7aa65b0cde42af7816d187297caf2fd64 nk: type: string description: Nullifier key (64 hex characters, no 0x prefix) example: 590bf33f93f792be659fd404df91e75c3b08d38d4e08ee226c3f5219cf598f14 position: type: integer description: Leaf position index in Merkle tree example: 272 shielded_TRC20_contract_address: type: string description: Shielded TRC20 contract address (hex format, no 0x prefix) example: 41274fc7464fadac5c00c893c58bce6c39bf59e4c7 responses: '200': description: Successfully checked nullifier spending status content: application/json: schema: type: object properties: is_spent: type: boolean description: Whether the note has been spent (true = spent, false = unspent) example: false /jsonrpc_eth_accounts: post: tags: - General summary: Eth_Accounts operationId: ethAccounts requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' method: type: string enum: - eth_accounts default: eth_accounts params: type: array items: {} default: [] id: oneOf: - type: string - type: integer default: 1 responses: '200': description: Array of addresses owned by the client content: application/json: schema: type: object properties: jsonrpc: type: string example: '2.0' id: oneOf: - type: string - type: integer example: 1 result: type: array description: Array of addresses owned by the client items: type: string example: - '0x407d73d8a49eeb85d32cf465507dd71d507100c1' /jsonrpc_eth_blocknumber: post: tags: - General summary: eth_blockNumber operationId: blockNumber requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_blockNumber id: type: integer default: 1 params: type: array default: [] items: {} responses: '200': description: Current block number in hexadecimal format content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string description: The current block number encoded as hexadecimal. /jsonrpc_eth_blocknumber_test: post: summary: eth_blockNumber requestBody: required: true content: application/json: schema: type: object properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_blockNumber params: type: array default: [] id: type: integer default: 1 responses: '200': description: Success content: application/json: schema: type: object tags: - General operationId: jsonrpc_eth_blocknumber_test /jsonrpc_eth_call: post: tags: - General summary: Eth_Call operationId: call requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_call id: type: integer default: 1 params: type: array default: - to: '0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b' data: '0x70a08231000000000000000000000000a94f5374fce5edbc8e2a8697c15331677e6ebf0b' - latest items: oneOf: - type: object description: Transaction object with to, from, gas, gasPrice, value, data fields - type: string description: Block parameter (latest, earliest, pending, or hex block number) minItems: 2 maxItems: 2 responses: '200': description: Return value of the executed contract function content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string description: The return value of the executed contract function as hex string /jsonrpc_eth_chainid: post: tags: - General summary: eth_chainId operationId: ethChainId requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' method: type: string enum: - eth_chainId default: eth_chainId params: type: array items: {} default: [] id: oneOf: - type: string - type: integer default: 1 responses: '200': description: Chain ID in hexadecimal format content: application/json: schema: type: object properties: jsonrpc: type: string example: '2.0' id: oneOf: - type: string - type: integer example: 1 result: type: string description: 'Chain ID as hexadecimal string (TRON mainnet: 0x2b6653dc, testnet: 0x94a9059e)' example: '0x2b6653dc' /jsonrpc_eth_coinbase: post: tags: - General summary: Eth_Coinbase operationId: ethCoinbase requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' method: type: string enum: - eth_coinbase default: eth_coinbase params: type: array items: {} default: [] id: oneOf: - type: string - type: integer default: 1 responses: '200': description: Coinbase address content: application/json: schema: type: object properties: jsonrpc: type: string example: '2.0' id: oneOf: - type: string - type: integer example: 1 result: type: string description: Coinbase address as hexadecimal string example: '0x407d73d8a49eeb85d32cf465507dd71d507100c1' /jsonrpc_eth_estimateGas: post: tags: - General summary: eth_estimateGas operationId: estimateGas requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_estimateGas id: type: integer default: 1 params: type: array default: - to: '0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b' from: '0xb60e8dd61c5d32be8058bb8eb970870f07233155' value: '0x9184e72a' items: type: object description: Transaction object with to, from, gas, gasPrice, value, data fields responses: '200': description: Estimated gas amount needed for the transaction content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string description: The estimated gas amount as hex string /jsonrpc_eth_gasPrice: post: tags: - General summary: eth_gasPrice operationId: gasPrice requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_gasPrice id: type: integer default: 1 params: type: array default: [] items: {} responses: '200': description: Current gas price in wei content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string description: The current gas price in wei as hex string /jsonrpc_eth_getBlockByHash: post: tags: - General summary: eth_getBlockByHash operationId: getBlockByHash requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_getBlockByHash id: type: integer default: 1 params: type: array default: - '0x1b4' - true items: oneOf: - type: string description: Block hash - type: boolean description: If true, return full transaction objects; if false, only hashes minItems: 2 maxItems: 2 responses: '200': description: Block information including transactions content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object description: Block object containing block information /jsonrpc_eth_getBlockByNumber: post: tags: - General summary: eth_getBlockByNumber operationId: getBlockByNumber requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_getBlockByNumber id: type: integer default: 1 params: type: array default: - latest - true items: oneOf: - type: string description: Block number in hex or 'latest'|'earliest'|'pending' - type: boolean description: If true, return full transaction objects; if false, only hashes minItems: 2 maxItems: 2 responses: '200': description: Block information including transactions content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object description: Block object containing block information /jsonrpc_eth_getBlockTransactionCountByHash: post: tags: - General summary: eth_getBlockTransactionCountByHash operationId: ethGetBlockTransactionCountByHash requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' method: type: string enum: - eth_getBlockTransactionCountByHash default: eth_getBlockTransactionCountByHash params: type: array items: type: string default: - '0x00000000020ef11c87517739090601aa0a7be1de6faebf35ddb14e7ab7d1cc5b' id: oneOf: - type: string - type: integer default: 1 responses: '200': description: Number of transactions in the specified block content: application/json: schema: type: object properties: jsonrpc: type: string example: '2.0' id: oneOf: - type: string - type: integer example: 1 result: type: string description: Number of transactions in the block as hexadecimal example: '0x1' /jsonrpc_eth_getBlockTransactionCountByNumber: post: tags: - General summary: eth_getBlockTransactionCountByNumber operationId: ethGetBlockTransactionCountByNumber requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' method: type: string enum: - eth_getBlockTransactionCountByNumber default: eth_getBlockTransactionCountByNumber params: type: array items: type: string default: - '0xF96B0F' id: oneOf: - type: string - type: integer default: 1 responses: '200': description: Number of transactions in the specified block content: application/json: schema: type: object properties: jsonrpc: type: string example: '2.0' id: oneOf: - type: string - type: integer example: 1 result: type: string description: Number of transactions in the block as hexadecimal example: '0x2' /jsonrpc_eth_getCode: post: tags: - General summary: eth_getCode operationId: getCode requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_getCode id: type: integer default: 1 params: type: array default: - '0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b' - latest items: type: string minItems: 2 maxItems: 2 responses: '200': description: Contract bytecode at the specified address content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string description: Contract bytecode as hex string (returns '0x' for non-contract addresses) /jsonrpc_eth_getFilterChanges: post: tags: - General summary: eth_getFilterChanges operationId: getFilterChanges requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_getFilterChanges id: type: integer default: 71 params: type: array default: - '0xc11a84d5e906ecb9f5c1eb65ee940b154ad37dce8f5ac29c80764508b901d996' items: type: string description: The filter ID returned by eth_newFilter or eth_newBlockFilter responses: '200': description: Array of log objects or block hashes since last poll content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array description: Array of log objects (for log filters) or block hashes (for block filters) items: {} /jsonrpc_eth_getFilterLogs: post: tags: - General summary: eth_getFilterLogs operationId: getFilterLogs requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_getFilterLogs id: type: integer default: 71 params: type: array default: - '0xc11a84d5e906ecb9f5c1eb65ee940b154ad37dce8f5ac29c80764508b901d996' items: type: string description: The filter ID returned by eth_newFilter responses: '200': description: Array of all log objects matching the filter criteria content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array description: Array of all log objects that match the filter criteria items: {} /jsonrpc_eth_getLogs: post: tags: - General summary: eth_getLogs operationId: getLogs requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_getLogs id: type: integer default: 1 params: type: array default: - fromBlock: '0x1' toBlock: '0x2' address: '0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b' topics: - '0x000000000000000000000000a94f5374fce5edbc8e2a8697c15331677e6ebf0b' items: type: object description: Filter object with fromBlock, toBlock, address, and topics responses: '200': description: Array of log objects matching the filter criteria content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: array description: Array of log objects matching the filter criteria /jsonrpc_eth_getStorageAt: post: tags: - General summary: eth_getStorageAt operationId: getStorageAt requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_getStorageAt id: type: integer default: 1 params: type: array default: - '0x407d73d8a49eeb85d32cf465507dd71d507100c1' - '0x0' - latest items: type: string minItems: 3 maxItems: 3 responses: '200': description: Storage value at the specified position content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string description: The value at the storage position as hex string /jsonrpc_eth_getTransactionByBlockHashAndIndex: post: tags: - General summary: eth_getTransactionByBlockHashAndIndex operationId: ethGetTransactionByBlockHashAndIndex requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' method: type: string enum: - eth_getTransactionByBlockHashAndIndex default: eth_getTransactionByBlockHashAndIndex params: type: array items: type: string default: - 00000000020ef11c87517739090601aa0a7be1de6faebf35ddb14e7ab7d1cc5b - '0x0' minItems: 2 maxItems: 2 id: oneOf: - type: string - type: integer default: 64 responses: '200': description: Transaction object or null if not found content: application/json: schema: type: object properties: jsonrpc: type: string example: '2.0' id: oneOf: - type: string - type: integer example: 64 result: type: object nullable: true description: Transaction object with Ethereum-compatible fields or null /jsonrpc_eth_getTransactionByBlockNumberAndIndex: post: tags: - General summary: eth_getTransactionByBlockNumberAndIndex operationId: ethGetTransactionByBlockNumberAndIndex requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' method: type: string enum: - eth_getTransactionByBlockNumberAndIndex default: eth_getTransactionByBlockNumberAndIndex params: type: array items: type: string default: - '0xfb82f0' - '0x0' minItems: 2 maxItems: 2 id: oneOf: - type: string - type: integer default: 64 responses: '200': description: Transaction object or null if not found content: application/json: schema: type: object properties: jsonrpc: type: string example: '2.0' id: oneOf: - type: string - type: integer example: 64 result: type: object nullable: true description: Transaction object with Ethereum-compatible fields or null /jsonrpc_eth_getTransactionByHash: post: tags: - General summary: eth_getTransactionByHash operationId: getTransactionByHash requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_getTransactionByHash id: type: integer default: 1 params: type: array default: - '0x88df016429689c079f3b2f6ad39fa052532c56795b733da78a91ebe6a713944b' items: type: string description: Transaction hash responses: '200': description: Transaction information content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object description: Transaction object containing transaction details /jsonrpc_eth_getTransactionReceipt: post: tags: - General summary: eth_getTransactionReceipt operationId: getTransactionReceipt requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_getTransactionReceipt id: type: integer default: 1 params: type: array default: - '0x88df016429689c079f3b2f6ad39fa052532c56795b733da78a91ebe6a713944b' items: type: string description: Transaction hash responses: '200': description: Transaction receipt including execution results and logs content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: object description: Receipt object containing transaction execution results /jsonrpc_eth_getWork: post: tags: - General summary: eth_getWork operationId: ethGetWork requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' method: type: string enum: - eth_getWork default: eth_getWork params: type: array items: {} default: [] minItems: 0 maxItems: 0 id: oneOf: - type: string - type: integer default: 73 responses: '200': description: Work data or null if not available content: application/json: schema: type: object properties: jsonrpc: type: string example: '2.0' id: oneOf: - type: string - type: integer example: 73 result: type: array nullable: true description: Array containing [current block hash, seed hash, boundary condition] or null items: type: string /jsonrpc_eth_getbalance: post: tags: - General summary: eth_getBalance operationId: getBalance requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_getBalance id: type: integer default: 1 params: type: array default: - '0x407d73d8a49eeb85d32cf465507dd71d507100c1' - latest items: type: string minItems: 2 maxItems: 2 responses: '200': description: Account balance in wei (hexadecimal format) content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string description: The account balance in wei as hexadecimal string /jsonrpc_eth_newBlockFilter: post: tags: - General summary: eth_newBlockFilter operationId: newBlockFilter requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_newBlockFilter id: type: integer default: 1 params: type: array default: [] items: {} description: Empty array - no parameters required responses: '200': description: Filter ID for use with other filter methods content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string description: A filter ID (hex-encoded string) for use with other filter methods /jsonrpc_eth_newFilter: post: tags: - General summary: eth_newFilter operationId: newFilter requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_newFilter id: type: integer default: 1 params: type: array default: - address: - cc2e32f2388f0096fae9b055acffd76d4b3e5532 - E518C608A37E2A262050E10BE0C9D03C7A0877F3 fromBlock: '0x989680' toBlock: '0x9959d0' topics: - '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef' - null - - '0x0000000000000000000000001806c11be0f9b9af9e626a58904f3e5827b67be7' - '0x0000000000000000000000003c8fb6d064ceffc0f045f7b4aee6b3a4cefb4758' items: type: object description: Filter object with address, fromBlock, toBlock, and topics responses: '200': description: Filter ID for use with other filter methods content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string description: A filter ID (hex-encoded string) for use with other filter methods /jsonrpc_eth_protocolVersion: post: tags: - General summary: eth_protocolVersion operationId: ethProtocolVersion requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' method: type: string enum: - eth_protocolVersion default: eth_protocolVersion params: type: array items: {} default: [] id: oneOf: - type: string - type: integer default: 64 responses: '200': description: Current Ethereum protocol version content: application/json: schema: type: object properties: jsonrpc: type: string example: '2.0' id: oneOf: - type: string - type: integer example: 64 result: type: string description: Ethereum protocol version as hexadecimal string example: '0x41' /jsonrpc_eth_syncing: post: tags: - General summary: Eth_Syncing operationId: ethSyncing requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - params - id properties: jsonrpc: type: string enum: - '2.0' default: '2.0' method: type: string enum: - eth_syncing default: eth_syncing params: type: array items: {} default: [] id: oneOf: - type: string - type: integer default: 64 responses: '200': description: Sync status object or false if not syncing content: application/json: schema: type: object properties: jsonrpc: type: string example: '2.0' id: oneOf: - type: string - type: integer example: 64 result: oneOf: - type: boolean description: False if not syncing example: false - type: object description: Sync status object properties: startingBlock: type: string description: Block at which sync started currentBlock: type: string description: Current block being processed highestBlock: type: string description: Highest known block /jsonrpc_eth_uninstallFilter: post: tags: - General summary: eth_uninstallFilter operationId: uninstallFilter requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: eth_uninstallFilter id: type: integer default: 71 params: type: array default: - '0xc11a84d5e906ecb9f5c1eb65ee940b154ad37dce8f5ac29c80764508b901d996' items: type: string description: The filter ID returned by eth_newFilter or eth_newBlockFilter minItems: 1 maxItems: 1 responses: '200': description: Boolean indicating whether the filter was successfully uninstalled content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: boolean description: True if the filter was successfully uninstalled, false otherwise /jsonrpc_net_listening: post: tags: - General summary: Net_Listening operationId: netListening requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: net_listening id: type: integer default: 64 params: type: array default: [] items: {} description: Empty array - no parameters required responses: '200': description: Boolean indicating whether the client is listening for connections content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: boolean description: True if the client is actively listening for network connections, false otherwise /jsonrpc_net_peerCount: post: tags: - General summary: net_peerCount operationId: netPeerCount requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: net_peerCount id: type: integer default: 64 params: type: array default: [] items: {} description: Empty array - no parameters required responses: '200': description: Hex-encoded number of connected peers content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string description: Hex-encoded string representing the number of connected peers /jsonrpc_net_version: post: tags: - General summary: Net_Version operationId: netVersion requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id properties: jsonrpc: type: string default: '2.0' method: type: string default: net_version id: type: integer default: 1 params: type: array default: [] items: {} responses: '200': description: Current network ID content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string description: The network ID as a string /jsonrpc_web3_clientVersion: post: tags: - General summary: web3_clientVersion operationId: web3ClientVersion requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: web3_clientVersion id: type: integer default: 1 params: type: array default: [] items: {} description: Empty array - no parameters required responses: '200': description: Client version string content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string description: String containing the client version information /jsonrpc_web3_sha3: post: tags: - General summary: Web3_Sha3 operationId: web3Sha3 requestBody: required: true content: application/json: schema: type: object required: - jsonrpc - method - id - params properties: jsonrpc: type: string default: '2.0' method: type: string default: web3_sha3 id: type: integer default: 1 params: type: array default: - '0x68656c6c6f20776f726c64' items: type: string description: Hex-encoded data to be hashed responses: '200': description: Keccak-256 hash of the input data content: application/json: schema: type: object properties: jsonrpc: type: string id: type: integer result: type: string description: Hex-encoded Keccak-256 hash of the input data /listexchanges: post: summary: List all trading pairs on the decentralized exchange description: Retrieves a list of all trading pairs available on the TRON decentralized exchange operationId: listExchanges requestBody: required: true content: application/json: schema: type: object properties: visible: type: boolean description: Whether to return human-readable addresses default: false examples: default: summary: Default request value: visible: true responses: '200': description: Successful response with list of exchanges content: application/json: schema: type: object properties: exchanges: type: array items: type: object properties: exchange_id: type: integer description: Unique identifier for the exchange pair creator_address: type: string description: Address that created the exchange pair create_time: type: integer description: Timestamp when the exchange was created first_token_id: type: string description: Token ID of the first token in the pair first_token_balance: type: string description: Current balance of the first token second_token_id: type: string description: Token ID of the second token in the pair second_token_balance: type: string description: Current balance of the second token examples: success: summary: Successful response value: exchanges: - exchange_id: 1 creator_address: TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH create_time: 1672531200000 first_token_id: '1000001' first_token_balance: '1000000000000' second_token_id: _ second_token_balance: '5000000000' - exchange_id: 2 creator_address: TKcEU8ekq2ZoFzLSGBSC2xps5c4yssLYVB create_time: 1672617600000 first_token_id: '1000002' first_token_balance: '500000000000' second_token_id: '1000001' second_token_balance: '2000000000000' '400': description: Bad request content: application/json: schema: type: object properties: Error: type: string examples: error: summary: Error response value: Error: Invalid request format tags: - General /listnodes: post: tags: - General summary: Wallet/Listnodes operationId: listNodes requestBody: required: false content: application/json: schema: type: object properties: {} responses: '200': description: List of network nodes content: application/json: schema: type: object properties: nodes: type: array items: type: object properties: address: type: object properties: host: type: string port: type: integer /listproposals: post: tags: - General summary: Wallet/Listproposals operationId: listProposals requestBody: required: false content: application/json: schema: type: object properties: {} responses: '200': description: List of all proposals content: application/json: schema: type: object properties: proposals: type: array items: type: object properties: proposal_id: type: integer proposer_address: type: string parameters: type: object additionalProperties: type: integer expiration_time: type: integer create_time: type: integer approvals: type: array items: type: string state: type: string enum: - PENDING - DISAPPROVED - APPROVED - CANCELED /listwitnesses: post: tags: - General summary: Wallet/Listwitnesses operationId: listWitnesses requestBody: required: false content: application/json: schema: type: object responses: '200': description: List of all witnesses on the network content: application/json: schema: type: object properties: witnesses: type: array description: Array of witness information items: type: object properties: address: type: string description: Witness address in hex format voteCount: type: number description: Total votes received by this witness pubKey: type: string description: Public key of the witness url: type: string description: Witness website URL totalProduced: type: number description: Total blocks produced by this witness totalMissed: type: number description: Total blocks missed by this witness latestBlockNum: type: number description: Latest block number produced latestSlotNum: type: number description: Latest slot number assigned isJobs: type: boolean description: Whether witness is currently active /marketbuyasset: post: tags: - General summary: Wallet/Marketbuyasset operationId: marketBuyAsset deprecated: true requestBody: required: true content: application/json: schema: type: object properties: owner_address: type: string description: Account address placing the buy order sell_token_id: type: string description: TRC10 token ID being offered, as a numeric string. sell_token_quantity: type: integer description: Amount to offer as an integer (token base units; if TRX, sun). buy_token_id: type: string description: TRC10 token ID desired to purchase, as a numeric string. buy_token_quantity: type: integer description: Desired amount as an integer (token base units; if TRX, sun). visible: type: boolean description: When true, addresses are base58; when false, hex. default: true required: - owner_address - sell_token_id - sell_token_quantity - buy_token_id - buy_token_quantity example: owner_address: THPvaUhoh2Qn2y9THCZML3H815hhFhn5YC sell_token_id: '1000006' sell_token_quantity: 100000000 buy_token_id: '1002000' buy_token_quantity: 1000000 visible: true responses: '200': description: Market buy order transaction content: application/json: schema: type: object properties: visible: type: boolean description: Whether addresses are in visible format txID: type: string description: Transaction ID for buy order raw_data: type: object properties: contract: type: array description: Contract details for market buy order ref_block_bytes: type: string description: Reference block bytes ref_block_hash: type: string description: Reference block hash expiration: type: number description: Transaction expiration timestamp timestamp: type: number description: Transaction creation timestamp raw_data_hex: type: string description: Raw transaction data in hex format /marketcancelorder: post: tags: - General summary: Wallet/Marketcancelorder operationId: marketCancelOrder requestBody: required: true content: application/json: schema: type: object properties: owner_address: type: string description: Account address that created the order order_id: type: string description: Unique identifier of the order to cancel (hex string, no 0x prefix) required: - owner_address - order_id example: owner_address: 41b487cdb2d8dc7b2a8e5e7e7b4e3e8b8b8b8b8b order_id: 1234567890abcdef1234567890abcdef12345678 responses: '200': description: Order cancellation transaction content: application/json: schema: type: object properties: visible: type: boolean description: Whether addresses are in visible format txID: type: string description: Transaction ID for order cancellation raw_data: type: object properties: contract: type: array description: Contract details for order cancellation ref_block_bytes: type: string description: Reference block bytes ref_block_hash: type: string description: Reference block hash expiration: type: number description: Transaction expiration timestamp timestamp: type: number description: Transaction creation timestamp raw_data_hex: type: string description: Raw transaction data in hex format /marketsellasset: post: tags: - General summary: Wallet/Marketsellasset operationId: marketSellAsset requestBody: required: true content: application/json: schema: type: object properties: owner_address: type: string description: Account address placing the sell order sell_token_id: type: string description: Token ID being sold (empty string for TRX) sell_token_quantity: type: integer description: Quantity of tokens to sell (integer in token base units; if TRX, sun) buy_token_id: type: string description: Token ID desired in exchange (empty string for TRX) buy_token_quantity: type: integer description: Quantity of tokens desired in exchange (integer in token base units; if TRX, sun) visible: type: boolean description: When true, addresses are base58; when false, hex. default: true required: - owner_address - sell_token_id - sell_token_quantity - buy_token_id - buy_token_quantity example: owner_address: THPvaUhoh2Qn2y9THCZML3H815hhFhn5YC sell_token_id: '1000006' sell_token_quantity: 1000000 buy_token_id: '1002000' buy_token_quantity: 1000000 visible: true responses: '200': description: Market sell order transaction content: application/json: schema: type: object properties: visible: type: boolean description: Whether addresses are in visible format txID: type: string description: Transaction ID for sell order raw_data: type: object properties: contract: type: array description: Contract details for market sell order ref_block_bytes: type: string description: Reference block bytes ref_block_hash: type: string description: Reference block hash expiration: type: number description: Transaction expiration timestamp timestamp: type: number description: Transaction creation timestamp raw_data_hex: type: string description: Raw transaction data in hex format /participateassetissue: post: tags: - General summary: Wallet/Participateassetissue operationId: participateAssetIssue requestBody: required: true content: application/json: schema: type: object required: - owner_address - to_address - asset_name - amount properties: owner_address: type: string description: Address participating in token offering default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g to_address: type: string description: Token issuer address default: TFgY1uN8buRxAtV2r6Zy5sG3ACko6pJT1y asset_name: type: string description: Name or ID of the TRC10 token default: MyToken amount: type: integer description: Amount of TRX to spend on tokens default: 1000000 visible: type: boolean description: Use base58 address format default: true responses: '200': description: Unsigned participate asset issue transaction content: application/json: schema: type: object properties: visible: type: boolean description: Address format indicator txID: type: string description: Transaction hash raw_data: type: object description: Raw transaction data properties: contract: type: array description: Contract array ref_block_bytes: type: string description: Reference block bytes ref_block_hash: type: string description: Reference block hash expiration: type: number description: Transaction expiration timestamp timestamp: type: number description: Transaction creation timestamp raw_data_hex: type: string description: Hexadecimal raw transaction /proposalapprove: post: tags: - General summary: Wallet/Proposalapprove operationId: proposalApprove requestBody: required: true content: application/json: schema: type: object required: - owner_address - proposal_id - is_add_approval properties: owner_address: type: string default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g proposal_id: type: integer default: 1 is_add_approval: type: boolean default: true visible: type: boolean default: true responses: '200': description: Proposal approval transaction content: application/json: schema: type: object properties: txID: type: string raw_data: type: object properties: contract: type: array ref_block_bytes: type: string ref_block_hash: type: string expiration: type: integer timestamp: type: integer raw_data_hex: type: string signature: type: array items: type: string /proposalcreate: post: tags: - General summary: Wallet/Proposalcreate operationId: proposalCreate requestBody: required: true content: application/json: schema: type: object required: - owner_address - parameters properties: owner_address: type: string default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g parameters: type: object properties: '0': type: integer description: Parameter ID and its new value default: '0': 3000000 visible: type: boolean default: true responses: '200': description: Proposal creation transaction content: application/json: schema: type: object properties: txID: type: string raw_data: type: object properties: contract: type: array ref_block_bytes: type: string ref_block_hash: type: string expiration: type: integer timestamp: type: integer raw_data_hex: type: string signature: type: array items: type: string /proposaldelete: post: tags: - General summary: Wallet/Proposaldelete operationId: proposalDelete requestBody: required: true content: application/json: schema: type: object required: - owner_address - proposal_id properties: owner_address: type: string default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g proposal_id: type: integer default: 1 visible: type: boolean default: true responses: '200': description: Proposal deletion transaction content: application/json: schema: type: object properties: txID: type: string raw_data: type: object properties: contract: type: array ref_block_bytes: type: string ref_block_hash: type: string expiration: type: integer timestamp: type: integer raw_data_hex: type: string signature: type: array items: type: string /shielded_createshieldedtransaction: post: tags: - General summary: Wallet/Createshieldedtransaction operationId: createShieldedTransaction requestBody: required: true content: application/json: schema: type: object required: - to_address - to_amount properties: transparent_from_address: type: string description: Transparent TRX address sending funds example: TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE from_amount: type: integer description: Amount to send from transparent address in sun example: 1000000 spend_authority_signature: type: array description: Array of spending authority signatures items: type: string ask: type: string description: Authentication secret key (64 hex characters, no 0x prefix) example: 08a1b2c3d4e5f6789012345678901234567890123456789012345678901234567890 nsk: type: string description: Nullifier secret key (64 hex characters, no 0x prefix) example: 09a1b2c3d4e5f6789012345678901234567890123456789012345678901234567890 ovk: type: string description: Outgoing viewing key (64 hex characters, no 0x prefix) example: 0aa1b2c3d4e5f6789012345678901234567890123456789012345678901234567890 to_address: type: string description: Recipient shielded address example: ztron1a2b3c4d5e6f7g8h9j0k1l2m3n4p5q6r7s8t9u0v1w2x3y4z5a6b7c8d9e0f1g2h3j4k5l6m7n8p9 to_amount: type: integer description: Amount to send to shielded address in sun example: 1000000 responses: '200': description: Successfully created shielded transaction content: application/json: schema: type: object properties: txID: type: string description: Transaction ID hash (64 hex characters, no 0x prefix) example: 1a2b3c4d5e6f7890abcdef1234567890abcdef1234567890abcdef1234567890 raw_data_hex: type: string description: Raw transaction data in hexadecimal raw_data: type: object description: Structured raw transaction data /shielded_createshieldedtransactionwithoutspendauthsig: post: tags: - General summary: Wallet/Createshieldedtransactionwithoutspendauthsig operationId: createShieldedTransactionWithoutSpendAuthSig requestBody: required: true content: application/json: schema: type: object required: - to_address - to_amount properties: transparent_from_address: type: string description: Transparent TRX address sending funds example: TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE from_amount: type: integer description: Amount to send from transparent address in sun example: 1000000 shielded_spends: type: array description: Array of shielded input specifications items: type: object shielded_receives: type: array description: Array of shielded output specifications items: type: object to_address: type: string description: Recipient shielded address example: ztron1a2b3c4d5e6f7g8h9j0k1l2m3n4p5q6r7s8t9u0v1w2x3y4z5a6b7c8d9e0f1g2h3j4k5l6m7n8p9 to_amount: type: integer description: Amount to send to shielded address in sun example: 1000000 responses: '200': description: Successfully created unsigned shielded transaction content: application/json: schema: type: object properties: raw_data_hex: type: string description: Raw unsigned transaction data in hexadecimal raw_data: type: object description: Structured raw unsigned transaction data txID: type: string description: Preliminary transaction ID (will change after signing, 64 hex characters, no 0x prefix) example: 1a2b3c4d5e6f7890abcdef1234567890abcdef1234567890abcdef1234567890 /shielded_getakfromask: post: tags: - General summary: Wallet/Getakfromask operationId: getAkFromAsk requestBody: required: true content: application/json: schema: type: object required: - value properties: value: type: string description: Authentication secret key (ask) as a 32‑byte (64‑hex) string without 0x prefix. pattern: ^[0-9a-fA-F]{64}$ example: 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef responses: '200': description: Successfully derived authentication key content: application/json: schema: type: object properties: value: type: string description: The derived authentication key (ak) in hexadecimal format (no 0x prefix) example: 03b2c3d4e5f6789012345678901234567890123456789abcdef0123456789abcd /shielded_getdiversifier: post: tags: - General summary: Wallet/Getdiversifier operationId: getDiversifier requestBody: required: true content: application/json: schema: type: object properties: {} responses: '200': description: Successfully generated diversifier content: application/json: schema: type: object properties: d: type: string description: The generated diversifier in hexadecimal format (22 hex characters, no 0x prefix) example: 06e5f678901234567890ab /shielded_getexpandedspendingkey: post: tags: - General summary: Wallet/Getexpandedspendingkey operationId: getExpandedSpendingKey requestBody: required: true content: application/json: schema: type: object required: - value properties: value: type: string description: Spending key as a 32‑byte (64‑hex) string without 0x prefix. pattern: ^[0-9a-fA-F]{64}$ example: 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef responses: '200': description: Successfully derived expanded spending key content: application/json: schema: type: object properties: ask: type: string description: Authentication secret key component nsk: type: string description: Nullifier secret key component ovk: type: string description: Outgoing viewing key component /shielded_getincomingviewingkey: post: tags: - General summary: Wallet/Getincomingviewingkey operationId: getIncomingViewingKey requestBody: required: true content: application/json: schema: type: object required: - ak - nk properties: ak: type: string description: Authentication key (ak) as a 32‑byte (64‑hex) string without 0x prefix. pattern: ^[0-9a-fA-F]{64}$ example: 03b2c3d4e5f67890123456789012345678901234567890123456789012345678 nk: type: string description: Nullifier key (nk) as a 32‑byte (64‑hex) string without 0x prefix. pattern: ^[0-9a-fA-F]{64}$ example: 04c3d4e5f6789012345678901234567890123456789012345678901234567890 responses: '200': description: Successfully derived incoming viewing key content: application/json: schema: type: object properties: ivk: type: string description: The derived incoming viewing key (ivk) in hexadecimal format (no 0x prefix) example: 05d4e5f6789012345678901234567890123456789012345678901234567890abcdef /shielded_getnkfromnsk: post: tags: - General summary: Wallet/Getnkfromnsk operationId: getNkFromNsk requestBody: required: true content: application/json: schema: type: object required: - value properties: value: type: string description: Nullifier secret key (nsk) as a 32‑byte (64‑hex) string without 0x prefix. pattern: ^[0-9a-fA-F]{64}$ example: abcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcd responses: '200': description: Successfully derived nullifier key content: application/json: schema: type: object properties: value: type: string description: The derived nullifier key (nk) in hexadecimal format (no 0x prefix) example: 04b2c3d4e5f6789012345678901234567890123456789abcdef0123456789abcd /shielded_getshieldedpaymentaddress: post: tags: - General summary: Wallet/Getshieldedpaymentaddress operationId: getShieldedPaymentAddress requestBody: required: true content: application/json: schema: type: object required: - ivk - d properties: ivk: type: string description: Incoming viewing key (ivk) as a 32‑byte (64‑hex) string without 0x prefix. pattern: ^[0-9a-fA-F]{64}$ example: 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef d: type: string description: Diversifier as 11 bytes (22 hex) without 0x prefix. pattern: ^[0-9a-fA-F]{22}$ example: 06a1b2c3d4e5f6789012ab responses: '200': description: Successfully generated shielded payment address content: application/json: schema: type: object properties: pkd: type: string description: The payment address public key in hexadecimal format (no 0x prefix) example: 07a1b2c3d4e5f6789012345678901234567890123456789012345678901234567890 payment_address: type: string description: The complete shielded payment address example: ztron1a2b3c4d5e6f7g8h9j0k1l2m3n4p5q6r7s8t9u0v1w2x3y4z5a6b7c8d9e0f1g2h3j4k5l6m7n8p9 /shielded_getspendingkey: post: tags: - General summary: Wallet/Getspendingkey operationId: getSpendingKey requestBody: required: true content: application/json: schema: type: object properties: {} responses: '200': description: Successfully generated spending key content: application/json: schema: type: object properties: value: type: string description: The generated spending key in hexadecimal format (64 hex characters, no 0x prefix) example: 02a1b2c3d4e5f67890123456789012345678901234567890123456789012345678 /shielded_getzenpaymentaddress: post: tags: - General summary: Wallet/Getzenpaymentaddress operationId: getZenPaymentAddress requestBody: required: true content: application/json: schema: type: object required: - ivk - d properties: ivk: type: string description: Incoming viewing key (ivk) as a 32‑byte (64‑hex) string without 0x prefix. pattern: ^[0-9a-fA-F]{64}$ example: 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef d: type: string description: Diversifier as 11 bytes (22 hex) without 0x prefix. pattern: ^[0-9a-fA-F]{22}$ example: 06e5f67890123456789012 responses: '200': description: Successfully generated shielded payment address content: application/json: schema: type: object properties: pkD: type: string description: Payment address public key component in hex (no 0x) example: 07f6789012345678901234567890123456789012345678901234567890abcdef01 payment_address: type: string description: Complete shielded payment address example: ztron1abcdefghijk123456789... /shielded_scanshieldedtrc20notesbyivk: post: tags: - General summary: Wallet/Scanshieldedtrc20Notesbyivk operationId: scanShieldedTRC20NotesByIvk requestBody: required: true content: application/json: schema: type: object required: - start_block_index - end_block_index - ivk - ak - nk - shielded_TRC20_contract_address properties: start_block_index: type: integer description: Starting block number for scanning example: 10000000 end_block_index: type: integer description: Ending block number for scanning example: 10000001 ivk: type: string description: Incoming viewing key for decrypting notes (64 hex characters, no 0x prefix) example: 9f8e74bb3d7188a2781dc1db38810c6914eef4570a79e8ec8404480948e4e305 ak: type: string description: Authentication key for verification (64 hex characters, no 0x prefix) example: 8072d9110c9de9d9ade33d5d0f5890a7aa65b0cde42af7816d187297caf2fd64 nk: type: string description: Nullifier key for note identification (64 hex characters, no 0x prefix) example: 590bf33f93f792be659fd404df91e75c3b08d38d4e08ee226c3f5219cf598f14 shielded_TRC20_contract_address: type: string description: Shielded TRC20 contract address to scan (hex format, no 0x prefix) example: 41274fc7464fadac5c00c893c58bce6c39bf59e4c7 responses: '200': description: Successfully scanned for shielded notes content: application/json: schema: type: object properties: noteTxs: type: array description: Array of found shielded note transactions items: type: object properties: txid: type: string description: Transaction ID containing the note index: type: integer description: Index of note within transaction note: type: object description: Decrypted note details properties: value: type: integer description: Note value payment_address: type: string description: Shielded payment address rcm: type: string description: Randomness commitment memo: type: string description: Optional memo field position: type: integer description: Position in the merkle tree is_spent: type: boolean description: Whether the note has been spent /shielded_scanshieldedtrc20notesbyovk: post: tags: - General summary: Wallet/Scanshieldedtrc20Notesbyovk operationId: scanShieldedTRC20NotesByOvk requestBody: required: true content: application/json: schema: type: object required: - start_block_index - end_block_index - ovk - shielded_TRC20_contract_address properties: start_block_index: type: integer description: Starting block number for scanning example: 10000000 end_block_index: type: integer description: Ending block number for scanning example: 10000001 ovk: type: string description: Outgoing viewing key for decrypting sent notes (64 hex characters, no 0x prefix) example: 0ff58efd75e083fe4fd759c8701e1c8cb6961c4297a12b2c800bdb7b2bcab889 shielded_TRC20_contract_address: type: string description: Shielded TRC20 contract address to scan (hex format, no 0x prefix) example: 41274fc7464fadac5c00c893c58bce6c39bf59e4c7 responses: '200': description: Successfully scanned for outgoing shielded notes content: application/json: schema: type: object properties: noteTxs: type: array description: Array of found outgoing shielded note transactions items: type: object properties: txid: type: string description: Transaction ID containing the note index: type: integer description: Index of note within transaction note: type: object description: Decrypted note details properties: value: type: integer description: Note value payment_address: type: string description: Recipient shielded payment address rcm: type: string description: Randomness commitment memo: type: string description: Optional memo field position: type: integer description: Position in the merkle tree is_spent: type: boolean description: Whether the note has been spent /test_jsonrpc: post: summary: Test method responses: '200': description: Success tags: - General operationId: test_jsonrpc /transferasset: post: tags: - General summary: Wallet/Transferasset operationId: transferAsset requestBody: required: true content: application/json: schema: type: object required: - owner_address - to_address - asset_name - amount properties: owner_address: type: string default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g to_address: type: string default: TFgY1uN8buRxAtV2r6Zy5sG3ACko6pJT1y asset_name: type: string default: TOKEN_NAME amount: type: integer default: 1000000 visible: type: boolean default: true responses: '200': description: Unsigned TRC10 asset transfer transaction content: application/json: schema: type: object properties: visible: type: boolean txID: type: string raw_data: type: object raw_data_hex: type: string /triggerconstantcontract: post: tags: - General summary: Wallet/Triggerconstantcontract operationId: triggerConstantContract requestBody: required: true content: application/json: schema: type: object properties: owner_address: type: string description: Address calling the contract method in hex format contract_address: type: string description: Smart contract address in hex format function_selector: type: string description: Function selector (method signature) to call parameter: type: string description: Encoded parameters for the function call required: - contract_address - function_selector example: owner_address: 41b487cdb2d8dc7b2a8e5e7e7b4e3e8b8b8b8b8b contract_address: 41a614f803b6fd780986a42c78ec9c7f77e6ded13c function_selector: balanceOf(address) parameter: 000000000000000000000000b487cdb2d8dc7b2a8e5e7e7b4e3e8b8b8b8b8b responses: '200': description: Contract call result content: application/json: schema: type: object properties: result: type: object properties: result: type: boolean description: Whether the call was successful energy_used: type: number description: Energy that would be consumed (for estimation) constant_result: type: array description: Return values from the contract method call items: type: string transaction: type: object description: Transaction object that would be created (not executed) /triggersmartcontract: post: tags: - General summary: Wallet/Triggersmartcontract operationId: triggerSmartContract requestBody: required: true content: application/json: schema: type: object required: - contract_address - function_selector - parameter - owner_address properties: contract_address: type: string default: 41a614f803b6fd780986a42c78ec9c7f77e6ded13c function_selector: type: string default: transfer(address,uint256) parameter: type: string default: 000000000000000000000000e9d79cc47518930bc322d9bf7cddd260a0260a8d00000000000000000000000000000000000000000000000000000000000003e8 owner_address: type: string default: 41608f8da72479edc7dd921e4c30bb7e7cddbe722e call_value: type: integer default: 0 fee_limit: type: integer default: 10000000 visible: type: boolean default: false responses: '200': description: Smart contract execution result content: application/json: schema: type: object properties: result: type: object properties: result: type: boolean code: type: string message: type: string energy_used: type: integer constant_result: type: array items: type: string transaction: type: object logs: type: array /undelegateresource: post: tags: - General summary: Wallet/Undelegateresource operationId: undelegateResource requestBody: required: true content: application/json: schema: type: object required: - owner_address - receiver_address - balance - resource properties: owner_address: type: string default: 41608f8da72479edc7dd921e4c30bb7e7cddbe722e receiver_address: type: string default: 41e552f6487585c2b58bc2c9bb4492bc1f17132cd0 balance: type: integer default: 1000000 resource: type: string enum: - BANDWIDTH - ENERGY default: BANDWIDTH visible: type: boolean default: false responses: '200': description: Undelegate resource transaction content: application/json: schema: type: object properties: visible: type: boolean txID: type: string raw_data: type: object properties: contract: type: array ref_block_bytes: type: string ref_block_hash: type: string expiration: type: integer timestamp: type: integer raw_data_hex: type: string /unfreezeasset: post: tags: - General summary: Wallet/Unfreezeasset operationId: unfreezeAsset requestBody: required: true content: application/json: schema: type: object required: - owner_address properties: owner_address: type: string description: Address that issued the token default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g visible: type: boolean description: Use base58 address format default: true responses: '200': description: Unsigned unfreeze asset transaction content: application/json: schema: type: object properties: visible: type: boolean description: Address format indicator txID: type: string description: Transaction hash raw_data: type: object description: Raw transaction data properties: contract: type: array description: Contract array ref_block_bytes: type: string description: Reference block bytes ref_block_hash: type: string description: Reference block hash expiration: type: number description: Transaction expiration timestamp timestamp: type: number description: Transaction creation timestamp raw_data_hex: type: string description: Hexadecimal raw transaction /unfreezebalance: post: tags: - General summary: Wallet/Unfreezebalance operationId: unfreezeBalance deprecated: true requestBody: required: true content: application/json: schema: type: object required: - owner_address - resource properties: owner_address: type: string default: 41608f8da72479edc7dd921e4c30bb7e7cddbe722e resource: type: string enum: - BANDWIDTH - ENERGY default: BANDWIDTH receiver_address: type: string description: Optional. Address that was receiving the resources. Omit to unfreeze to yourself. Must not equal `owner_address`. visible: type: boolean default: false example: owner_address: 41608f8da72479edc7dd921e4c30bb7e7cddbe722e resource: BANDWIDTH visible: false responses: '200': description: Unfreeze balance transaction content: application/json: schema: type: object properties: visible: type: boolean txID: type: string raw_data: type: object properties: contract: type: array ref_block_bytes: type: string ref_block_hash: type: string expiration: type: integer timestamp: type: integer raw_data_hex: type: string '400': description: Validation error (bad receiver address) content: application/json: schema: type: object properties: Error: type: string example: Error: 'class org.tron.core.exception.ContractValidateException : receiverAddress must not be the same as ownerAddress' /unfreezebalancev2: post: tags: - General summary: Wallet/Unfreezebalancev2 operationId: unfreezeBalanceV2 requestBody: required: true content: application/json: schema: type: object required: - owner_address - unfreeze_balance - resource properties: owner_address: type: string default: 41608f8da72479edc7dd921e4c30bb7e7cddbe722e unfreeze_balance: type: integer default: 1000000 resource: type: string enum: - BANDWIDTH - ENERGY default: BANDWIDTH visible: type: boolean default: false responses: '200': description: Unfreeze balance v2 transaction content: application/json: schema: type: object properties: visible: type: boolean txID: type: string raw_data: type: object properties: contract: type: array ref_block_bytes: type: string ref_block_hash: type: string expiration: type: integer timestamp: type: integer raw_data_hex: type: string /updateaccount: post: tags: - General summary: Wallet/Updateaccount operationId: updateAccount requestBody: required: true content: application/json: schema: type: object required: - owner_address - account_name properties: owner_address: type: string default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g account_name: type: string default: '0x7570646174654e616d6531353330383933343635353139' visible: type: boolean default: true responses: '200': description: Unsigned account update transaction content: application/json: schema: type: object properties: visible: type: boolean txID: type: string raw_data: type: object raw_data_hex: type: string /updateasset: post: tags: - General summary: Wallet/Updateasset operationId: updateAsset requestBody: required: true content: application/json: schema: type: object required: - owner_address - description - url properties: owner_address: type: string description: Address that issued the token default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g description: type: string description: New token description default: Updated description for the TRC10 token url: type: string description: New token project website default: https://updated-example.com new_limit: type: integer description: New bandwidth limit for token operations default: 2000000 new_public_limit: type: integer description: New public bandwidth limit default: 2000000 visible: type: boolean description: Use base58 address format default: true responses: '200': description: Unsigned update asset transaction content: application/json: schema: type: object properties: visible: type: boolean description: Address format indicator txID: type: string description: Transaction hash raw_data: type: object description: Raw transaction data properties: contract: type: array description: Contract array ref_block_bytes: type: string description: Reference block bytes ref_block_hash: type: string description: Reference block hash expiration: type: number description: Transaction expiration timestamp timestamp: type: number description: Transaction creation timestamp raw_data_hex: type: string description: Hexadecimal raw transaction /updatebrokerage: post: tags: - General summary: wallet/updateBrokerage operationId: updateBrokerage requestBody: required: true content: application/json: schema: type: object properties: owner_address: type: string description: 'Witness account address. Use base58 with `visible: true`, or hex with `visible: false`.' brokerage: type: number description: New brokerage percentage (0-100) visible: type: boolean description: When true, addresses are base58; when false, hex. default: true required: - owner_address - brokerage example: owner_address: THPvaUhoh2Qn2y9THCZML3H815hhFhn5YC brokerage: 15 visible: true responses: '200': description: Brokerage update transaction content: application/json: schema: type: object properties: visible: type: boolean description: Whether addresses are in visible format txID: type: string description: Transaction ID for the brokerage update raw_data: type: object properties: contract: type: array description: Contract details for brokerage update ref_block_bytes: type: string description: Reference block bytes ref_block_hash: type: string description: Reference block hash expiration: type: number description: Transaction expiration timestamp timestamp: type: number description: Transaction creation timestamp raw_data_hex: type: string description: Raw transaction data in hex format /updateenergylimit: post: tags: - General summary: Wallet/Updateenergylimit operationId: updateEnergyLimit requestBody: required: true content: application/json: schema: type: object properties: owner_address: type: string description: Address of the contract owner contract_address: type: string description: Address of the smart contract origin_energy_limit: type: number description: Maximum energy amount the contract creator provides (energy units) visible: type: boolean description: Whether to use visible (Base58) address format required: - owner_address - contract_address - origin_energy_limit example: owner_address: THPvaUhoh2Qn2y9THCZML3H815hhFhn5YC contract_address: TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t origin_energy_limit: 100000000 visible: true responses: '200': description: Contract energy limit update transaction content: application/json: schema: type: object properties: visible: type: boolean description: Whether addresses are in visible format txID: type: string description: Transaction ID for the energy limit update raw_data: type: object properties: contract: type: array description: Contract update details ref_block_bytes: type: string description: Reference block bytes ref_block_hash: type: string description: Reference block hash expiration: type: number description: Transaction expiration timestamp timestamp: type: number description: Transaction creation timestamp raw_data_hex: type: string description: Raw transaction data in hex format '400': description: Validation error (e.g., account not found or not owner) content: application/json: schema: type: object properties: Error: type: string example: Error: 'class org.tron.core.exception.ContractValidateException : Account[41b3dcf27c251da9363f1a4888257c16676cf54edf] does not exist' /updatesetting: post: tags: - General summary: Wallet/Updatesetting operationId: updateSetting requestBody: required: true content: application/json: schema: type: object properties: owner_address: type: string description: Address of the contract owner contract_address: type: string description: Address of the smart contract consume_user_resource_percent: type: number description: Percentage (0-100) of caller's resources to consume minimum: 0 maximum: 100 visible: type: boolean description: Whether to use visible (Base58) address format required: - owner_address - contract_address - consume_user_resource_percent example: owner_address: THPvaUhoh2Qn2y9THCZML3H815hhFhn5YC contract_address: TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t consume_user_resource_percent: 10 visible: true responses: '200': description: Contract setting update transaction content: application/json: schema: type: object properties: visible: type: boolean description: Whether addresses are in visible format txID: type: string description: Transaction ID for the setting update raw_data: type: object properties: contract: type: array description: Contract update details ref_block_bytes: type: string description: Reference block bytes ref_block_hash: type: string description: Reference block hash expiration: type: number description: Transaction expiration timestamp timestamp: type: number description: Transaction creation timestamp raw_data_hex: type: string description: Raw transaction data in hex format '400': description: Validation error (e.g., account not found or not owner) content: application/json: schema: type: object properties: Error: type: string example: Error: 'class org.tron.core.exception.ContractValidateException : Account[41b3dcf27c251da9363f1a4888257c16676cf54edf] does not exist' /updatewitness: post: tags: - General summary: Wallet/Updatewitness operationId: updateWitness requestBody: required: true content: application/json: schema: type: object properties: owner_address: type: string description: Hexadecimal address of the witness account to update update_url: type: string description: New URL string for the witness (maximum 256 bytes) visible: type: boolean description: Whether addresses should be in visible format (Base58Check) required: - owner_address example: owner_address: TPswDDCAWhJAZGdHPidFg5nEf8TkNToDX1 update_url: https://example.com/witness visible: true responses: '200': description: Witness update transaction content: application/json: schema: type: object properties: visible: type: boolean description: Whether addresses are in visible format txID: type: string description: Transaction ID for witness update transaction raw_data: type: object properties: contract: type: array description: Contract details for witness update items: type: object properties: type: type: string example: UpdateWitnessContract parameter: type: object properties: type_url: type: string example: type.googleapis.com/protocol.UpdateWitnessContract value: type: object properties: owner_address: type: string update_url: type: string ref_block_bytes: type: string description: Reference block bytes for validation ref_block_hash: type: string description: Hash of the reference block expiration: type: integer description: Transaction expiration timestamp timestamp: type: integer description: Transaction creation timestamp raw_data_hex: type: string description: Raw transaction data in hex format /votewitnessaccount: post: tags: - General summary: Wallet/Votewitnessaccount operationId: voteWitnessAccount requestBody: required: true content: application/json: schema: type: object properties: owner_address: type: string description: 'Voting account address. Use base58 with `visible: true`, or hex with `visible: false`.' votes: type: array description: Array of vote allocations items: type: object properties: vote_address: type: string description: 'Witness address to vote for (base58 with `visible: true`, or hex with `visible: false`).' vote_count: type: number description: Number of votes to allocate required: - vote_address - vote_count visible: type: boolean description: When true, addresses are base58; when false, hex. default: true required: - owner_address - votes example: owner_address: THPvaUhoh2Qn2y9THCZML3H815hhFhn5YC votes: - vote_address: TDdeM7G4HSxhn2MfovsiMWwXZkiFaHhjMB vote_count: 1000000 - vote_address: TAybtvPZCSj5kumiU4myD28xBy6WFtkgCu vote_count: 500000 visible: true responses: '200': description: Vote transaction for witnesses content: application/json: schema: type: object properties: visible: type: boolean description: Whether addresses are in visible format txID: type: string description: Transaction ID for the vote raw_data: type: object properties: contract: type: array description: Contract details for witness voting ref_block_bytes: type: string description: Reference block bytes ref_block_hash: type: string description: Reference block hash expiration: type: number description: Transaction expiration timestamp timestamp: type: number description: Transaction creation timestamp raw_data_hex: type: string description: Raw transaction data in hex format /walletsolidity_getaccount: post: tags: - General summary: Walletsolidity/Getaccount operationId: getSolidityAccount requestBody: required: true content: application/json: schema: type: object required: - address properties: address: type: string default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g visible: type: boolean default: true responses: '200': description: Account information from solidified database content: application/json: schema: type: object properties: account_name: type: string address: type: string balance: type: integer create_time: type: integer latest_opration_time: type: integer asset: type: object assetV2: type: array items: type: object frozen: type: array items: type: object net_usage: type: object energy_usage: type: object owner_permission: type: object witness_permission: type: object active_permission: type: array items: type: object /walletsolidity_getblockbyid: post: tags: - General summary: Walletsolidity/Getblockbyid operationId: getSolidityBlockById requestBody: required: true content: application/json: schema: type: object required: - value properties: value: type: string description: Block ID (hash) in hexadecimal format example: 0000000004326f801c9c4b8c43c5e0b1f5e7b4c4a8ff6d02ab53a26d2344a5c1 responses: '200': description: Solidified block information content: application/json: schema: type: object properties: blockID: type: string description: Block hash identifier example: 0000000004326f801c9c4b8c43c5e0b1f5e7b4c4a8ff6d02ab53a26d2344a5c1 block_header: type: object properties: raw_data: type: object properties: number: type: integer example: 70000000 txTrieRoot: type: string example: d41c56e7e8b4a9d4e7c8c7b4f3e6d5a2b1c9d8e7f6a5b4c3d2e1f0e9d8c7b6 parentHash: type: string example: 0000000004326f7f2c9c4b8c43c5e0b1f5e7b4c4a8ff6d02ab53a26d2344a5c0 timestamp: type: integer example: 1704067200000 witness_address: type: string example: 41e38c95e0d7e9b68f7c8f7b4d3e6a5c2b1f9e8d7c6b5a4f3e2d1c0b9a8 witness_signature: type: string description: Witness signature for the block transactions: type: array description: Array of transactions in the block items: type: object properties: txID: type: string raw_data: type: object signature: type: array items: type: string blockSize: type: integer description: Size of the block in bytes example: 1024 /walletsolidity_getblockbylatestnum: post: tags: - General summary: Walletsolidity/Getblockbylatestnum operationId: getSolidityBlockByLatestNum requestBody: required: true content: application/json: schema: type: object required: - num properties: num: type: integer description: Number of latest blocks to retrieve example: 5 minimum: 1 maximum: 100 responses: '200': description: Array of the latest solidified blocks content: application/json: schema: type: object properties: block: type: array items: type: object properties: blockID: type: string description: Block hash identifier block_header: type: object properties: raw_data: type: object properties: number: type: integer timestamp: type: integer parentHash: type: string witness_address: type: string witness_signature: type: string transactions: type: array description: Transactions in the block items: type: object blockSize: type: integer description: Size of the block in bytes /walletsolidity_getblockbylimitnext: post: tags: - General summary: Walletsolidity/Getblockbylimitnext operationId: getSolidityBlockByLimitNext requestBody: required: true content: application/json: schema: type: object required: - startNum - endNum properties: startNum: type: integer description: Starting block number example: 70000000 endNum: type: integer description: Ending block number example: 70000010 responses: '200': description: Array of solidified blocks in the specified range content: application/json: schema: type: object properties: block: type: array items: type: object properties: blockID: type: string description: Block hash identifier block_header: type: object properties: raw_data: type: object properties: number: type: integer timestamp: type: integer parentHash: type: string witness_address: type: string witness_signature: type: string transactions: type: array description: Transactions in the block items: type: object blockSize: type: integer description: Size of the block in bytes /walletsolidity_getblockbynum: post: tags: - General summary: Walletsolidity/Getblockbynum operationId: getSolidityBlockByNum requestBody: required: true content: application/json: schema: type: object required: - num properties: num: type: integer description: Block number to retrieve example: 70000000 responses: '200': description: Solidified block information content: application/json: schema: type: object properties: blockID: type: string description: Block hash identifier example: 0000000004326f801c9c4b8c43c5e0b1f5e7b4c4a8ff6d02ab53a26d2344a5c1 block_header: type: object properties: raw_data: type: object properties: number: type: integer example: 70000000 txTrieRoot: type: string example: d41c56e7e8b4a9d4e7c8c7b4f3e6d5a2b1c9d8e7f6a5b4c3d2e1f0e9d8c7b6 parentHash: type: string example: 0000000004326f7f2c9c4b8c43c5e0b1f5e7b4c4a8ff6d02ab53a26d2344a5c0 timestamp: type: integer example: 1704067200000 witness_address: type: string example: 41e38c95e0d7e9b68f7c8f7b4d3e6a5c2b1f9e8d7c6b5a4f3e2d1c0b9a8 witness_signature: type: string description: Witness signature for the block transactions: type: array description: Array of transactions in the block items: type: object properties: txID: type: string raw_data: type: object signature: type: array items: type: string blockSize: type: integer description: Size of the block in bytes example: 1024 /walletsolidity_getnowblock: post: tags: - General summary: Walletsolidity/Getnowblock operationId: getSolidityNowBlock requestBody: required: false content: application/json: schema: type: object properties: {} responses: '200': description: Current solidified block information content: application/json: schema: type: object properties: blockID: type: string description: Current block hash identifier example: 0000000004326f801c9c4b8c43c5e0b1f5e7b4c4a8ff6d02ab53a26d2344a5c1 block_header: type: object properties: raw_data: type: object properties: number: type: integer example: 70000000 description: Current block number txTrieRoot: type: string example: d41c56e7e8b4a9d4e7c8c7b4f3e6d5a2b1c9d8e7f6a5b4c3d2e1f0e9d8c7b6 parentHash: type: string example: 0000000004326f7f2c9c4b8c43c5e0b1f5e7b4c4a8ff6d02ab53a26d2344a5c0 timestamp: type: integer example: 1704067200000 description: Current block timestamp witness_address: type: string example: 41e38c95e0d7e9b68f7c8f7b4d3e6a5c2b1f9e8d7c6b5a4f3e2d1c0b9a8 witness_signature: type: string description: Witness signature for the current block transactions: type: array description: Transactions in the current block items: type: object properties: txID: type: string raw_data: type: object signature: type: array items: type: string blockSize: type: integer description: Size of the current block in bytes example: 1024 /walletsolidity_gettransactionbyid: post: tags: - General summary: Walletsolidity/Gettransactionbyid operationId: getSolidityTransactionById requestBody: required: true content: application/json: schema: type: object required: - value properties: value: type: string default: 7c2d4206c38a026616067b2f80e3d4bb2d4b7f9ff90db8c98e8b7a89b7c8d3d visible: type: boolean default: true responses: '200': description: Transaction information from solidified database content: application/json: schema: type: object properties: ret: type: array items: type: object signature: type: array items: type: string txID: type: string raw_data: type: object raw_data_hex: type: string /walletsolidity_gettransactioncountbyblocknum: post: tags: - General summary: Walletsolidity/Gettransactioncountbyblocknum operationId: getSolidityTransactionCountByBlockNum requestBody: required: true content: application/json: schema: type: object required: - num properties: num: type: integer description: Block number to get transaction count for example: 70000000 minimum: 0 responses: '200': description: Transaction count in the specified solidified block content: application/json: schema: type: object properties: count: type: integer description: Number of transactions in the block example: 42 blockNumber: type: integer description: Block number queried example: 70000000 /walletsolidity_gettransactioninfobyid: post: tags: - General summary: Walletsolidity/Gettransactioninfobyid operationId: getSolidityTransactionInfoById requestBody: required: true content: application/json: schema: type: object required: - value properties: value: type: string description: Transaction ID (hash) in hexadecimal format example: 7c2d4206c59cc541d4b7eb7a0001bce8a7a77d1a2e3b5c4f7a8b9c0d1e2f3a4b responses: '200': description: Transaction execution information from solidified blocks content: application/json: schema: type: object properties: id: type: string description: Transaction hash identifier example: 7c2d4206c59cc541d4b7eb7a0001bce8a7a77d1a2e3b5c4f7a8b9c0d1e2f3a4b blockNumber: type: integer description: Block number containing the transaction example: 70000000 blockTimeStamp: type: integer description: Block timestamp example: 1704067200000 contractResult: type: array description: Contract execution results items: type: string fee: type: integer description: Transaction fee paid in sun example: 1100000 result: type: string description: Transaction execution result example: SUCCESS enum: - SUCCESS - REVERT - OUT_OF_TIME - OUT_OF_ENERGY resMessage: type: string description: Result message if transaction failed receipt: type: object description: Transaction receipt with resource usage properties: energy_usage: type: integer example: 65000 energy_fee: type: integer example: 1100000 net_usage: type: integer example: 345 net_fee: type: integer example: 0 log: type: array description: Event logs generated by the transaction items: type: object properties: address: type: string topics: type: array items: type: string data: type: string /withdrawbalance: post: tags: - General summary: Wallet/Withdrawbalance operationId: withdrawBalance requestBody: required: true content: application/json: schema: type: object properties: owner_address: type: string description: Address of the Super Representative withdrawing rewards visible: type: boolean description: Whether to use visible (Base58) address format required: - owner_address example: owner_address: TGj1Ej1qRzL9feLTLhjwgxXF4Ct6GTWg2U visible: true responses: '200': description: Witness balance withdrawal transaction content: application/json: schema: type: object properties: visible: type: boolean description: Whether addresses are in visible format txID: type: string description: Transaction ID for the withdrawal raw_data: type: object properties: contract: type: array description: Withdrawal contract details ref_block_bytes: type: string description: Reference block bytes ref_block_hash: type: string description: Reference block hash expiration: type: number description: Transaction expiration timestamp timestamp: type: number description: Transaction creation timestamp raw_data_hex: type: string description: Raw transaction data in hex format /withdrawexpireunfreeze: post: tags: - General summary: Wallet/Withdrawexpireunfreeze operationId: withdrawExpireUnfreeze requestBody: required: true content: application/json: schema: type: object required: - owner_address properties: owner_address: type: string default: 41608f8da72479edc7dd921e4c30bb7e7cddbe722e visible: type: boolean default: false responses: '200': description: Withdraw expired unfreeze transaction content: application/json: schema: type: object properties: visible: type: boolean txID: type: string raw_data: type: object properties: contract: type: array ref_block_bytes: type: string ref_block_hash: type: string expiration: type: integer timestamp: type: integer raw_data_hex: type: string /zks_L1BatchNumber: post: summary: zks_L1BatchNumber | zkSync Era operationId: zks_L1BatchNumber requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JsonRpcRequestForL1BatchNumber' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/JsonRpcResponseForL1BatchNumber' tags: - General /zks_L1ChainId: post: summary: zks_L1ChainId | zkSync Era operationId: zks_L1ChainId requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JsonRpcRequestForL1ChainId' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/JsonRpcResponseForL1ChainId' tags: - General /zks_estimateFee: post: summary: zks_estimateFee example operationId: zks_estimateFee requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JsonRpcRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/JsonRpcResponse' tags: - General /zks_estimateGasL1ToL2: post: summary: zks_estimateGasL1ToL2 | zkSync Era operationId: zks_estimateGasL1ToL2 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JsonRpcRequestGasL1ToL2' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/JsonRpcResponseGasL1ToL2' tags: - General /zks_getAllAccountBalances: post: summary: zks_getAllAccountBalances | zkSync Era operationId: zks_getAllAccountBalances requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JsonRpcRequestForBalances' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/JsonRpcResponseForBalances' tags: - General /zks_getBlockDetails: post: summary: zks_getBlockDetails | zkSync Era operationId: zks_getBlockDetails requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JsonRpcRequestForBlockDetails' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/JsonRpcResponseForBlockDetails' tags: - General /zks_getBridgeContracts: post: summary: zks_getBridgeContracts | zkSync Era operationId: zks_getBridgeContracts requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JsonRpcRequestForBridgeContracts' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/JsonRpcResponseForBridgeContracts' tags: - General /zks_getBytecodeByHash: post: summary: zks_getBytecodeByHash | zkSync Era operationId: zks_getBytecodeByHash requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JsonRpcRequestForBytecodeByHash' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/JsonRpcResponseForBytecodeByHash' tags: - General /zks_getL1BatchBlockRange: post: summary: zks_getL1BatchBlockRange | zkSync Era operationId: zks_getL1BatchBlockRange requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JsonRpcRequestForL1BatchBlockRange' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/JsonRpcResponseForL1BatchBlockRange' tags: - General /zks_getL1BatchDetails: post: summary: zks_getL1BatchDetails | zkSync Era operationId: zks_getL1BatchDetails requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JsonRpcRequestForL1BatchDetails' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/JsonRpcResponseForL1BatchDetails' tags: - General /zks_getL2ToL1LogProof: post: summary: zks_getL2ToL1LogProof | zkSync Era operationId: zks_getL2ToL1LogProof requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JsonRpcRequestForL2ToL1LogProof' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/JsonRpcResponseForL2ToL1LogProof' tags: - General /zks_getMainContract: post: summary: zks_getMainContract | zkSync Era operationId: zks_getMainContract requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JsonRpcRequestForMainContract' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/JsonRpcResponseForMainContract' tags: - General /zks_getRawBlockTransactions: post: summary: zks_getRawBlockTransactions | zkSync Era operationId: zks_getRawBlockTransactions requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JsonRpcRequestForRawBlockTransactions' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/JsonRpcResponseForRawBlockTransactions' tags: - General /zks_getTestnetPaymaster: post: summary: zks_getTestnetPaymaster | zkSync Era operationId: zks_getTestnetPaymaster requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JsonRpcRequestForTestnetPaymaster' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/JsonRpcResponseForTestnetPaymaster' tags: - General /zks_getTransactionDetails: post: summary: zks_getTransactionDetails | zkSync Era operationId: zks_getTransactionDetails requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JsonRpcRequestForTransactionDetails' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/JsonRpcResponseForTransactionDetails' tags: - General components: schemas: JsonRpcResponseForBytecodeByHash: type: object required: - jsonrpc - id - result properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer default: 1 result: type: string description: The bytecode of the transaction. JsonRpcRequestGasL1ToL2: type: object required: - jsonrpc - id - method - params properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer example: 2 default: 2 method: type: string example: zks_estimateGasL1ToL2 default: zks_estimateGasL1ToL2 params: type: array default: - from: '0x7AeD074cA56F5050D5A2E512eCc5bf7103937d76' to: '0x6B7f71BB1f5B74fB0Ff82cf4EA20A5F90d43E509' data: 0x items: type: object properties: from: type: string example: '0x7AeD074cA56F5050D5A2E512eCc5bf7103937d76' default: '0x7AeD074cA56F5050D5A2E512eCc5bf7103937d76' to: type: string example: '0x6B7f71BB1f5B74fB0Ff82cf4EA20A5F90d43E509' default: '0x6B7f71BB1f5B74fB0Ff82cf4EA20A5F90d43E509' data: type: string example: 0x default: 0x JsonRpcResponseForL1BatchDetails: type: object required: - jsonrpc - id - result properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer default: 1 result: type: object properties: batchId: type: integer description: The ID of the L1 batch. transactions: type: array items: type: object properties: txHash: type: string from: type: string to: type: string value: type: string gasUsed: type: integer status: type: string description: The status of the L1 batch. submissionTime: type: string format: date-time description: The submission time of the L1 batch. JsonRpcRequestForMainContract: type: object required: - jsonrpc - id - method - params properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer example: 1 default: 1 method: type: string example: zks_getMainContract default: zks_getMainContract params: type: array default: [] JsonRpcResponseForL2ToL1LogProof: type: object required: - jsonrpc - id - result properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer default: 1 result: type: object properties: logProof: type: object description: The log proof information. properties: blockNumber: type: integer description: The block number. logIndex: type: integer description: The log index within the block. transactionHash: type: string description: The transaction hash associated with the log. logEntries: type: array items: type: string description: Log entry data. JsonRpcRequestForTransactionDetails: type: object required: - jsonrpc - id - method - params properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer example: 1 default: 1 method: type: string example: zks_getTransactionDetails default: zks_getTransactionDetails params: type: array default: - '0x721ee3e8774620c2bd2add404efbd58563b592be75ad12a96684c24b95dce0d2' items: type: string example: '0x721ee3e8774620c2bd2add404efbd58563b592be75ad12a96684c24b95dce0d2' default: '0x721ee3e8774620c2bd2add404efbd58563b592be75ad12a96684c24b95dce0d2' JsonRpcRequestForBalances: type: object required: - jsonrpc - id - method - params properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer example: 1 default: 1 method: type: string example: zks_getAllAccountBalances default: zks_getAllAccountBalances params: type: array default: - '0xB240316e290e976e31f1557b3B312Dd698efac4c' items: type: string example: '0xB240316e290e976e31f1557b3B312Dd698efac4c' default: '0xB240316e290e976e31f1557b3B312Dd698efac4c' JsonRpcRequestForL1BatchNumber: type: object required: - jsonrpc - id - method - params properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer example: 1 default: 1 method: type: string example: zks_L1BatchNumber default: zks_L1BatchNumber params: type: array default: [] JsonRpcResponseForBridgeContracts: type: object required: - jsonrpc - id - result properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer default: 1 result: type: object properties: bridgeContractAddresses: type: object additionalProperties: type: string JsonRpcRequestForL1ChainId: type: object required: - jsonrpc - id - method - params properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer example: 1 default: 1 method: type: string example: zks_L1ChainId default: zks_L1ChainId params: type: array default: [] JsonRpcRequestForL1BatchBlockRange: type: object required: - jsonrpc - id - method - params properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer example: 1 default: 1 method: type: string example: zks_getL1BatchBlockRange default: zks_getL1BatchBlockRange params: type: array default: - 443314 items: type: integer example: 443314 default: 443314 JsonRpcResponseForL1BatchBlockRange: type: object required: - jsonrpc - id - result properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer default: 1 result: type: object properties: startBlock: type: integer description: The starting block number of the L1 batch. endBlock: type: integer description: The ending block number of the L1 batch. JsonRpcResponseForL1ChainId: type: object required: - jsonrpc - id - result properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer default: 1 result: type: object properties: chainId: type: integer description: The chain ID of Layer 1. JsonRpcResponseForTransactionDetails: type: object required: - jsonrpc - id - result properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer default: 1 result: type: object properties: txDetails: type: object description: The details of the transaction. JsonRpcResponseForTestnetPaymaster: type: object required: - jsonrpc - id - result properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer default: 1 result: type: object properties: paymasterAddress: type: string description: The address of the testnet paymaster. JsonRpcRequestForBytecodeByHash: type: object required: - jsonrpc - id - method - params properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer example: 1 default: 1 method: type: string example: zks_getBytecodeByHash default: zks_getBytecodeByHash params: type: array default: - '0x0100067d861e2f5717a12c3e869cfb657793b86bbb0caa05cc1421f16c5217bc' items: type: string example: '0x0100067d861e2f5717a12c3e869cfb657793b86bbb0caa05cc1421f16c5217bc' default: '0x0100067d861e2f5717a12c3e869cfb657793b86bbb0caa05cc1421f16c5217bc' JsonRpcResponse: type: object required: - jsonrpc - id - result properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer default: 2 result: type: object additionalProperties: true JsonRpcResponseGasL1ToL2: type: object required: - jsonrpc - id - result properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer default: 2 result: type: object additionalProperties: true JsonRpcResponseForRawBlockTransactions: type: object required: - jsonrpc - id - result properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer default: 1 result: type: array items: type: object properties: transactions_details: type: object description: The details of transactions in the block. JsonRpcRequestForBridgeContracts: type: object required: - jsonrpc - id - method - params properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer example: 1 default: 1 method: type: string example: zks_getBridgeContracts default: zks_getBridgeContracts params: type: array default: [] items: {} FELT: type: string title: Field element description: A field element. represented by at most 63 hex digits pattern: ^0x(0|[a-fA-F1-9]{1}[a-fA-F0-9]{0,62})$ JsonRpcResponseForBlockDetails: type: object required: - jsonrpc - id - result properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer default: 1 result: type: object properties: blockNumber: type: integer blockHash: type: string parentHash: type: string transactions: type: array items: type: object properties: txHash: type: string from: type: string to: type: string value: type: string gasUsed: type: integer JsonRpcRequest: type: object required: - jsonrpc - id - method - params properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer example: 2 default: 2 method: type: string example: zks_estimateFee default: zks_estimateFee params: type: array default: - from: '0x7AeD074cA56F5050D5A2E512eCc5bf7103937d76' to: '0x6B7f71BB1f5B74fB0Ff82cf4EA20A5F90d43E509' data: 0x items: type: object properties: from: type: string example: '0x7AeD074cA56F5050D5A2E512eCc5bf7103937d76' default: '0x7AeD074cA56F5050D5A2E512eCc5bf7103937d76' to: type: string example: '0x6B7f71BB1f5B74fB0Ff82cf4EA20A5F90d43E509' default: '0x6B7f71BB1f5B74fB0Ff82cf4EA20A5F90d43E509' data: type: string example: 0x default: 0x JsonRpcResponseForMainContract: type: object required: - jsonrpc - id - result properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer default: 1 result: type: object properties: contractAddress: type: string description: The address of zkSync main contract on L1. JsonRpcRequestForL1BatchDetails: type: object required: - jsonrpc - id - method - params properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer example: 1 default: 1 method: type: string example: zks_getL1BatchDetails default: zks_getL1BatchDetails params: type: array default: - 443314 items: type: integer example: 443314 default: 443314 JsonRpcResponseForBalances: type: object required: - jsonrpc - id - result properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer default: 1 result: type: object additionalProperties: type: object properties: balance: type: string symbol: type: string decimals: type: integer JsonRpcRequestForBlockDetails: type: object required: - jsonrpc - id - method - params properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer example: 1 default: 1 method: type: string example: zks_getBlockDetails default: zks_getBlockDetails params: type: array default: - 27163792 items: type: integer example: 27163792 default: 27163792 JsonRpcRequestForL2ToL1LogProof: type: object required: - jsonrpc - id - method - params properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer example: 1 default: 1 method: type: string example: zks_getL2ToL1LogProof default: zks_getL2ToL1LogProof params: type: array default: - '0xf8a7e5649718e84649a4caa93f5e537704a6a0e8769a7dbbe4de967ba14fc748' items: type: string example: '0xf8a7e5649718e84649a4caa93f5e537704a6a0e8769a7dbbe4de967ba14fc748' default: '0xf8a7e5649718e84649a4caa93f5e537704a6a0e8769a7dbbe4de967ba14fc748' JsonRpcRequestForTestnetPaymaster: type: object required: - jsonrpc - id - method - params properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer example: 1 default: 1 method: type: string example: zks_getTestnetPaymaster default: zks_getTestnetPaymaster params: type: array default: [] JsonRpcRequestForRawBlockTransactions: type: object required: - jsonrpc - id - method - params properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer example: 1 default: 1 method: type: string example: zks_getRawBlockTransactions default: zks_getRawBlockTransactions params: type: array default: - 27221521 items: type: integer example: 27221521 default: 27221521 JsonRpcResponseForL1BatchNumber: type: object required: - jsonrpc - id - result properties: jsonrpc: type: string example: '2.0' default: '2.0' id: type: integer default: 1 result: type: object properties: batchNumber: type: integer description: The latest L1 batch number.