FarcasterChannels API
Learn all the detailed references of FarcasterChannels API that provide Farcaster channel participants information, including the input filters and output fields.
The FarcasaterChannels API fetches the details of Farcaster channels, which include data such as channel name, channel ID, description, image URI, participants, and more.
Inputs
filter
Name | Type | Description |
---|---|---|
|
| The channel ID, e.g. for /warpcast channel, the ID is "warpcast". |
|
| Creation timestamp of the channel. |
|
| The channel creator/original host's FIDs. |
|
| The channel creator/original host's web3 identities, either 0x address, Farcaster, ENS, or Lens. For more details, check out Airstack Identity API. |
|
| Filter by any channel moderator FIDs
If you are looking to filter by creators or original host's FIDs, then use |
|
| Filter by any channel moderator web3 identities.
If you are looking to filter by creators or original host's web3 identities, then use |
|
| The name of the channel, not necessarily the same as the channel ID. It is the title that you see in the channel page, e.g. for /warpcast channel, the name is "Warpcast". |
blockchain
For FarcasterChannelParticipants API, it will return all Farcaster channels.
You just need to specify the input to ALL
for the query to work.
Enum | Description |
---|---|
| - |
order
Name | Description |
---|---|
| Sort the result by the channel creation timestamp. |
| Sort the result by the number of channel followers. |
Output
Name | Type | Description |
---|---|---|
|
| The channel ID, e.g. for /warpcast channel, the ID is "warpcast". |
|
| The last timestamp when an action (either cast or reply) occur by a participant. |
|
| Dapp name. Currently, only supports |
|
| Dapp name. Currently, only supports |
|
| Airstack unique identifier for the data point. |
|
| The channel description. |
|
| The number of followers of a channel. |
|
| The channel image URL. |
|
| To indicate whether any moderation is enabled on the channel. |
|
| The original host's FIDs. |
| Nested Query â The original host's profile details. | |
|
| All the moderator's FIDs. |
| Nested Query â All the moderator's profile details. | |
|
| The name of the channel, not necessarily the same as the channel ID. It is the title that you see in the channel page, e.g. for /warpcast channel, the name is "Warpcast". |
| Nested Query â associated participants details. | |
|
| Warpcast URL to the channel. |
Last updated