opBNB is an EVM-compatible blockchain designed to provide high performance, scalability, and security for decentralized applications (dApps). Known for its efficient transaction processing and low costs, opBNB offers a robust environment for deploying Ethereum-based applications.

The opBNB API facilitates interaction with the opBNB 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 opBNB both intuitive and straightforward.

Send Your First Request on Alchemy

Let's use the viem package to create an opBNB client connected to Alchemy and fetch the latest block number!

npm install --save viem

Create Client Connected to Alchemy

import { createPublicClient, http } from "viem"; 
import { opBNB } from "viem/chains";
 
const client = createPublicClient({
  chain: opBNB,
  transport: http("https://opbnb-mainnet.g.alchemy.com/v2/YOUR_ALCHEMY_API_KEY"),
});

Now that you've created a client connected to Alchemy, you can continue with some basics:

Get Latest Block Number

const blockNumber = await client.getBlockNumber();
console.log("Current block number:", blockNumber);

Get an Address Balance

const balance = await client.getBalance({ address: "0xab5801a7d398351b8be11c439e05c5b3259aec9b" });
console.log("Balance (BNB):", Number(balance) / 1e18);

Read Block Data

const block = await client.getBlock({
  blockNumber: blockNumber, // from previous example
});
console.log(block);

Fetch a Transaction by Hash

const tx = await client.getTransaction({ hash: "0xYOUR_TX_HASH" });
console.log(tx);

Fetch Transaction Receipt

const receipt = await client.getTransactionReceipt({
  hash: "0xYOUR_TX_HASH"
});
console.log(receipt);

opBNB APIs

For the full list of opBNB APIs, see the opBNB API Endpoints.