RPC API
Last updated
Last updated
The RPC API provides a JSON‑RPC interface for interacting with an R5 node. Applications and dapps can call these endpoints to query blockchain data, send transactions, and perform a variety of operations. You can use the to interact directly with the API in the same way as an application would.
By default, R5 RPC nodes expose only the following APIs:
r5 (eth)
web3
net
Other namespaces such as admin, miner, debug, and ethash are usually not open on RPC for security reasons. They contain sensitive functions for node administration, mining control, and internal debugging, and are typically accessible only in a controlled environment. You can still access these endpoints via the .
Below is a brief overview of each namespace. (Click the corresponding button to navigate to the full subpage for detailed endpoint documentation.)
Contains endpoints for administering node‑level operations, such as managing peers, retrieving node information, and controlling the RPC/HTTP/WS servers. For security reasons, these endpoints are typically restricted and not exposed on public RPC nodes by default.
Offers a suite of endpoints designed for detailed internal debugging and performance analysis. These methods provide insights into the node’s execution, database, memory, and other internal operations. They are intended for development and troubleshooting and are usually disabled on production RPC nodes.
Provides specific endpoints to interact with the Ethash proof‑of‑work (PoW) process. These endpoints allow miners to obtain the current work package, monitor mining hashrate, and submit proof‑of‑work details for validation.
Includes methods to control and monitor the mining process. You can start or stop mining, set mining parameters like Etherbase, extra data, gas limits, and gas price, and check the current mining hashrate. Due to their sensitive nature, these endpoints are normally not available on public RPC nodes.
Provides endpoints to obtain network‑related information. You can use these methods to check if the node is listening for connections, view the number of connected peers, and retrieve the network ID. This helps in diagnosing connectivity issues and verifying network status.
Provides all standard Ethereum‑compatible methods to interact with the blockchain. Endpoints in this namespace (e.g. r5_getBalance, r5_sendTransaction) enable you to query account balances, retrieve block or transaction details, and broadcast transactions. It is fully compatible with EVM dapps.
The rpc namespace provides endpoints for retrieving information about the node's JSON-RPC server itself. These endpoints let you query the list of available modules and their versions, giving you insight into the RPC capabilities exposed by your R5 node.
The txpool namespace provides RPC endpoints for inspecting and managing the node's transaction pool. These endpoints enable you to view pending and queued transactions, as well as check the current status of the transaction pool, ensuring you have full visibility into the transaction processing state.
Offers a collection of utility functions and helper methods for interacting with the node. This includes retrieving client version details, performing various data conversions (e.g. between ASCII, UTF‑8, hexadecimal, and wei), and handling BigNumber operations. These utilities are commonly used by front‑end applications and dapps.