Channels by activity

Status

Blog

Overview

Farcaster API V2

Onchain

Farcaster Hub API

Neynar SDK

Github

GET

farcaster

channel

trending

curl --request GET \
  --url https://api.neynar.com/v2/farcaster/channel/trending \
  --header 'x-api-key: <api-key>'

{
  "channels": [
    {
      "object": "channel_activity",
      "cast_count_1d": "<string>",
      "cast_count_7d": "<string>",
      "cast_count_30d": "<string>",
      "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,
              "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": {
            "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,
              "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": {
            "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,
                "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": {
              "neynar_user_score": 123
            },
            "score": 123,
            "viewer_context": {
              "following": true,
              "followed_by": true,
              "blocking": true,
              "blocked_by": true
            }
          }
        ],
        "viewer_context": {
          "following": true,
          "role": "member"
        }
      }
    }
  ],
  "next": {
    "cursor": "<string>"
  }
}

Authorizations

x-api-key

string

header

default:NEYNAR_API_DOCS

required

API key to authorize requests

Query Parameters

time_window

enum<string>

Available options:

1d,

7d,

30d

limit

integer

default:10

Number of results to fetch

Required range: 1 <= x <= 25

cursor

string

Pagination cursor.

Response

200

application/json

Successful response

channels

object[]

required

channels.object

enum<string>

required

Available options:

channel_activity

channels.cast_count_1d

string

required

channels.cast_count_7d

string

required

channels.cast_count_30d

string

required

channels.channel

object

required

channels.channel.id

string

required

channels.channel.url

string

required

channels.channel.object

enum<string>

required

Available options:

channel

channels.channel.name

string

channels.channel.description

string

channels.channel.description_mentioned_profiles

object[]

channels.channel.description_mentioned_profiles_ranges

object[]

Positions within the text (inclusive start, exclusive end) where each mention occurs.

channels.channel.created_at

number

Epoch timestamp in seconds.

channels.channel.follower_count

number

Number of followers the channel has.

channels.channel.external_link

object

Channel's external link.

channels.channel.image_url

string

channels.channel.parent_url

string

channels.channel.lead

object

channels.channel.lead.object

enum<string>

required

Available options:

user

channels.channel.lead.fid

integer

required

The unique identifier of a farcaster user (unsigned integer)

Examples:

3

191

2

194

19960

channels.channel.lead.username

string

required

channels.channel.lead.custody_address

string

required

Ethereum address

Example:

"0x5a927ac639636e534b678e81768ca19e2c6280b7"

channels.channel.lead.profile

object

required

channels.channel.lead.follower_count

integer

required

The number of followers the user has.

channels.channel.lead.following_count

integer

required

The number of users the user is following.

channels.channel.lead.verifications

string[]

required

Ethereum address

channels.channel.lead.verified_addresses

object

required

channels.channel.lead.verified_accounts

object[]

required

Verified accounts of the user on other platforms, currently only X is supported.

channels.channel.lead.power_badge

boolean

required

channels.channel.lead.score

number

required

Score that represents the probability that the account is not spam.

channels.channel.lead.display_name

string

channels.channel.lead.pfp_url

string

The URL of the user's profile picture

channels.channel.lead.experimental

object

channels.channel.lead.viewer_context

object

Adds context on the viewer's follow relationship with the user.

channels.channel.moderator_fids

integer[]

The unique identifier of a farcaster user (unsigned integer)

channels.channel.member_count

integer

channels.channel.moderator

object

Use lead instead.

channels.channel.moderator.object

enum<string>

required

Available options:

user

channels.channel.moderator.fid

integer

required

The unique identifier of a farcaster user (unsigned integer)

Examples:

3

191

2

194

19960

channels.channel.moderator.username

string

required

channels.channel.moderator.custody_address

string

required

Ethereum address

Example:

"0x5a927ac639636e534b678e81768ca19e2c6280b7"

channels.channel.moderator.profile

object

required

channels.channel.moderator.follower_count

integer

required

The number of followers the user has.

channels.channel.moderator.following_count

integer

required

The number of users the user is following.

channels.channel.moderator.verifications

string[]

required

Ethereum address

channels.channel.moderator.verified_addresses

object

required

channels.channel.moderator.verified_accounts

object[]

required

Verified accounts of the user on other platforms, currently only X is supported.

channels.channel.moderator.power_badge

boolean

required

channels.channel.moderator.score

number

required

Score that represents the probability that the account is not spam.

channels.channel.moderator.display_name

string

channels.channel.moderator.pfp_url

string

The URL of the user's profile picture

channels.channel.moderator.experimental

object

channels.channel.moderator.viewer_context

object

Adds context on the viewer's follow relationship with the user.

channels.channel.pinned_cast_hash

string

default:0xfe90f9de682273e05b201629ad2338bdcd89b6be

Hash of the pinned cast in the channel.

channels.channel.hosts

object[]

deprecated

channels.channel.hosts.object

enum<string>

required

Available options:

user

channels.channel.hosts.fid

integer

required

The unique identifier of a farcaster user (unsigned integer)

Examples:

3

191

2

194

19960

channels.channel.hosts.username

string

required

channels.channel.hosts.custody_address

string

required

Ethereum address

Example:

"0x5a927ac639636e534b678e81768ca19e2c6280b7"

channels.channel.hosts.profile

object

required

channels.channel.hosts.follower_count

integer

required

The number of followers the user has.

channels.channel.hosts.following_count

integer

required

The number of users the user is following.

channels.channel.hosts.verifications

string[]

required

Ethereum address

channels.channel.hosts.verified_addresses

object

required

channels.channel.hosts.verified_accounts

object[]

required

Verified accounts of the user on other platforms, currently only X is supported.

channels.channel.hosts.power_badge

boolean

required

channels.channel.hosts.score

number

required

Score that represents the probability that the account is not spam.

channels.channel.hosts.display_name

string

channels.channel.hosts.pfp_url

string

The URL of the user's profile picture

channels.channel.hosts.experimental

object

channels.channel.hosts.viewer_context

object

Adds context on the viewer's follow relationship with the user.

channels.channel.viewer_context

object

Adds context on the viewer's or author's role in the channel.

object

required

Returns next cursor

Unfollow a channel Fetch all channels with their details

curl --request GET \
  --url https://api.neynar.com/v2/farcaster/channel/trending \
  --header 'x-api-key: <api-key>'

{
  "channels": [
    {
      "object": "channel_activity",
      "cast_count_1d": "<string>",
      "cast_count_7d": "<string>",
      "cast_count_30d": "<string>",
      "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,
              "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": {
            "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,
              "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": {
            "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,
                "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": {
              "neynar_user_score": 123
            },
            "score": 123,
            "viewer_context": {
              "following": true,
              "followed_by": true,
              "blocking": true,
              "blocked_by": true
            }
          }
        ],
        "viewer_context": {
          "following": true,
          "role": "member"
        }
      }
    }
  ],
  "next": {
    "cursor": "<string>"
  }
}