Fetch Feed

{
  "operationId": "fetch-feed",
  "method": "GET",
  "path": "/v2/farcaster/feed/",
  "summary": "By filters",
  "description": "Fetch casts based on filters. Ensure setting the correct parameters based on the feed_type and filter_type.",
  "tags": [
    "Feed"
  ],
  "parameters": [
    {
      "name": "",
      "in": "",
      "required": false,
      "description": ""
    },
    {
      "name": "feed_type",
      "in": "query",
      "required": false,
      "description": "Defaults to following (requires FID or address). If set to filter (requires filter_type)",
      "schema": {
        "default": "following",
        "enum": [
          "following",
          "filter"
        ],
        "example": "filter",
        "title": "FeedType",
        "type": "string"
      }
    },
    {
      "name": "filter_type",
      "in": "query",
      "required": false,
      "description": "Used when feed_type=filter. Options include fids (requires fids), parent_url (requires parent_url), channel_id (requires channel_id), embed_url (requires embed_url), embed_types (requires embed_types), or global_trending.",
      "schema": {
        "enum": [
          "fids",
          "parent_url",
          "channel_id",
          "embed_url",
          "embed_types",
          "global_trending"
        ],
        "example": "fids",
        "title": "FilterType",
        "type": "string"
      }
    },
    {
      "name": "fid",
      "in": "query",
      "required": false,
      "description": "(Optional) FID of user whose feed you want to create. By default, the API expects this field, except if you pass a filter_type",
      "schema": {
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "name": "fids",
      "in": "query",
      "required": false,
      "description": "Used when filter_type=FIDs . Create a feed based on a list of FIDs. Max array size is 100. Requires feed_type and filter_type.",
      "schema": {
        "example": "3,2,194",
        "type": "string",
        "x-accept-as": "integer",
        "x-comma-separated": true
      }
    },
    {
      "name": "parent_url",
      "in": "query",
      "required": false,
      "description": "Used when filter_type=parent_url can be used to fetch content under any parent url e.g. FIP-2 channels on Warpcast. Requires feed_type and filter_type.",
      "schema": {
        "example": "chain://eip155:1/erc721:0xd4498134211baad5846ce70ce04e7c4da78931cc",
        "type": "string"
      }
    },
    {
      "name": "channel_id",
      "in": "query",
      "required": false,
      "description": "Used when filter_type=channel_id can be used to fetch casts under a channel. Requires feed_type and filter_type.",
      "schema": {
        "example": "neynar",
        "type": "string"
      }
    },
    {
      "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": "embed_url",
      "in": "query",
      "required": false,
      "description": "Used when filter_type=embed_url. Casts with embedded URLs prefixed by this embed_url param will be returned. We normalize your given URL prefix and prepend 'https://' if no protocol is included. Requires feed_type and filter_type.",
      "schema": {
        "example": "https://example.com",
        "type": "string"
      }
    },
    {
      "name": "embed_types",
      "in": "query",
      "required": false,
      "description": "Used when filter_type=embed_types can be used to fetch all casts with matching content types. Requires feed_type and filter_type.",
      "schema": {
        "items": {
          "description": "The content type of the embedded file",
          "enum": [
            "text",
            "image",
            "video",
            "audio",
            "text/html",
            "text/plain",
            "image/jpeg",
            "image/png",
            "image/gif",
            "image/webp",
            "image/svg+xml",
            "image/heif",
            "video/mp4",
            "video/quicktime",
            "audio/mpeg",
            "application/pdf",
            "application/json",
            "application/x-mpegurl"
          ],
          "title": "EmbedType",
          "type": "string"
        },
        "type": "array"
      }
    },
    {
      "name": "with_recasts",
      "in": "query",
      "required": false,
      "description": "Include recasts in the response, true by default",
      "schema": {
        "default": true,
        "type": "boolean"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "Number of results to fetch",
      "schema": {
        "default": 25,
        "example": 30,
        "format": "int32",
        "maximum": 100,
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "description": "Pagination cursor.",
      "schema": {
        "type": "string"
      }
    },
    {
      "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": {
        "example": 3,
        "minimum": 1,
        "type": "integer"
      }
    }
  ],
  "requestBody": null,
  "responses": {
    "200": {
      "description": "Success",
      "schema": {
        "$ref": "#/components/schemas/FeedResponse"
      },
      "example": null
    },
    "400": {
      "description": "Bad Request",
      "schema": {
        "$ref": "#/components/schemas/ErrorRes"
      },
      "example": null
    }
  }
}