openapi: 3.0.3 info: title: Chainstack Hyperliquid Node API version: 1.0.0 description: Chainstack-managed RPC node API for the Hyperliquid 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/hyperliquid_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: /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