Nirvana Labs API FAQ

Frequently Asked Questions about the RPC API.

What are RPC URLs & APIs?

For a software application to interact with a specific blockchain - either by reading blockchain data or sending transactions to the network - it must connect to a blockchain node. For this purpose, most blockchains implement a JSON-RPC specification, so applications can rely on a uniform set of methods regardless of the specific node or client implementation. JSON-RPC is a stateless, light-weight remote procedure call (RPC) protocol. It defines several data structures and the rules around their processing. It is transport agnostic in that the concepts can be used within the same process, over sockets, over HTTP, or in many various message passing environments. It uses JSON (RFC 4627) as data format.

What is an API Key?

API keys ensure secure authentication and authorization processes between users and blockchains. They are instrumental in verifying user identity, controlling access to sensitive data, and monitoring API activity.

An API key is a distinctive string of randomly generated characters or a set of unique codes that serve as authentication credentials for clients to access an API. By utilizing API keys to query or access blockchains, you can establish a robust framework that allows only authorized requests to interact with the API, safeguarding sensitive data and mitigating the risk of misuse.

API keys serve as a unique identifier to facilitate the interaction between users and blockchains. They verify the user's identity and grant them access to specific information or privileges to perform designated actions. This mechanism guarantees that only authorized individuals can engage with the blockchain or exchange platform, reinforcing security and integrity.

You can obtain an API key for free to try Nirvana Labs' managed RPC services under certain limitations, and we have several premium plans. Please check out the rates and plans.

By following a few simple steps, you can easily get an API key and start interacting with the desired network RPC nodes by utilizing the Ethereum RPC endpoint, Polygon RPC endpoint, Arbitrum RPC endpoint and Avalanche RPC endpoint Nirvana Labs supports.

Which API Does Ethereum Use?

Ethereum operates on the JSON-RPC API standard. The Ethereum JSON-RPC API serves as the fundamental framework for the Ethereum network, facilitating all types of blockchain interactions. This comprehensive suite of APIs empowers users to access many functionalities, including reading block and transaction data, querying chain information, executing smart contracts, and storing data on the blockchain.

How Does Nirvana Labs's API Work?

The Nirvana Labs API empowers developers and users by allowing them to read and write data on the blockchain.

If you're not familiar with the inner workings of a blockchain, here's a brief overview:

πŸ“˜

Blockchains consist of interconnected blocks of data.

πŸ“˜

These blocks are stored across distributed nodes.

πŸ“˜

Each node fulfils the role of a "mini-server" that enables its operator to interact with and manipulate blocks of data.

Through Nirvana Labs' API, developers access a high-level infrastructure that facilitates seamless interaction with the respective network. With API integration, Nirvana Labs developers can effortlessly send read and write requests to the blockchain.

At Nirvana Labs, we handle the complex underlying processes so that developers can dedicate their attention to building innovative products and applications. We strive to simplify the development experience, allowing our users to focus on realizing their ideas without getting bogged down by technical intricacies.

What Methods Does Nirvana Labs Support?

Nirvana Labs supports the full list of JSON-RPC API methods as listed in the JSON-RPC specification.

What is an API Endpoint?

When making an API call, you need to specify the endpoint, which is a URL consisting of the address and name of the node, along with the specific path for the desired endpoint.

The base URL format is as follows:

https://[blockchain name].nirvanalabs.xyz/[node name]?apikey=[xxxxxx]

where

  • The node-name corresponds to the name you've given to the node you've created for the specific blockchain.
  • The API key is the private API key generated by Nirvana Labs that gives you access to the node.

You then use the custom URL generated for that node to access and query the blockchain via an additional layer of CDN and an API gateway.