Lum0x SDK
  • Lum0x-sdk
    • Getting started
    • Examples
      • Case 1 : Find my Fan
      • Case 2: Fetch user's Moxie earning
      • Case 3: Raffle events among the filtered casts
      • How to Deploy a Project with Vercel
    • FarcasterUser
      • Search for Usernames
      • Fetch users based on FIDs
      • Fetch power user objects
      • Fetches users based on Eth or Sol addresses
      • Lookup a user by custody-address
      • Retrieve all channels that a given fid follows
      • Get User Information by username
      • Get Recent Users
    • FarcasterCast
      • Retrieve cast for a given hash or Warpcast URL
      • Retrieve casts for a given user
      • Gets information about an array of casts
      • Retrieve the conversation for a given cast
      • Get Recent Casts
    • FarcasterFeed
      • Retrieve casts based on filters
      • Retrieve trending casts
    • FarcasterReaction
      • Fetches reactions for a given user
      • Fetches reactions for a given cast
    • FarcasterFollowers
      • Retrieve followers for a given user
      • Retrieve relevant followers for a given user
      • Retrieve a list of users followed by a user
    • FarcasterStorage
      • Fetches storage allocations for a given user
      • Fetches storage usage for a given user
    • FarcasterFname
      • Check if a given fname is available
    • FarcasterMute
      • Get fids that a user has muted
    • FarcasterChannel
      • Retrieve all channels with their details
      • Search for channels based on id or name
      • (Bulk) Retrieve channels by id or parent_url
      • Retrieve channel details by id or parent_url
      • Retrieve followers for a given channel
      • Get channels that a user is active in
      • Check If User Follows Channel
      • Retrieve trending channels based on activity
    • FarcasterNotification
      • Retrieve notifications for a given user
    • FarcasterMoxie
      • Retrieve Moxie earning status
      • Retrieve FarScore and FarRank
      • Retrieve Moxie airdrop claim status
      • Retrieve Moxie earning details for cast.
      • Retrieve Moxie earning details for reply.
      • Retrieve Moxie earning details for cast by fid.
      • Retrieve Moxie earning details for reply by fid.
      • Retrieve Moxie earning details from channel cast.
Powered by GitBook
On this page
  • Overview
  • Parameters
  • Usage
  • Response
  • Field Description
  1. Lum0x-sdk
  2. FarcasterFollowers

Retrieve followers for a given user

farcasterFollowers.getFollowersByFid

Overview

Returns a list of followers for a specific FID.

Parameters

name
type
required
Note

fid

number

true

ex) 3

viewer_fid

number

false

ex) 3

sort_type

string

false

"desc_chron" or "algorithmic"

limit

number

false

default: 20, max: 100

cursor

string

false

ex) eyJwYWdlIjoyfQ==

Usage

let res = await Lum0x.farcasterFollowers.getFollowersByFid({
    fid: 721870,
    limit: 3
});
console.log(JSON.stringify(res, null, 2));

Response

{
  "users": [
    {
      "object": "follow",
      "user": {
        "object": "user",
        "fid": 260,
        "custody_address": "0x3b379ecb140b906bbcddac1a3f8b1163330d5da9",
        "username": "yekim.eth",
        "display_name": "Mike🎩",
        "pfp_url": "https://i.imgur.com/DAsCWsH.jpeg",
        "profile": {
          "bio": {
            "text": "1confirmation"
          }
        },
        "follower_count": 12053,
        "following_count": 1105,
        "verifications": [
          "0xf723d05f10e8503feaba5cfbb9a5513eb8ecbfd6"
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0xf723d05f10e8503feaba5cfbb9a5513eb8ecbfd6"
          ],
          "sol_addresses": []
        },
        "active_status": "inactive",
        "power_badge": true
      }
    },
    {
      "object": "follow",
      "user": {
        "object": "user",
        "fid": 624202,
        "custody_address": "0x77058e87e67ee428fda5778826ae2a1c0d35a481",
        "username": "i0water",
        "display_name": "Curator85  ",
        "pfp_url": "https://imagedelivery.net/BXluQx4ige9GuW0Ia56BHw/02af1aa0-091e-4862-3517-30ba986a5d00/rectcrop3",
        "profile": {
          "bio": {
            "text": "Dedicated to decoding the mysteries of blockchain. Insights on latest trends, tech, and innovations driving the world of cryptocurrencies. Join the crypto revolution!"
          }
        },
        "follower_count": 37,
        "following_count": 378,
        "verifications": [],
        "verified_addresses": {
          "eth_addresses": [],
          "sol_addresses": []
        },
        "active_status": "inactive",
        "power_badge": false
      }
    },
    {
      "object": "follow",
      "user": {
        "object": "user",
        "fid": 828959,
        "custody_address": "0x6065d91d377a9dd1f722a1867fda20a2e17e76d6",
        "username": "umbrellaella",
        "display_name": "Umm",
        "pfp_url": "https://imagedelivery.net/BXluQx4ige9GuW0Ia56BHw/b785b83f-1a3c-4d5e-6207-4f774bcffd00/rectcrop3",
        "profile": {
          "bio": {
            "text": ""
          }
        },
        "follower_count": 0,
        "following_count": 2,
        "verifications": [],
        "verified_addresses": {
          "eth_addresses": [],
          "sol_addresses": []
        },
        "active_status": "inactive",
        "power_badge": false
      }
    }
  ],
  "next": {
    "cursor": "eyJ0aW1lc3RhbXAiOiIyMDI0LTA4LTIwIDIzOjIyOjE2LjAwMDAwMDAiLCJmaWQiOjI2MH0%3D"
  }
}

FID

Username

Display Name

Profile Picture

Bio

Followers

Following

Verified ETH Addresses

Active Status

Power Badge

260

yekim.eth

Mike🎩

1confirmation

12053

1105

0xf723d05f10e8503feaba5cfbb9a5513eb8ecbfd6

inactive

true

624202

i0water

Curator85

Dedicated to decoding the mysteries of blockchain. Insights on latest trends, tech, and innovations driving the world of cryptocurrencies. Join the crypto revolution!

37

378

None

inactive

false

828959

umbrellaella

Umm

None

0

2

None

inactive

false

Field Description

  • FID: User identifier

  • Username: User's username

  • Display Name: User's display name

  • Profile Picture: URL of the profile picture

  • Bio: User's introduction

  • Followers: Number of followers

  • Following: Number of users the person is following

  • Verified ETH Addresses: Verified Ethereum addresses

  • Active Status: User's activity status

  • Power Badge: Whether the user holds a power badge

PreviousFarcasterFollowersNextRetrieve relevant followers for a given user

Last updated 9 months ago