v1

latestOpenAPI 3.0.42026-07-26159287356.1 KB

Channel

By ID or parent_url

Returns details of a channel

get/v2/farcaster/channel/

Query parameters

idstring required

Example:neynar

Channel ID for the channel being queried

type'id' | 'parent_url'

Example:id

Type of identifier being used to query the channel. Defaults to ID.

viewer_fidinteger

FID of the user viewing the channel.

Response

Success

Example response

{
  "channel": {
    "description_mentioned_profiles": [
      {
        "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "fid": 3
      }
    ],
    "hosts": [
      {
        "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"
          }
        }
      }
    ],
    "lead": {
      "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"
        }
      }
    },
    "moderator": {
      "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"
        }
      }
    },
    "moderator_fids": [
      3
    ],
    "pinned_cast_hash": "0x71d5225f77e0164388b1d4c120825f3a2c1f131c"
  }
}