Neynar · Example Payload

Fetch Subscribed To For Fid

Fetch what FIDs and contracts a FID is subscribed to.

Subscribers

Fetch Subscribed To For Fid 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-subscribed-to-for-fid",
  "method": "GET",
  "path": "/v2/farcaster/user/subscribed_to/",
  "summary": "Subscribed to",
  "description": "Fetch what FIDs and contracts a FID is subscribed to.",
  "tags": [
    "Subscribers"
  ],
  "parameters": [
    {
      "name": "fid",
      "in": "query",
      "required": true,
      "description": "The unique identifier of a farcaster user or app (unsigned integer)",
      "schema": {
        "example": 3,
        "format": "int32",
        "minimum": 0,
        "title": "Fid",
        "type": "integer"
      }
    },
    {
      "name": "viewer_fid",
      "in": "query",
      "required": false,
      "description": "",
      "schema": {
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "name": "subscription_provider",
      "in": "query",
      "required": true,
      "description": "The provider of the subscription.",
      "schema": {
        "enum": [
          "fabric_stp"
        ],
        "type": "string"
      }
    }
  ],
  "requestBody": null,
  "responses": {
    "200": {
      "description": "Success",
      "schema": {
        "$ref": "#/components/schemas/SubscribedToResponse"
      },
      "example": null
    },
    "400": {
      "description": "Bad Request",
      "schema": {
        "$ref": "#/components/schemas/ErrorRes"
      },
      "example": null
    }
  }
}