GET
/
farcaster
/
channel
curl --request GET \
  --url https://api.neynar.com/v2/farcaster/channel \
  --header 'x-api-key: <api-key>'
{
  "channel": {
    "id": "<string>",
    "url": "<string>",
    "object": "channel",
    "name": "<string>",
    "description": "<string>",
    "description_mentioned_profiles": [
      {
        "object": "user_dehydrated",
        "fid": 3,
        "username": "<string>",
        "display_name": "<string>",
        "pfp_url": "<string>",
        "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
      }
    ],
    "description_mentioned_profiles_ranges": [
      {
        "start": 1,
        "end": 1
      }
    ],
    "created_at": 123,
    "follower_count": 123,
    "external_link": {
      "title": "<string>",
      "url": "<string>"
    },
    "image_url": "<string>",
    "parent_url": "<string>",
    "lead": {
      "object": "user",
      "fid": 3,
      "username": "<string>",
      "display_name": "<string>",
      "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
      "pfp_url": "<string>",
      "profile": {
        "bio": {
          "text": "<string>",
          "mentioned_profiles": [
            {
              "object": "user_dehydrated",
              "fid": 3,
              "username": "<string>",
              "display_name": "<string>",
              "pfp_url": "<string>",
              "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
            }
          ],
          "mentioned_profiles_ranges": [
            {
              "start": 1,
              "end": 1
            }
          ],
          "mentioned_channels": [
            {
              "id": "<string>",
              "name": "<string>",
              "object": "channel_dehydrated",
              "image_url": "<string>",
              "viewer_context": {
                "following": true,
                "role": "member"
              }
            }
          ],
          "mentioned_channels_ranges": [
            {
              "start": 1,
              "end": 1
            }
          ]
        },
        "location": {
          "latitude": 0,
          "longitude": 0,
          "radius": 1,
          "address": {
            "city": "<string>",
            "state": "<string>",
            "state_code": "<string>",
            "country": "<string>",
            "country_code": "<string>"
          }
        }
      },
      "follower_count": 123,
      "following_count": 123,
      "verifications": [
        "0x5a927ac639636e534b678e81768ca19e2c6280b7"
      ],
      "verified_addresses": {
        "eth_addresses": [
          "0x5a927ac639636e534b678e81768ca19e2c6280b7"
        ],
        "sol_addresses": [
          "<string>"
        ],
        "primary": {
          "eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
          "sol_address": "<string>"
        }
      },
      "verified_accounts": [
        {
          "platform": "x",
          "username": "<string>"
        }
      ],
      "power_badge": true,
      "experimental": {
        "deprecation_notice": "<string>",
        "neynar_user_score": 123
      },
      "score": 123,
      "viewer_context": {
        "following": true,
        "followed_by": true,
        "blocking": true,
        "blocked_by": true
      }
    },
    "moderator_fids": [
      3
    ],
    "member_count": 123,
    "moderator": {
      "object": "user",
      "fid": 3,
      "username": "<string>",
      "display_name": "<string>",
      "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
      "pfp_url": "<string>",
      "profile": {
        "bio": {
          "text": "<string>",
          "mentioned_profiles": [
            {
              "object": "user_dehydrated",
              "fid": 3,
              "username": "<string>",
              "display_name": "<string>",
              "pfp_url": "<string>",
              "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
            }
          ],
          "mentioned_profiles_ranges": [
            {
              "start": 1,
              "end": 1
            }
          ],
          "mentioned_channels": [
            {
              "id": "<string>",
              "name": "<string>",
              "object": "channel_dehydrated",
              "image_url": "<string>",
              "viewer_context": {
                "following": true,
                "role": "member"
              }
            }
          ],
          "mentioned_channels_ranges": [
            {
              "start": 1,
              "end": 1
            }
          ]
        },
        "location": {
          "latitude": 0,
          "longitude": 0,
          "radius": 1,
          "address": {
            "city": "<string>",
            "state": "<string>",
            "state_code": "<string>",
            "country": "<string>",
            "country_code": "<string>"
          }
        }
      },
      "follower_count": 123,
      "following_count": 123,
      "verifications": [
        "0x5a927ac639636e534b678e81768ca19e2c6280b7"
      ],
      "verified_addresses": {
        "eth_addresses": [
          "0x5a927ac639636e534b678e81768ca19e2c6280b7"
        ],
        "sol_addresses": [
          "<string>"
        ],
        "primary": {
          "eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
          "sol_address": "<string>"
        }
      },
      "verified_accounts": [
        {
          "platform": "x",
          "username": "<string>"
        }
      ],
      "power_badge": true,
      "experimental": {
        "deprecation_notice": "<string>",
        "neynar_user_score": 123
      },
      "score": 123,
      "viewer_context": {
        "following": true,
        "followed_by": true,
        "blocking": true,
        "blocked_by": true
      }
    },
    "pinned_cast_hash": "0xfe90f9de682273e05b201629ad2338bdcd89b6be",
    "hosts": [
      {
        "object": "user",
        "fid": 3,
        "username": "<string>",
        "display_name": "<string>",
        "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "pfp_url": "<string>",
        "profile": {
          "bio": {
            "text": "<string>",
            "mentioned_profiles": [
              {
                "object": "user_dehydrated",
                "fid": 3,
                "username": "<string>",
                "display_name": "<string>",
                "pfp_url": "<string>",
                "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
              }
            ],
            "mentioned_profiles_ranges": [
              {
                "start": 1,
                "end": 1
              }
            ],
            "mentioned_channels": [
              {
                "id": "<string>",
                "name": "<string>",
                "object": "channel_dehydrated",
                "image_url": "<string>",
                "viewer_context": {
                  "following": true,
                  "role": "member"
                }
              }
            ],
            "mentioned_channels_ranges": [
              {
                "start": 1,
                "end": 1
              }
            ]
          },
          "location": {
            "latitude": 0,
            "longitude": 0,
            "radius": 1,
            "address": {
              "city": "<string>",
              "state": "<string>",
              "state_code": "<string>",
              "country": "<string>",
              "country_code": "<string>"
            }
          }
        },
        "follower_count": 123,
        "following_count": 123,
        "verifications": [
          "0x5a927ac639636e534b678e81768ca19e2c6280b7"
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0x5a927ac639636e534b678e81768ca19e2c6280b7"
          ],
          "sol_addresses": [
            "<string>"
          ],
          "primary": {
            "eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
            "sol_address": "<string>"
          }
        },
        "verified_accounts": [
          {
            "platform": "x",
            "username": "<string>"
          }
        ],
        "power_badge": true,
        "experimental": {
          "deprecation_notice": "<string>",
          "neynar_user_score": 123
        },
        "score": 123,
        "viewer_context": {
          "following": true,
          "followed_by": true,
          "blocking": true,
          "blocked_by": true
        }
      }
    ],
    "viewer_context": {
      "following": true,
      "role": "member"
    }
  }
}

Authorizations

​
x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Query Parameters

​
id
string
required

Channel ID for the channel being queried

​
type
enum<string>

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

Available options:
id,
parent_url
​
viewer_fid
integer

FID of the user viewing the channel.

Example:

3

Response

200
application/json

Successful response

The response is of type object.