GET
/
farcaster
/
v2
/
user-by-username
curl --request GET \
  --url https://build.wield.xyz/farcaster/v2/user-by-username \
  --header 'API-KEY: <api-key>'
{
  "result": {
    "user": {
      "fid": "<string>",
      "followingCount": 123,
      "followerCount": 123,
      "pfp": {
        "url": "<string>",
        "verified": true
      },
      "bio": {
        "text": "<string>",
        "mentions": [
          "<string>"
        ]
      },
      "external": true,
      "custodyAddress": "<string>",
      "username": "<string>",
      "displayName": "<string>",
      "registeredAt": "2023-11-07T05:31:56Z"
    }
  },
  "source": "v2"
}

Headers

​
API-KEY
string
default:DEMO_REPLACE_WITH_FREE_API_KEY
required

Free API key needed to authorize requests, grab one at docs.wield.xyz

Query Parameters

​
username
string
required

Response

200 - application/json
Successful response
​
result
object
​
source
string
Example:

"v2"