Sign in

v1

latestOpenAPI 3.0.42026-07-26159287356.1 KB
User

By username

Fetches a single hydrated user object given a username

get/v2/farcaster/user/by_username/

Query parameters

usernamestring required
Example:neynar

Username of the user to fetch

viewer_fidinteger

Headers

x-neynar-experimentalboolean

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

Response

Success

Example response

{
  "user": {
    "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"
      }
    }
  }
}