Neynar · Example Payload

Fetch Followers For A Channel

Returns a list of followers for a specific channel. Max limit is 1000. Use cursor for pagination.

Channel

Fetch Followers For A Channel 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": "fetch-followers-for-a-channel",
  "method": "GET",
  "path": "/v2/farcaster/channel/followers/",
  "summary": "For channel",
  "description": "Returns a list of followers for a specific channel. Max limit is 1000. Use cursor for pagination.",
  "tags": [
    "Channel"
  ],
  "parameters": [
    {
      "name": "",
      "in": "",
      "required": false,
      "description": ""
    },
    {
      "name": "id",
      "in": "query",
      "required": true,
      "description": "Channel ID for the channel being queried",
      "schema": {
        "example": "founders",
        "type": "string"
      }
    },
    {
      "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": "cursor",
      "in": "query",
      "required": false,
      "description": "Pagination cursor.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "Number of followers to fetch",
      "schema": {
        "default": 25,
        "example": 30,
        "format": "int32",
        "maximum": 1000,
        "minimum": 1,
        "type": "integer"
      }
    }
  ],
  "requestBody": null,
  "responses": {
    "200": {
      "description": "Success",
      "schema": {
        "$ref": "#/components/schemas/UsersResponse"
      },
      "example": null
    },
    "400": {
      "description": "Bad Request",
      "schema": {
        "$ref": "#/components/schemas/ErrorRes"
      },
      "example": null
    }
  }
}