Soneium API Quickstart

Get started building on Soneium and using the JSON-RPC API

To use the Soneium API you'll need to create a free Alchemy account first!

Introduction

Soneium is an innovative Ethereum Layer 2 blockchain platform developed by Sony Block Solutions Labs. It aims to integrate Web3 technologies into everyday life, creating an inclusive digital world where everyone can be a creator and innovator. Soneium offers a robust infrastructure for developers to build impactful decentralized applications (dApps) and digital assets, while providing users with a secure and user-friendly environment for interacting with blockchain technology.

📘

Please note that we currently only support Soneium Minato testnet RPC


What is the Soneium API?

The Soneium API allows interaction with the Soneium 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.

npmyarn
Begin with npm by following the npm documentation.For yarn, refer to yarn's installation guide.

2. Set Up Your Project

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

mkdir soneium-api-quickstart
cd soneium-api-quickstart
npm init --yes
mkdir soneium-api-quickstart
cd soneium-api-quickstart
yarn init --yes

This creates a new directory named soneium-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
# Or with yarn
# yarn add axios

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

const axios = require('axios');

const url = `https://soneium-minato.g.alchemy.com/v2/${yourAPIKey}`;

const payload = {
  jsonrpc: '2.0',
  id: 1,
  method: 'eth_blockNumber',
  params: []
};

axios.post(url, payload)
  .then(response => {
    console.log('Latest Block:', response.data.result);
  })
  .catch(error => {
    console.error(error);
  });

Replace yourAPIKey with your actual Alchemy API key from your Alchemy dashboard.

4. Run Your Script

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

node index.js

You should see the latest block information from Soneium's blockchain outputted to your console:

Latest Block: 0x...

Next Steps

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

ReadMe