Fantom Opera Chain API Quickstart

Get started building on Fantom Opera and using the JSON-RPC API

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

Introduction

Fantom is an EVM-compatible blockchain designed to provide high performance, scalability, and security for decentralized applications (dApps). Known for its fast and low-cost transactions, Fantom offers a robust environment for deploying Ethereum-based applications.


What is the Fantom Opera Chain API?

The Fantom Opera Chain API facilitates interaction with the Fantom Opera network through a collection of JSON-RPC methods. Given its compatibility with the Ethereum ecosystem, developers familiar with Ethereum's JSON-RPC APIs will find working with Fantom Opera both intuitive and straightforward.

Getting Started Instructions

1. Choose a Package Manager (npm or yarn)

Your first step involves selecting a package manager, which will be crucial for managing your project's dependencies. The choice between npm and yarn depends on your personal 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

To kickstart your project, open your terminal and execute the following commands:

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

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

3. Make Your First Request

For making API requests, we'll use Axios, a widely-used HTTP client. Install Axios with the following command:

npm install axios
# Or with yarn
# yarn add axios

Next, create an index.js file in your project directory. Paste the following code to send a request to the Fantom Opera network:

const axios = require('axios');

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

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

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

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

4. Run Your Script

To execute your script and make a request to the Fantom Opera Chain, run:

node index.js

You should see the current block number on Fantom Opera Chain (in hexadecimal format) outputted to your console:

Block Number: 0x6d68e

Next Steps

Well done! You've just made your first request to the Fantom Opera Chain API. With this foundation, you can dive deeper into the array of JSON-RPC methods available on Fantom Opera Chain and start building your dApps on it!