BNB Smart Chain Quickstart

Get started building on BNB Smart Chain and using the JSON-RPC API

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

Introduction

The BNB Smart Chain (BSC) is a high-performance blockchain developed by Binance, designed to offer developers low transaction costs and fast execution times. It is Ethereum Virtual Machine (EVM) compatible which enables developers to deploy Ethereum-based applications seamlessly on it!

📘

NOTE

Binance Smart Chain is only available on paid tiers (growth, scale, enterprise). If you're on free tier upgrade your account to use BSC. If you want us to support BSC on free tier, please request here.


What is the BNB Smart Chain API?

The BNB Smart Chain API facilitates interaction with the BSC 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 BSC 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 bsc-api-quickstart
cd bsc-api-quickstart
npm init --yes
mkdir bsc-api-quickstart
cd bsc-api-quickstart
yarn init --yes

This creates a new directory named bsc-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 BSC network:

const axios = require('axios');

const url = `https://bnb-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 BNB Smart Chain, run:

node index.js

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

Block Number: 0x6d68e

Next Steps

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