X Layer API Quickstart

To use the X Layer API, you need an Alchemy account. Create a free account to get started.

X Layer is a zero-knowledge (ZK) Layer 2 network built by OKX using Polygon CDK, offering full EVM compatibility so existing Ethereum smart contracts, tools, and wallets work with zero code changes. It leverages zkSNARK proofs to compress transactions, resulting in sub-cent fees and block times of approximately 400 milliseconds.

The X Layer API lets you interact with the X Layer network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the interface will be familiar.

Pick a package manager for your project's dependencies.

# Begin with npm by following the npm documentation
# https://docs.npmjs.com/downloading-and-installing-node-js-and-npm

Run the following commands to create and initialize your project:

mkdir x-layer-api-quickstart
cd x-layer-api-quickstart
npm init --yes

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

Install Axios to make API requests:

npm install axios

Create an index.js file in your project directory and paste the following code:

const axios = require('axios');
 
const url = 'https://xlayer-mainnet.g.alchemy.com/v2/${your-api-key}';
 
const payload = {
  jsonrpc: '2.0',
  id: 1,
  method: 'eth_blockNumber',
  params: []
};
 
axios.post(url, payload)
  .then(response => {
    console.log('Latest Block:', response.data.result);
  })
  .catch(error => {
    console.error(error);
  });

Replace your-api-key with your actual Alchemy API key from the Alchemy Dashboard.

Run your script to make a request to the X Layer network:

node index.js

You should see the latest block number from X Layer in your console:

Latest Block: 0x...

You've made your first request to the X Layer network. Explore the JSON-RPC methods available on X Layer and start building your dApps.