v1

latestOpenAPI 3.0.42026-07-26159287356.1 KB

User

Search for Usernames

get/v2/farcaster/user/search/

Query parameters

qstring required

Example:r

viewer_fidinteger

Providing this will return search results that respects this user's mutes and blocks and includes viewer_context.

limitinteger

Example:10

Number of users to fetch

cursorstring

Pagination cursor.

Headers

x-neynar-experimentalboolean

Enables experimental features including filtering based on the Neynar score. See docs for more details.

Response

Success

Example response

{
  "result": {
    "users": [
      {
        "auth_addresses": [
          {
            "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
            "app": {
              "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
              "fid": 3
            }
          }
        ],
        "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "fid": 3,
        "profile": {
          "bio": {
            "mentioned_profiles": [
              {
                "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
                "fid": 3
              }
            ]
          }
        },
        "verifications": [
          "0x5a927ac639636e534b678e81768ca19e2c6280b7"
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0x5a927ac639636e534b678e81768ca19e2c6280b7"
          ],
          "primary": {
            "eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
          }
        }
      }
    ]
  }
}