Neynar · Example Payload

Fetch User Followers

Returns a list of followers for a specific FID.

Follows

Fetch User Followers 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

Raw ↑
{
  "operationId": "fetch-user-followers",
  "method": "GET",
  "path": "/v2/farcaster/followers/",
  "summary": "Followers",
  "description": "Returns a list of followers for a specific FID.",
  "tags": [
    "Follows"
  ],
  "parameters": [
    {
      "name": "",
      "in": "",
      "required": false,
      "description": ""
    },
    {
      "name": "fid",
      "in": "query",
      "required": true,
      "description": "User who's profile you are looking at",
      "schema": {
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "name": "viewer_fid",
      "in": "query",
      "required": false,
      "description": "Providing this will return a list of followers that respects this user's mutes and blocks and includes `viewer_context`.",
      "schema": {
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "name": "sort_type",
      "in": "query",
      "required": false,
      "description": "Sort type for fetch followers. Default is `desc_chron`",
      "schema": {
        "enum": [
          "desc_chron",
          "algorithmic"
        ],
        "example": "desc_chron",
        "type": "string"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "Number of results to fetch",
      "schema": {
        "default": 20,
        "example": 30,
        "format": "int32",
        "maximum": 100,
        "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/FollowersResponse"
      },
      "example": null
    },
    "400": {
      "description": "Bad Request",
      "schema": {
        "$ref": "#/components/schemas/ErrorRes"
      },
      "example": null
    },
    "500": {
      "description": "Server Error",
      "schema": {
        "$ref": "#/components/schemas/ErrorRes"
      },
      "example": null
    }
  }
}