Get started

Overview

Unifarcaster SDK is a type-safe library that helps you query the farcaster network easily.

It's built on Neynar and Airstack. And has additional features you would need in your own app

Quick Start

Installation

pnpm

pnpm add uni-farcaster-sdk

Usage

import uniFarcasterSdk from "uni-farcaster-sdk";
 
//Initialize the sdk
const sdkInstance = new uniFarcasterSdk();
 
//Start Querying the farcaster network
const { data, error } = await sdkInstance.getUsersByFid([213144], 11124);

For production, you need to initialize the sdk with either neynar api key or airstack api key to get the best performance/service.
SEE: /configuration for all configuration options

e.g

const sdkInstance = new uniFarcasterSdk({
  neynarApiKey: "<your-neynar-api-key>",
});

Features

Type-safety: Sdk is fully typed and you don't need to know about any of the external services to use it.
Caching: Queries are cached for better performance and could have cache time which could be configured as you want
Retries: You have the configuration to add retries to faile queries.
Furthermore, you could also configure what retry startegy to use. Learn More
Debug Mode: You could enable debug mode which log queries, cache and retries information to the console. Specifically useful for development.
Custom Queries: While the sdk offers some good queries, you could need more than it offers. The sdk offers custom queries which you can use to get different data depending on your requirement.