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 relevant followers for a given user

farcasterFollowers.getRelevantFollowersByFid

Overview

Returns a list of relevant followers for a specific FID.

Parameters

name
type
required
Note

target_fid

number

true

ex) 3

viewer_fid

number

true

ex) 3

Usage

let res = await Lum0x.farcasterFollowers.getRelevantFollowersByFid({
    target_fid: 721870,
    viewer_fid: 3
});
console.log(JSON.stringify(res, null, 2));

Response

{
  "top_relevant_followers_hydrated": [
    {
      "object": "follow",
      "user": {
        "object": "user",
        "fid": 369,
        "custody_address": "0xa19097b0b81529cae9514f914ceb604683c7fa20",
        "username": "robin",
        "display_name": "robin :•>",
        "pfp_url": "https://i.imgur.com/NXChCsx.jpg",
        "profile": {
          "bio": {
            "text": "co-conspirator @ /moshicam /gallery /djs • prev coinbase • my casts are endorsements, financial advice, and reflect my employer's opinions"
          }
        },
        "follower_count": 279378,
        "following_count": 1678,
        "verifications": [
          "0x70d04384b5c3a466ec4d8cfb8213efc31c6a9d15"
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0x70d04384b5c3a466ec4d8cfb8213efc31c6a9d15"
          ],
          "sol_addresses": []
        },
        "active_status": "inactive",
        "power_badge": true
      }
    }
  ],
  "all_relevant_followers_dehydrated": [
    {
      "object": "follow",
      "user": {
        "object": "user_dehydrated",
        "fid": 369
      }
    }
  ]
}

FID

Username

Display Name

Profile Picture

Bio

Followers

Following

Verified ETH Addresses

Active Status

Power Badge

369

robin

robin :•>

co-conspirator @ /moshicam /gallery /djs • prev coinbase • my casts are endorsements, financial advice, and reflect my employer's opinions

279378

1678

0x70d04384b5c3a466ec4d8cfb8213efc31c6a9d15

inactive

true

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

PreviousRetrieve followers for a given userNextRetrieve a list of users followed by a user

Last updated 9 months ago