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

Lookup a user by custody-address

farcasterUser.getUserByCustodyAddress

Overview

Lookup a user by custody-address

Parameters

name
type
required
Note

custody_address

string

true

ex) 0x63cd09948b05e5d8367226b0c83a16b583862191

Usage

let res = await Lum0x.farcasterUser.getUserByCustodyAddress({
    custodyAddress: "0x63cd09948b05e5d8367226b0c83a16b583862191"
});
console.log(JSON.stringify(res, null, 2));

Response

{
  "user": {
    "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/",
        "mentioned_profiles": []
      }
    },
    "follower_count": 37,
    "following_count": 2,
    "verifications": [],
    "verified_addresses": {
      "eth_addresses": [],
      "sol_addresses": []
    },
    "active_status": "inactive",
    "power_badge": false
  }
}
Custody Address
Object
FID
Username
Display Name
Profile Picture URL
Bio
Follower Count
Following Count
Verifications
Verified Addresses
Active Status
Power Badge

0x63cd09948b05e5d8367226b0c83a16b583862191

user

721870

lum0x

Lum0x

illuminate your builder journey with Lum0x 💡\n\nhttps://lum0x.com/

37

2

[]

Eth Addresses: [] Sol Addresses: []

inactive

false

Field Description

  • Custody Address: The user's wallet address.

  • Object: The type of data object.

  • FID: The user's unique identifier.

  • 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: A list of verified Ethereum addresses.

  • Verified SOL Addresses: A 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.

PreviousFetches users based on Eth or Sol addressesNextRetrieve all channels that a given fid follows

Last updated 9 months ago

Profile Picture