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 Viem or Ethers.js.

npm

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

yarn

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-polygon-api
cd alchemy-polygon-api
npm init --yes

3. Install Web3 Library

Run the following command to install Viem or Ethers.js with npm or yarn.

npm install viem

4. Make your first request

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

1
import { createPublicClient, http } from 'viem'
2
import { polygon } from 'viem/chains'
3
4
const client = createPublicClient({
5
 chain: polygon,
6
 transport: http('https://polygon-mainnet.g.alchemy.com/v2/demo') // Replace 'demo' with your API Key
7
})
8
9
async function main() {
10
 const latestBlock = await client.getBlockNumber()
11
 console.log('The latest block number is', latestBlock)
12
}
13
14
main()

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 62250231n

Polygon Tutorials

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

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

• How to Code and Deploy a Polygon Smart Contract
• Polygon SDK Examples
• Polygon API FAQ
• How to Add Polygon to Metamask

For full documentation on Web3 libraries, check out the official documentation:

• Viem Documentation - Modern TypeScript interface for Ethereum
• Ethers.js Documentation - Complete Ethereum wallet implementation