Optimism API Quickstart

How to get started building on Optimism and use the JSON-RPC API

Don’t have an API key?

Sign up to start building on Optimism

Getting Started Instructions

1. Choose a package manager (npm or yarn)

For this guide, we will be using npm or yarn as our package manager to install either alchemy-sdk or any other packages.


To get started with npm, follow the documentation to install Node.js and npm for your operating system: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm


To get started with yarn, follow these steps: https://classic.yarnpkg.com/lang/en/docs/install

2. Set up your project (npm or yarn)

mkdir alchemy-optimism-api
cd alchemy-optimism-api
npm init --yes
mkdir alchemy-optimism-api
cd alchemy-optimism-api
yarn init --yes

3. Install Alchemy-SDK

Run the following command to install the Alchemy SDK with npm or yarn.

npm install alchemy-sdk
yarn add alchemy-sdk

4. Make your first request

You are all set now to use Optimism API and make your first request. For instance, lets make a request to get latest block. Create an index.js file and paste the following code snippet into the file.

const { Network, Alchemy } = require("alchemy-sdk");

// Optional Config object, but defaults to demo api-key and eth-mainnet.
const settings = {
  apiKey: "demo", // Replace with your Alchemy API Key.
  network: Network.OPT_MAINNET, // Replace with your network.

const alchemy = new Alchemy(settings);

async function main() {
  const latestBlock = await alchemy.core.getBlockNumber();
  console.log("The latest block number is", latestBlock);


5. Run script

To run the above node script, use cmd node index.js, and you should see the output.

The latest block number is 43869847

Optimism Tutorials

You must not stop here! Want to build your first Dapp on Optimism and use Optimism APIs?

Check out the following tutorials to learn how to build on Optimism:

For full documentation on the available endpoints for alchemy-sdk, check the github repo: