Neynar · Example Payload

Lookup User By Username

Fetches a single hydrated user object given a username

User

Lookup User By Username 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": "lookup-user-by-username",
  "method": "GET",
  "path": "/v2/farcaster/user/by_username/",
  "summary": "By username",
  "description": "Fetches a single hydrated user object given a username",
  "tags": [
    "User"
  ],
  "parameters": [
    {
      "name": "",
      "in": "",
      "required": false,
      "description": ""
    },
    {
      "name": "username",
      "in": "query",
      "required": true,
      "description": "Username of the user to fetch",
      "schema": {
        "example": "neynar",
        "type": "string"
      }
    },
    {
      "name": "viewer_fid",
      "in": "query",
      "required": false,
      "description": "",
      "schema": {
        "minimum": 1,
        "type": "integer"
      }
    }
  ],
  "requestBody": null,
  "responses": {
    "200": {
      "description": "Success",
      "schema": {
        "$ref": "#/components/schemas/UserResponse"
      },
      "example": null
    },
    "400": {
      "description": "Bad Request",
      "schema": {
        "$ref": "#/components/schemas/ErrorRes"
      },
      "example": null
    },
    "404": {
      "description": "Resource not found",
      "schema": {
        "$ref": "#/components/schemas/ErrorRes"
      },
      "example": null
    },
    "500": {
      "description": "Server Error",
      "schema": {
        "$ref": "#/components/schemas/ErrorRes"
      },
      "example": null
    }
  }
}