Farstack SDK

With the provided methods, you can use to easily query and fetch data from the farcaster network.

Installation

With NPM

npm install farstack-sdk

With yarn

yarn add farstack-sdk

With pnpm

pnpm install farstack-sdk

With bun

bun add farstack-sdk

Getting started

To use the SDK you will need a Farstack API key, once you have it you can call the init function with the apiKey.

init must be called before calling fetchQuery or fetchQueryWithPagination.

import { init } from "farstack-sdk";

init("apiKey");

fetchQuery

Parameters

fetchQuery accepts 2 parameters:

• query (required): A string that represents the Farstack GraphQL query to be executed.
• variables: An object that contains variables used in the query.

example:

    const variables = {
      request: {
        channelId: 'fardrops',
        limit: 2
      }
    };

fetchQuery returns a promise with an object, which contains the following properties:

• data: The response data returned by the server.
• error: An error object, if an error occurred during the network request.

Example

import { fetchQuery } from "farstack-sdk";

const { data, error } = await fetchQuery(query, variables);

fetchQueryWithPagination

Parameters

fetchQueryWithPagination take same parameters as fetchQuery.

It returns a promise with an object, which contains the following properties:

• data: The response data returned by the server.
• error: An error object, if an error occurred during the network request.
• hasNextPage: A boolean that indicates whether there is a next page of data available.
• hasPrevPage: A boolean that indicates whether there is a previous page of data available.
• getNextPage(): A function that returns a next page data, error, hasNextPage, hasPrevPage, getNextPage and getPrevPage. It returns null if there is no next page.
• getPrevPage(): A function that returns previous page data, error, hasNextPage, hasPrevPage, getNextPage and getPrevPage. It returns null if there is no previous page.

Note: fetchQueryWithPagination only works with queries that has support for pagination.

Example

import { fetchQueryWithPagination } from "farstack-sdk";

const { data, error, hasNextPage, hasPrevPage, getNextPage, getPrevPage } =
  await fetchQueryWithPagination(query, variables);