Hyperevm API Quickstart

How to get started building on Hyperevm and using the JSON-RPC API

To use the Hyperevm API you’ll need to create a free Alchemy account first!

Introduction

HyperEVM is a high-performance, Ethereum-compatible execution layer developed by HyperLiquid that enables smart contracts to run natively alongside its decentralized trading engine, combining low-latency performance with full EVM compatibility.

What is the Hyperevm API?

The Hyperevm API allows interaction with the Hyperevm network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum’s JSON-RPC APIs, making it intuitive and straightforward to use.

Getting Started Instructions

1. Choose a Package Manager (npm or yarn)

Select a package manager to manage your project’s dependencies. Choose between npm and yarn based on your preference or project requirements.

$# Begin with npm by following the npm documentation
># https://docs.npmjs.com/downloading-and-installing-node-js-and-npm

2. Set Up Your Project

Open your terminal and execute the following commands to create and initialize your project:

$mkdir hyperevm-api-quickstart
>cd hyperevm-api-quickstart
>npm init --yes

This creates a new directory named hyperevm-api-quickstart and initializes a Node.js project within it.

3. Make Your First Request

Install Axios, a popular HTTP client, to make API requests:

$npm install axios

Create an index.js file in your project directory and paste the following code:

index.js
1const axios = require('axios');
2
3const url = 'https://hyperliquid-mainnet.g.alchemy.com/v2/${your-api-key}';
4
5const payload = {
6 jsonrpc: '2.0',
7 id: 1,
8 method: 'eth_blockNumber',
9 params: []
10};
11
12axios.post(url, payload)
13 .then(response => {
14 console.log('Latest Block:', response.data.result);
15 })
16 .catch(error => {
17 console.error(error);
18 });

Remember to replace your-api-key with your actual Alchemy API key that you can get from your Alchemy dashboard.

4. Run Your Script

Execute your script to make a request to the Hyperevm network:

shell
$node index.js

You should see the latest block information from Hyperevm’s network outputted to your console:

shell
$Latest Block: 0x...

Next Steps

Congratulations! You’ve made your first request to the Hyperevm network. You can now explore the various JSON-RPC methods available on Hyperevm and start building your dApps on this innovative platform.