Getting Started

This guide will help you get started with the Lens API and SDKs.

The Lens React SDK is a collection of React Hooks for both web and React Native applications. It's the simplest way to interact with the Lens API and build decentralized applications on Lens Network.

The Lens TypeScript SDK is a low-level API client for interacting with the Lens API. It provides a lightweight abstraction over the bare GraphQL API and is suitable for server-to-server communication or very bespoke client-side integrations where the Lens React SDK is not suitable.

npm install @lens-protocol/client@canary

import { PublicClient, testnet } from "@lens-protocol/client";
export const client = PublicClient.create({  environment: testnet,  origin: "https://myappdomain.xyz", // Ignored if running in a browser});

The Lens API utilizes GraphQL, a query language for APIs that allows clients to precisely request the data they need, leading to more efficient data retrieval. GraphQL queries are executed using a type system defined for your data. It is written in rust so it is blazing fast.

The API links below act as API endpoints as well as playgrounds for testing queries.

Below are examples of how to interact with the Lens API using different GraphQL clients.

import { gql, Client, cacheExchange, fetchExchange } from "urql";
const ENDPOINT = "https://api.testnet.lens.dev/graphql";
const client = new Client({  url: ENDPOINT,  exchanges: [cacheExchange, fetchExchange],});
const result = await client.query(gql`  query {    posts(request: { pageSize: TEN }) {      items {        id        author {          username {            value          }        }        metadata {          ... on TextOnlyMetadata {            content          }        }      }      pageInfo {        prev        next      }    }  }`);
console.log(result);