v1

latestOpenAPI 3.0.42026-07-26159287356.1 KB
Subscribers

Subscribers of a user

Fetch subscribers for a given FID's contracts. Doesn't return addresses that don't have an FID.

get/v2/farcaster/user/subscribers/

Query parameters

fidinteger required
Example:3

The unique identifier of a farcaster user or app (unsigned integer)

viewer_fidinteger
subscription_provider'fabric_stp' | 'paragraph' required
Example:fabric_stp

The provider of the subscription.

Response

Success

Example response

{
  "subscribers": [
    {
      "subscribed_to": {
        "chain": 8453,
        "contract_address": "0x325b3e2c19f4900f8f4eb5f6872dc2715e77cbac",
        "expires_at": "2023-09-13T22:10:22.000Z",
        "protocol_version": 1,
        "provider_name": "fabric_stp",
        "subscribed_at": "2023-09-13T22:10:22.000Z",
        "tier_id": "0"
      },
      "user": {
        "auth_addresses": [
          {
            "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
            "app": {
              "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
              "fid": 3
            }
          }
        ],
        "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "fid": 3,
        "profile": {
          "bio": {
            "mentioned_profiles": [
              {
                "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
                "fid": 3
              }
            ]
          }
        },
        "verifications": [
          "0x5a927ac639636e534b678e81768ca19e2c6280b7"
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0x5a927ac639636e534b678e81768ca19e2c6280b7"
          ],
          "primary": {
            "eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
          }
        }
      }
    }
  ]
}