Get User Information by username

farcasterUser.getUserByUsername

Overview

Returns metadata about a specific user

Parameters

name	type	required	Note
username	string	true	ex) lum0x
viewer_fid	number	false	ex) 3

Usage

Typescript

let res = await Lum0x.farcasterUser.getUserByUsername({
    username: "lum0x",
});
console.log(JSON.stringify(res, null, 2));

Response

{
  "result": {
    "user": {
      "fid": 721870,
      "custodyAddress": "0x63cd09948b05e5d8367226b0c83a16b583862191",
      "username": "lum0x",
      "displayName": "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/",
          "mentionedProfiles": []
        }
      },
      "followerCount": 37,
      "followingCount": 2,
      "verifications": [],
      "verifiedAddresses": {
        "eth_addresses": [],
        "sol_addresses": []
      },
      "activeStatus": "inactive",
      "powerBadge": false
    }
  }
}

Field	Value
FID	721870
Custody Address	0x63cd09948b05e5d8367226b0c83a16b583862191
Username	lum0x
Display Name	Lum0x
Profile Picture URL
Bio	illuminate your builder journey with Lum0x 💡\nWebsite
Follower Count	37
Following Count	2
Verifications	None
Verified ETH Addresses	None
Verified SOL Addresses	None
Active Status	Inactive
Power Badge	No

Field Description

• FID: User's unique identifier.

• Custody Address: User's wallet address.

• Username: User's username.

• Display Name: User's display name.

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

• Bio: User's introduction text and links.

• Follower Count: Number of followers the user has.

• Following Count: Number of people the user is following.

• Verifications: User verification information (currently none).

• Verified ETH Addresses: List of verified Ethereum addresses (currently none).

• Verified SOL Addresses: List of verified Solana addresses (currently none).

• Active Status: User's activity status.

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