Fetches users based on Eth or Sol addresses

farcasterUser.getUserByBulkAddress

Overview

Fetches all users based on multiple Ethereum or Solana addresses.

Each farcaster user has a custody Ethereum address and optionally verified Ethereum or Solana addresses. This endpoint returns all users that have any of the given addresses as their custody or verified Ethereum or Solana addresses.

A custody address can be associated with only 1 farcaster user at a time but a verified address can be associated with multiple users. You can pass in Ethereum and Solana addresses, comma separated, in the same request. The response will contain users associated with the given addresses.

Parameters

name	type	required	Note
addresses	string	true	ex) "0x63cd09948b05e5d8367226b0c83a16b583862191, 0x6b0bda3f2ffed5efc83fa8c024acff1dd45793f1"
address_types	string	false	"custody_address" or "verified_address"
viewer_fid	number	false	ex) 3

Usage

Typescript

let res = await Lum0x.farcasterUser.getUserByBulkAddress({
    addresses: "0x63cd09948b05e5d8367226b0c83a16b583862191, 0x6b0bda3f2ffed5efc83fa8c024acff1dd45793f1",
    address_types: "custody_address"
});
console.log(JSON.stringify(res, null, 2));

Response

{
  "0x63cd09948b05e5d8367226b0c83a16b583862191": [
    {
      "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
    }
  ],
  "0x6b0bda3f2ffed5efc83fa8c024acff1dd45793f1": [
    {
      "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": 475876,
      "following_count": 3379,
      "verifications": [
        "0xd7029bdea1c17493893aafe29aad69ef892b8ff2"
      ],
      "verified_addresses": {
        "eth_addresses": [
          "0xd7029bdea1c17493893aafe29aad69ef892b8ff2"
        ],
        "sol_addresses": []
      },
      "active_status": "inactive",
      "power_badge": true
    }
  ]
}

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	Profile Picture	illuminate your builder journey with Lum0x 💡\n\nhttps://lum0x.com/	37	2	[]	Eth Addresses: [] Sol Addresses: []	inactive	false
0x6b0bda3f2ffed5efc83fa8c024acff1dd45793f1	user	3	dwr.eth	Dan Romero	Profile Picture	Working on Farcaster and Warpcast.	475876	3379	[0xd7029bdea1c17493893aafe29aad69ef892b8ff2]	Eth Addresses: [0xd7029bdea1c17493893aafe29aad69ef892b8ff2] Sol Addresses: []	inactive	true

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