Neynar · Example Payload

Fetch Feed By Channel Ids

Fetch feed based on channel IDs

Feed

Fetch Feed By Channel Ids 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-feed-by-channel-ids",
  "method": "GET",
  "path": "/v2/farcaster/feed/channels/",
  "summary": "By channel IDs",
  "description": "Fetch feed based on channel IDs",
  "tags": [
    "Feed"
  ],
  "parameters": [
    {
      "name": "",
      "in": "",
      "required": false,
      "description": ""
    },
    {
      "name": "channel_ids",
      "in": "query",
      "required": true,
      "description": "Comma separated list of up to 10 channel IDs e.g. neynar,farcaster",
      "schema": {
        "example": "neynar,farcaster",
        "type": "string",
        "x-comma-separated": true
      }
    },
    {
      "name": "with_recasts",
      "in": "query",
      "required": false,
      "description": "Include recasts in the response, true by default",
      "schema": {
        "default": true,
        "type": "boolean"
      }
    },
    {
      "name": "viewer_fid",
      "in": "query",
      "required": false,
      "description": "Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.",
      "schema": {
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "name": "with_replies",
      "in": "query",
      "required": false,
      "description": "Include replies in the response, false by default",
      "schema": {
        "default": false,
        "type": "boolean"
      }
    },
    {
      "name": "members_only",
      "in": "query",
      "required": false,
      "description": "Used when filter_type=channel_id. Only include casts from members of the channel. True by default.",
      "schema": {
        "default": true,
        "deprecated": true,
        "example": true,
        "type": "boolean"
      }
    },
    {
      "name": "fids",
      "in": "query",
      "required": false,
      "description": "Comma separated list of FIDs to filter the feed by, up to 10 at a time",
      "schema": {
        "type": "string",
        "x-accept-as": "integer",
        "x-comma-separated": true
      }
    },
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "Number of results to fetch",
      "schema": {
        "default": 25,
        "format": "int32",
        "maximum": 100,
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "description": "Pagination cursor.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "should_moderate",
      "in": "query",
      "required": false,
      "description": "If true, only casts that have been liked by the moderator (if one exists) will be returned.",
      "schema": {
        "default": false,
        "deprecated": true,
        "type": "boolean"
      }
    }
  ],
  "requestBody": null,
  "responses": {
    "200": {
      "description": "Success",
      "schema": {
        "$ref": "#/components/schemas/FeedResponse"
      },
      "example": null
    },
    "400": {
      "description": "Bad Request",
      "schema": {
        "$ref": "#/components/schemas/ErrorRes"
      },
      "example": null
    }
  }
}