Lens API Quickstart

Get started building on Lens and using the JSON-RPC API

Introduction

Lens Network is a decentralized social media infrastructure built on Ethereum using zkSync's technology. It aims to create open and fair social spaces by leveraging hybrid scaling solutions for high-throughput, low-cost transactions. Lens empowers users with control over their social identity and connections, enabling seamless movement across applications and fostering an environment with reduced censorship and enhanced freedom of expression.

📘

Network Support

Please note that we currently only support Lens Sepolia Testnet

What is the Lens API?

The Lens API allows interaction with the Lens network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use.

Getting Started Instructions

1. Choose a Package Manager (npm or yarn)

Select a package manager to manage your project's dependencies. Choose between npm and yarn based on your 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

Open your terminal and execute the following commands to create and initialize your project:

mkdir lens-api-quickstart
cd lens-api-quickstart
npm init --yes
mkdir lens-api-quickstart
cd lens-api-quickstart
yarn init --yes

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

3. Make Your First Request

Install Axios, a popular HTTP client, to make API requests:

npm install axios
# Or with yarn
# yarn add axios

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

const axios = require('axios');

const url = 'https://lens-sepolia.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);
  });

Remember to replace your-api-key with your actual Alchemy API key that you can get from your Alchemy dashboard.

4. Run Your Script

Execute your script to make a request to the Lens mainnet:

node index.js

You should see the latest block information from Lens's mainnet outputted to your console:

Latest Block: 0x...

Next Steps

Congratulations! You've made your first request to the Lens network. You can now explore the various JSON-RPC methods available on Lens and start building your dApps on this innovative platform.

ReadMe