Ethereum JSON-RPC
v1.0.0https://hype.nownodes.ioAuthentication
api-keyAuthapiKeyAPI Key: api-key in header
MAINNET / EVM
eth_accounts
Ethereum method - eth_accounts
Returns an array of addresses controlled by the client.
Body
jsonrpcstringrequiredJSON-RPC version identifier
methodstringrequiredName of the JSON-RPC method
paramsarrayrequiredNo parameters are required for this method. This must be an empty array.
idintegerrequiredUnique identifier for the JSON-RPC request
Response
A list of Ethereum addresses
Authorization
api-keyAuthapiKey in headereth_blockNumber
Ethereum method - eth_blockNumber
Returns the number of the latest block on the chain in hexadecimal format.
Body
jsonrpcstringrequiredThe JSON-RPC protocol version
methodstringrequiredName of the method being called
paramsarrayrequiredThis method does not take parameters; always send an empty array.
idintegerrequiredA unique ID for the request
Response
The latest block number
Authorization
api-keyAuthapiKey in headereth_call
Ethereum method - eth_call
Executes a call to a contract or address and returns the result without broadcasting a transaction.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<object | string>requiredThe first object specifies the call transaction object. The second (optional) parameter specifies the block context.
idintegerrequiredResponse
Result of the call
Authorization
api-keyAuthapiKey in headereth_chainId
Ethereum method - eth_chainId
Returns the hexadecimal string of the current chain ID.
Body
jsonrpcstringrequiredJSON-RPC protocol version
methodstringrequiredName of the method to call
paramsarrayrequiredThis method does not require parameters. Use an empty array.
idintegerrequiredUnique identifier for the request
Response
Chain ID response
Authorization
api-keyAuthapiKey in headereth_coinbase
eth_coinbase
Returns the Ethereum coinbase address (i.e., the address that receives mining rewards).
Body
jsonrpcstringrequiredmethodstringeth_coinbaserequiredparamsarrayrequiredThis method takes no parameters.
idintegerrequiredResponse
JSON-RPC Response with the coinbase address
Authorization
api-keyAuthapiKey in headereth_estimateGas
Estimate Gas for Transaction
Simulates a transaction and returns an estimate of how much gas would be used.
Body
jsonrpcstringrequiredJSON-RPC protocol version
methodstringrequiredThe method name
paramsArray<object | string>requiredThe transaction call object and an optional block tag.
idintegerrequiredRequest identifier
Response
Estimated gas amount
Authorization
api-keyAuthapiKey in headereth_feeHistory
eth_feeHistory
Returns fee market information for a range of blocks. This is typically used by wallets and other tools to estimate appropriate gas prices.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string | integer | Array<number>>requiredParameters:
blockCount— number of blocks in the requested range.newestBlock— highest block number in the requested range (can be "latest").rewardPercentiles— list of percentile values to sample priority fees from each block (optional).
idintegerrequiredResponse
JSON-RPC Response with fee history data
Authorization
api-keyAuthapiKey in headereth_gasPrice
Get Suggested Gas Price
Returns the current gas price in wei as a hexadecimal string. This value is a node estimate based on recent blocks and mempool activity.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsarrayrequiredThis method takes an empty array.
idintegerrequiredRequest identifier
Response
Suggested gas price in wei
Authorization
api-keyAuthapiKey in headereth_getBalance
Get ETH Balance of an Address
Retrieves the balance (in wei) of a given Ethereum address. You can specify the block parameter to get the balance at a specific block.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsArray<string>requiredArray with 2 parameters:
- Address (20-byte hex string with '0x' prefix)
- Block tag (e.g., 'latest', 'earliest', 'pending', or block number in hex)
idintegerrequiredRequest ID
Response
Balance (in wei) as hex string
Authorization
api-keyAuthapiKey in headereth_getBlockByHash
Get Block by Hash
Returns the block information for the specified block hash. The second parameter indicates whether to return full transaction objects or just transaction hashes.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsArray<string>requiredArray of parameters:
- Block hash (string)
- Boolean flag — if true, return full transactions; if false, only hashes.
idintegerrequiredRequest ID
Response
Block information
Authorization
api-keyAuthapiKey in headereth_getBlockByNumber
Get Block by Number
Returns the block information for the specified block number. The second parameter indicates whether to return full transaction objects or just transaction hashes.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsArray<string>requiredArray of parameters:
- Block number (hex string, e.g., "0x1b4") or special tags ("latest", "earliest", "pending")
- Boolean flag — if true, return full transactions; if false, only hashes.
idintegerrequiredRequest ID
Response
Block information
Authorization
api-keyAuthapiKey in headereth_getBlockReceipts
Get All Transaction Receipts for a Block
Returns an array of transaction receipts for every transaction in the block specified by block number or block hash.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsArray<string>requiredOne parameter:
- Block identifier, which can be either:
- block number as hex string (e.g. "0x10d4f")
- or block hash as hex string (0x-prefixed)
idintegerrequiredRequest identifier
Response
Array of transaction receipts in the block
Authorization
api-keyAuthapiKey in headereth_getBlockTransactionCountByHash
Get Transaction Count by Block Hash
Returns the number of transactions contained in the block with the given hash.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsArray<string>requiredArray containing a single parameter:
- Block hash as a hex string (32 bytes with 0x prefix)
idintegerrequiredRequest ID
Response
Number of transactions in the block
Authorization
api-keyAuthapiKey in headereth_getBlockTransactionCountByNumber
Get Transaction Count by Block Number
Returns the number of transactions contained in the block with the given block number.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsArray<string>requiredArray containing a single parameter:
- Block number as a hex string (e.g. "0x10d4f" for block 69007) or
- predefined block tags such as "latest", "earliest", or "pending"
idintegerrequiredRequest ID
Response
Number of transactions in the block
Authorization
api-keyAuthapiKey in headereth_getCode
Get Contract Bytecode at Address
Returns the contract code stored at a given address. If the address is an externally owned account (EOA), it returns "0x".
Body
jsonrpcstringrequiredJSON-RPC version.
methodstringrequiredJSON-RPC method name.
paramsArray<string>requiredParameters array with two elements:
- The address to get the code for (hex string, 0x-prefixed).
- The block number or block tag (e.g., "latest", "earliest", "pending").
idintegerrequiredRequest identifier.
Response
Contract bytecode in hex format
Authorization
api-keyAuthapiKey in headereth_getFilterChanges
Get Filter Changes
Returns an array of logs that occurred since the last poll for the specified filter ID. The filter must have been previously created with eth_newFilter or eth_newBlockFilter or eth_newPendingTransactionFilter.
Body
jsonrpcstringrequiredJSON-RPC version.
methodstringrequiredJSON-RPC method name.
paramsArray<string>requiredParameters array with a single element:
- The filter ID (hex string).
idintegerrequiredRequest identifier.
Response
Array of log objects or transaction hashes depending on filter type
Authorization
api-keyAuthapiKey in headereth_getFilterLogs
Get Filter Logs
Returns all logs matching a filter with the specified filter ID. The filter must have been previously created with eth_newFilter.
Body
jsonrpcstringrequiredJSON-RPC version.
methodstringrequiredJSON-RPC method name.
paramsArray<string>requiredParameters array with one element:
- The filter ID (hex string).
idintegerrequiredRequest identifier.
Response
Array of log objects matching the filter
Authorization
api-keyAuthapiKey in headereth_getLogs
Get Logs
Returns an array of logs that match the filter criteria specified in the params. The filter object supports filtering by block range, addresses, and topics.
Body
jsonrpcstringrequiredJSON-RPC version.
methodstringrequiredJSON-RPC method name.
paramsArray<object>requiredParameters array with one element: the filter object.
idintegerrequiredRequest identifier.
Response
Array of log objects matching the filter
Authorization
api-keyAuthapiKey in headereth_getStorageAt
Get Storage At
Returns the value stored at position in the storage of the contract at address at the given blockNumber.
Body
jsonrpcstringrequiredJSON-RPC version.
methodstringrequiredJSON-RPC method name.
paramsArray<string>requiredParameters array:
- address: string - Contract address to query storage from.
- position: string - Storage slot position (hex string).
- block number: string - Block number or keywords ("latest", "earliest", "pending").
idintegerrequiredRequest identifier.
Response
Storage slot value at the specified position
Authorization
api-keyAuthapiKey in headereth_getTransactionByBlockHashAndIndex
Get Transaction by Block Hash and Index
Retrieves the transaction from a block using the block's hash and the transaction's index position within the block.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredParameters:
- blockHash (string): The 32-byte hash of the block.
- transactionIndex (string): The transaction index (hex).
idintegerrequiredResponse
A transaction object or null if no transaction was found.
Authorization
api-keyAuthapiKey in headereth_getTransactionByBlockNumberAndIndex
Get Transaction by Block Number and Index
Returns the information about a transaction using the block number and the transaction index within the block.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredParameters:
- Block number in hex format (e.g., "0x5daf3b")
- Transaction index in the block (e.g., "0x0")
idintegerrequiredResponse
A transaction object, or null if not found.
Authorization
api-keyAuthapiKey in headereth_getTransactionByHash
Get transaction by hash
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredArray containing a single transaction hash
idintegerrequiredResponse
Transaction object or null
Authorization
api-keyAuthapiKey in headereth_getTransactionCount
Get transaction count (nonce) for address
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>required- address: The address to check for transaction count.
- block: The block parameter (e.g., "latest", "earliest", "pending").
idintegerrequiredResponse
Hex encoded nonce (transaction count)
Authorization
api-keyAuthapiKey in headereth_getTransactionReceipt
Get transaction receipt by hash
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredidintegerrequiredResponse
Transaction receipt if mined, otherwise null
Authorization
api-keyAuthapiKey in headereth_getUncleByBlockHashAndIndex
Get uncle block by block hash and index
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredblockHash: 32-byte block hashindex: the uncle index as hex (e.g., "0x0" for the first uncle)
idintegerrequiredResponse
Uncle block object or null
Authorization
api-keyAuthapiKey in headereth_getUncleByBlockNumberAndIndex
Get uncle block by block number and index
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredblockNumber: The block number as hex string (e.g., "0x10fb78"), or "latest", "earliest", "pending".index: The uncle index as hex (e.g., "0x0" for the first uncle).
idintegerrequiredResponse
Uncle block object or null
Authorization
api-keyAuthapiKey in headereth_getUncleCountByBlockHash
Get the number of uncle blocks by block hash
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredAn array containing the block hash.
idintegerrequiredResponse
Number of uncles in the block
Authorization
api-keyAuthapiKey in headereth_getUncleCountByBlockNumber
Get the number of uncle blocks by block number
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredAn array containing the block number as a hex string.
idintegerrequiredResponse
Number of uncle blocks in the block
Authorization
api-keyAuthapiKey in headereth_hashrate
eth_hashrate
Returns the current mining hashrate reported by the client.
Body
jsonrpcstringrequiredmethodstringeth_hashraterequiredparamsarrayrequiredThis method takes no parameters.
idintegerrequiredResponse
JSON-RPC response with the current mining hashrate
Authorization
api-keyAuthapiKey in headereth_maxPriorityFeePerGas
Get recommended maxPriorityFeePerGas value
Body
jsonrpcstringrequiredmethodstringrequiredparamsarrayrequiredNo parameters are required.
idintegerrequiredResponse
Returns the suggested maxPriorityFeePerGas value
Authorization
api-keyAuthapiKey in headereth_mining
eth_mining
Checks whether the Ethereum client is actively mining.
Body
jsonrpcstringrequiredmethodstringeth_miningrequiredparamsarrayrequiredThis method does not accept parameters.
idintegerrequiredResponse
JSON-RPC Response indicating mining status
Authorization
api-keyAuthapiKey in headereth_newBlockFilter
Create a new block filter
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<any>requiredThis method does not require any parameters.
idintegerrequiredResponse
Filter ID created successfully
Authorization
api-keyAuthapiKey in headereth_newFilter
Create a new log filter
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<object>requiredArray with one object describing the filter options.
idintegerrequiredResponse
Filter ID created successfully
Authorization
api-keyAuthapiKey in headereth_newPendingTransactionFilter
Create a filter for pending transactions
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsArray<any>requiredNo parameters required for this method
idintegerrequiredRequest identifier
Response
Filter ID created successfully
Authorization
api-keyAuthapiKey in headereth_sendRawTransaction
Send a raw signed transaction
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
paramsArray<string>requiredArray containing a single signed transaction data (hex string)
idintegerrequiredRequest ID
Response
Transaction successfully sent
Authorization
api-keyAuthapiKey in headereth_sendTransaction
Send a transaction using node-managed account
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<object>requiredTransaction object
idintegerrequiredResponse
Transaction successfully sent
Authorization
api-keyAuthapiKey in headereth_sign
Sign arbitrary data using eth_sign
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>required[address, data]
- address: The account that will sign the data
- data: The data to be signed (must be a hex string)
idintegerrequiredResponse
Returns the signature of the message
Authorization
api-keyAuthapiKey in headereth_signTransaction
eth_signTransaction
Signs a transaction locally with the private key of the specified account.
Body
jsonrpcstringrequiredmethodstringeth_signTransactionrequiredparamsArray<object>requiredArray with a single object representing the transaction to sign.
idintegerrequiredResponse
JSON-RPC response with the signed transaction data
Authorization
api-keyAuthapiKey in headereth_syncing
Check if node is syncing
Body
jsonrpcstringrequiredmethodstringrequiredparamsarrayrequiredMust be an empty array.
idintegerrequiredResponse
Returns sync status object or false
Authorization
api-keyAuthapiKey in headereth_uninstallFilter
Uninstall an existing filter
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredidintegerrequiredResponse
Success or failure of the uninstall operation
Authorization
api-keyAuthapiKey in headernet_listening
net_listening
Checks if the client is listening for network connections.
Body
jsonrpcstringrequiredmethodstringnet_listeningrequiredparamsarrayrequiredThis method takes no parameters.
idintegerrequiredResponse
JSON-RPC response with listening status
Authorization
api-keyAuthapiKey in headernet_peerCount
net_peerCount
Returns the number of peers currently connected to the client.
Body
jsonrpcstringrequiredmethodstringnet_peerCountrequiredparamsarrayrequiredThis method takes no parameters.
idintegerrequiredResponse
JSON-RPC response with the number of connected peers
Authorization
api-keyAuthapiKey in headernet_version
net_version
Returns the current network ID of the Ethereum client.
Body
jsonrpcstringrequiredmethodstringnet_versionrequiredparamsarrayrequiredThis method takes no parameters.
idintegerrequiredResponse
JSON-RPC response with the current network ID
Authorization
api-keyAuthapiKey in headerweb3_clientVersion
web3_clientVersion
Returns the current Ethereum client version.
Body
jsonrpcstringrequiredmethodstringweb3_clientVersionrequiredparamsarrayrequiredThis method takes no parameters.
idintegerrequiredResponse
JSON-RPC response with the client version string
Authorization
api-keyAuthapiKey in headerweb3_sha3
web3_sha3
Computes the Keccak-256 (SHA-3) hash of the given hex-encoded data.
Body
jsonrpcstringrequiredmethodstringweb3_sha3requiredparamsArray<string>requiredArray containing a single hex-encoded data string to hash.
idintegerrequiredResponse
JSON-RPC response with the Keccak-256 hash of the input data
Authorization
api-keyAuthapiKey in headerMAINNET / INFO
allBorrowLendReserveStates
Get all borrow/lend reserve states
Returns an overview of all borrow/lend reserve pools, including annualised rates, balances, utilisation, oracle price, LTV, and total supplied/borrowed amounts. No user address is required.
Body
typestringrequiredOperation type. Must be exactly "allBorrowLendReserveStates" (case‑sensitive).
Response
An array of reserve state tuples. Each tuple contains a pool identifier (integer) and an object with the reserve’s details.
Authorization
api-keyAuthapiKey in headerborrowLendUserState
Get borrow/lend user state
Retrieves the health summary and token-level snapshots for the user's
borrow/lend positions. The tokenToState array is empty when the user
has no active borrows or supplies.
Body
typestringrequiredOperation type; must be exactly "borrowLendUserState" (case‑sensitive).
userstringrequiredEthereum wallet address. Format: 0x‑prefixed hex string, 42 characters.
Response
Simplified borrow/lend state object.
Authorization
api-keyAuthapiKey in headerclearinghouseState
Get clearinghouse state for a user
Retrieves a user’s clearinghouse state, which includes margin summary (account value, total notional, margin used), cross‑margin information, maintenance margin used, withdrawable funds, and a list of open perpetual positions (one‑way positions).
Body
typestringrequiredRequest type, must be "clearinghouseState"
userstringrequiredEthereum address (hex)
Response
Successful response
Authorization
api-keyAuthapiKey in headerdelegations
Get delegations
Fetches a list of delegation objects for the given Ethereum wallet. Each object contains the delegator, the delegate, the delegated amount, and the time window during which the delegation is valid.
Body
typestringrequiredOperation type; must be exactly "delegations".
userstringrequiredEthereum wallet address whose delegations you want to retrieve. Format: 0x‑prefixed hex string, 42 characters.
Response
Array of delegation objects (empty if none exist).
Authorization
api-keyAuthapiKey in headerdelegatorSummary
Get delegator summary
Fetches aggregated delegation information for the specified wallet address. The response indicates how much of the account's balance is currently delegated, how much remains undelegated, and the status of any pending withdrawals from delegations.
Body
typestringrequiredOperation type. Must be exactly "delegatorSummary" (case‑sensitive).
userstringrequiredEthereum wallet address of the delegator. Format: 0x‑prefixed hex string, 42 characters.
Response
Aggregated delegator summary object.
Authorization
api-keyAuthapiKey in headerexchangeStatus
Get exchange status
Retrieves the current operational status of the exchange.
Body
typestringRequest type, must be "exchangeStatus"
Response
Successful response
Authorization
api-keyAuthapiKey in headerextraAgents
Get extra agents for a user
Retrieves the extra agents (automated trading agents, sub‑account bots, etc.) linked to the given user.
Body
typestringrequiredRequest type, must be "extraAgents"
userstringrequiredEthereum address (hex)
Response
Successful response
Authorization
api-keyAuthapiKey in headerfrontendOpenOrders
Get frontend-enriched open orders
Returns all open orders for the specified user address, decorated with additional information relevant for frontend display. The response includes the full set of fields: coin, side, limitPx, sz, oid, timestamp, triggerCondition, isTrigger, triggerPx, children, isPositionTpsl, reduceOnly, orderType, origSz, tif, and cloid.
Body
typestringrequiredOperation type; must be exactly "frontendOpenOrders" (case‑sensitive).
userstringrequiredEthereum wallet address. Format: 0x‑prefixed hex string, 42 characters.
Response
Array of enriched open order objects.
Authorization
api-keyAuthapiKey in headermaxMarketOrderNtls
Get max market order notional tiers
Returns a list of leverage tiers together with the corresponding maximum notional value that can be sent in a single market order. The response is an array of tuples, where each tuple contains the leverage as an integer and the max notional as a decimal string.
Body
typestringrequiredOperation type. Must be exactly "maxMarketOrderNtls" (case‑sensitive).
Response
A JSON array of leverage‑tier tuples. Each tuple is an array of two elements: an integer (leverage) and a string (max notional value).
Authorization
api-keyAuthapiKey in headermeta
Get meta information
Retrieves the universe of tradable assets, margin tables (leverage tiers), and collateral token configuration.
Body
typestringRequest type, must be "meta"
Response
Successful response
Authorization
api-keyAuthapiKey in headeropenOrders
Get open orders
Queries the Hyperliquid exchange for all open orders belonging to the given Ethereum wallet address.
The request body must contain "type": "openOrders" and a valid 0x-prefixed user address.
The response returns an array of order objects, or an empty array if no open orders exist.
Body
typestringrequiredOperation type. Must be the exact string "openOrders" (case-sensitive).
userstringrequiredEthereum wallet address of the user whose open orders you want to fetch. Format: 0x-prefixed hexadecimal string, 42 characters long (e.g. 0x31ca...974b). No checksum requirement is enforced, but the address must exist on the exchange.
Response
A JSON array containing all currently open orders for the specified user. Each order object includes full details: coin symbol, side, limit price, current size, order ID, timestamp, and original size. If there are no open orders, the array is empty.
Authorization
api-keyAuthapiKey in headerperpDeployAuctionStatus
Get perpetual deployment auction status
Retrieves the gas auction parameters for deploying perpetual contracts.
Body
typestringrequiredRequest type, must be "perpDeployAuctionStatus"
Response
Successful response
Authorization
api-keyAuthapiKey in headerperpDexs
Get perpetual DEXs
Retrieves an array of all deployed perpetual DEX contracts. Each DEX object includes its name, full name, deployer address, oracle updater, fee recipient, and per‑asset parameters (e.g., open interest caps, funding multipliers, funding interest rates).
Body
typestringrequiredRequest type, must be "perpDexs"
Response
Successful response
Authorization
api-keyAuthapiKey in headerperpsAtOpenInterestCap
Get perpetuals at open interest cap
Retrieves an array of perpetual contract symbols that are currently at or above their open interest cap. Trading or opening new positions may be restricted for these assets.
Body
typestringrequiredRequest type, must be "perpsAtOpenInterestCap"
Response
Successful response
Authorization
api-keyAuthapiKey in headerspotClearinghouseState
Get spot clearinghouse state for a user
Retrieves a user’s spot account state, including token holdings, total account value, withdrawable funds, and the number of open spot orders.
Body
typestringrequiredRequest type, must be "spotClearinghouseState"
userstringrequiredEthereum address (hex)
Response
Successful response
Authorization
api-keyAuthapiKey in headerspotDeployState
Get spot deploy state for a user
Retrieves the deployment state of spot markets for a specific user address, along with the gas auction status.
Body
typestringrequiredRequest type, must be "spotDeployState"
userstringrequiredEthereum address (hex) of the user
Response
Successful response
Authorization
api-keyAuthapiKey in headerspotMeta
Get spot meta information
Retrieves the universe of spot trading pairs and the list of tokens with their decimals, EVM contract details, and metadata.
Body
typestringRequest type, must be "spotMeta"
Response
Successful response
Authorization
api-keyAuthapiKey in headersubAccounts
Get sub‑accounts for a user
Retrieves the sub‑accounts linked to a specific main account.
Body
typestringrequiredRequest type, must be "subAccounts"
userstringrequiredEthereum address (hex)
Response
Successful response
Authorization
api-keyAuthapiKey in headeruserAbstraction
Get user abstraction setting
Retrieves the abstraction configuration for a specific user (e.g., whether abstracted account mode is active).
Body
typestringrequiredRequest type, must be "userAbstraction"
userstringrequiredEthereum address (hex)
Response
Successful response
Authorization
api-keyAuthapiKey in headeruserFees
Get user fee information
Retrieves fee statistics and fee schedule for a given user.
Body
typestringrequiredRequest type, must be "userFees"
userstringrequiredEthereum address (hex)
Response
Successful response
Authorization
api-keyAuthapiKey in headeruserRateLimit
Get user rate limit information
Retrieves rate‑limit statistics for the given user, such as cumulative trading volume and request consumption.
Body
typestringrequiredRequest type, must be "userRateLimit"
userstringrequiredEthereum address (hex)
Response
Successful response
Authorization
api-keyAuthapiKey in headeruserRole
Get user role
Retrieves the role of a given user (e.g., "vault", "normal", "admin").
Body
typestringrequiredRequest type, must be "userRole"
userstringrequiredEthereum address (hex)
Response
Successful response
Authorization
api-keyAuthapiKey in headeruserToMultiSigSigners
Get multi‑sig signers for a user
Retrieves the multi‑signature signers mapped to the given user address.
Body
typestringrequiredRequest type, must be "userToMultiSigSigners"
userstringrequiredEthereum address (hex)
Response
Successful response
Authorization
api-keyAuthapiKey in headeruserVaultEquities
Get user vault equities
Fetches all vault equity positions held by the given wallet address. Each object in the response represents a single vault allocation, including the deposited amount and current equity value.
Body
typestringrequiredOperation type; must be exactly "userVaultEquities" (case‑sensitive).
userstringrequiredEthereum wallet address whose vault stakes are queried. Format: 0x‑prefixed hex string, 42 characters.
Response
Array of vault equity objects (empty if none).
Authorization
api-keyAuthapiKey in headervaultSummaries
Get all vault summaries
Fetches a global list of vaults that exist on the Hyperliquid platform, including their address, name, total value locked, APR, user count, and other metadata.
Body
typestringrequiredOperation type; must be exactly "vaultSummaries" (case‑sensitive).
Response
Array of vault summary objects.
Authorization
api-keyAuthapiKey in headerwebData2
Get full account and platform data (webData2)
Fetches detailed information about the user's clearinghouse state, current asset contexts, TWAP states, and open interest caps. Requires a valid 0x‑prefixed wallet address.
Body
typestringrequiredOperation type. Must be exactly "webData2" (case‑sensitive).
userstringrequiredEthereum wallet address. Format: 0x‑prefixed hex string, 42 characters.
Response
Full account snapshot and platform metadata.
Authorization
api-keyAuthapiKey in header