Search User
Search for Usernames
User
Search User is an example object payload from Neynar, with 9 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummarydescriptiontagsparametersrequestBodyresponses
Example Payload
{
"operationId": "search-user",
"method": "GET",
"path": "/v2/farcaster/user/search/",
"summary": "Search for Usernames",
"description": "Search for Usernames",
"tags": [
"User"
],
"parameters": [
{
"name": "",
"in": "",
"required": false,
"description": ""
},
{
"name": "q",
"in": "query",
"required": true,
"description": "",
"schema": {
"example": "r",
"type": "string"
}
},
{
"name": "viewer_fid",
"in": "query",
"required": false,
"description": "Providing this will return search results that respects this user's mutes and blocks and includes `viewer_context`.",
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"description": "Number of users to fetch",
"schema": {
"default": 5,
"example": 10,
"format": "int32",
"maximum": 10,
"minimum": 1,
"type": "integer"
}
},
{
"name": "cursor",
"in": "query",
"required": false,
"description": "Pagination cursor.",
"schema": {
"type": "string"
}
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/components/schemas/UserSearchResponse"
},
"example": null
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/components/schemas/ErrorRes"
},
"example": null
}
}
}