Search for Usernames

farcasterUser.searchUser

Overview

This method allows you to search for users on the Farcaster network by their username.

Parameters

name	type	required	Note
q	string	true	ex) lum0x
viewer_fid	number	false	ex) 3
limit	number	false	default: 5, max: 10
cursor	string	false	ex) eyJwYWdlIjoyfQ==

Usage

Typescript

let res = await Lum0x.farcasterUser.searchUser({
    q: "lum0x",
    limit: 5
});
console.log(JSON.stringify(res, null, 2));

Response

{
  "result": {
    "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": 36,
        "following_count": 2,
        "verifications": [],
        "verified_addresses": {
          "eth_addresses": [],
          "sol_addresses": []
        },
        "active_status": "inactive",
        "power_badge": false
      }
    ],
    "next": {
      "cursor": null
    }
  }
}

Field	Value
Object	user
FID	721870
Custody Address	0x63cd09948b05e5d8367226b0c83a16b583862191
Username	lum0x
Display Name	Lum0x
Profile Pic URL
Bio	illuminate your builder journey with Lum0x 💡 Lum0x Website
Follower Count	36
Following Count	2
Verifications	없음
Verified ETH Addresses	없음
Verified SOL Addresses	없음
Active Status	inactive
Power Badge	false

Field Description

• Object: Specifies 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: Verification details about the user.

• 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 or not.