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. FarcasterUser

Fetch users based on FIDs

farcasterUser.getUserByFids

Overview

This method allows you to fetches information about multiple users based on FIDs.

Parameters

name
type
required
Note

fids

string

true

ex) "721870,3,123"

viewer_fid

number

false

ex) 3

Usage

let res = await Lum0x.farcasterUser.getUserByFids({
    fids: "721870,3,123"
});
console.log(JSON.stringify(res, null, 2));

Response

{
  "users": [
    {
      "object": "user",
      "fid": 721870,
      "custody_address": "0x63cd09948b05e5d8367226b0c83a16b583862191",
      "username": "lum0x",
      "display_name": "Lum0x",
      "pfp_url": "https://imagedelivery.net/BXluQx4ige9GuW0Ia56BHw/74970e01-bcf7-4ef7-31d7-238f5814b200/original",
      "profile": {
        "bio": {
          "text": "illuminate your builder journey with Lum0x 💡\n\nhttps://lum0x.com/"
        }
      },
      "follower_count": 37,
      "following_count": 2,
      "verifications": [],
      "verified_addresses": {
        "eth_addresses": [],
        "sol_addresses": []
      },
      "active_status": "inactive",
      "power_badge": false
    },
    {
      "object": "user",
      "fid": 3,
      "custody_address": "0x6b0bda3f2ffed5efc83fa8c024acff1dd45793f1",
      "username": "dwr.eth",
      "display_name": "Dan Romero",
      "pfp_url": "https://res.cloudinary.com/merkle-manufactory/image/fetch/c_fill,f_png,w_256/https://lh3.googleusercontent.com/MyUBL0xHzMeBu7DXQAqv0bM9y6s4i4qjnhcXz5fxZKS3gwWgtamxxmxzCJX7m2cuYeGalyseCA2Y6OBKDMR06TWg2uwknnhdkDA1AA",
      "profile": {
        "bio": {
          "text": "Working on Farcaster and Warpcast."
        }
      },
      "follower_count": 475871,
      "following_count": 3379,
      "verifications": [
        "0xd7029bdea1c17493893aafe29aad69ef892b8ff2"
      ],
      "verified_addresses": {
        "eth_addresses": [
          "0xd7029bdea1c17493893aafe29aad69ef892b8ff2"
        ],
        "sol_addresses": []
      },
      "active_status": "inactive",
      "power_badge": true
    },
    {
      "object": "user",
      "fid": 123,
      "custody_address": "0x8d6130a1e58403e4a37d1b65b4e6d6b9616a448e",
      "username": "marco",
      "display_name": "marco",
      "pfp_url": "https://lh3.googleusercontent.com/CQv5OIkUhdw9YLPJaiszFwrDIRrH5GHN20pGnE5oXuiKBcWvae-wDRe3W2Dzk6Vr0aVk9MCfGLsU-ewGyE0aYeSsrr5r3IyAaCUf6w",
      "profile": {
        "bio": {
          "text": "https://rb.gy/kyghim"
        }
      },
      "follower_count": 115,
      "following_count": 53,
      "verifications": [
        "0x0bceed4f944dc60ce76422b47347b9e66fa9991a"
      ],
      "verified_addresses": {
        "eth_addresses": [
          "0x0bceed4f944dc60ce76422b47347b9e66fa9991a"
        ],
        "sol_addresses": []
      },
      "active_status": "inactive",
      "power_badge": false
    }
  ]
}

Field
User 1
User 2
User 3

Object

user

user

user

FID

721870

3

123

Custody Address

0x63cd09948b05e5d8367226b0c83a16b583862191

0x6b0bda3f2ffed5efc83fa8c024acff1dd45793f1

0x8d6130a1e58403e4a37d1b65b4e6d6b9616a448e

Username

lum0x

dwr.eth

marco

Display Name

Lum0x

Dan Romero

marco

Profile Pic URL

Bio

Working on Farcaster and Warpcast.

Follower Count

37

475,871

115

Following Count

2

3,379

53

Verifications

없음

0xd7029bdea1c17493893aafe29aad69ef892b8ff2

0x0bceed4f944dc60ce76422b47347b9e66fa9991a

Verified ETH Addresses

없음

0xd7029bdea1c17493893aafe29aad69ef892b8ff2

0x0bceed4f944dc60ce76422b47347b9e66fa9991a

Verified SOL Addresses

없음

없음

없음

Active Status

inactive

inactive

inactive

Power Badge

false

true

false

Field Description

  • Object: Indicates the type of data object.

  • FID: The user's unique identifier.

  • Custody Address: The user's wallet address.

  • Username: The user's account name.

  • Display Name: The user's public name.

  • Profile Pic URL: The URL of the user's profile picture.

  • Bio: Information about the user, including introductions and links.

  • Follower Count: The number of followers the user has.

  • Following Count: The number of people the user is following.

  • Verifications: The user's verification information.

  • Verified ETH Addresses: List of verified Ethereum addresses.

  • Verified SOL Addresses: List of verified Solana addresses.

  • Active Status: The user's activity status (e.g., active, inactive).

  • Power Badge: Whether the user holds a power badge.

PreviousSearch for UsernamesNextFetch power user objects

Last updated 9 months ago

illuminate your builder journey with Lum0x 💡

Lum0x Website
Link