Farcaster
App · 20 actions
Read Farcaster profiles, casts, channels, and notifications. Publish casts or react with an approved signer.
Actions
| Action | What it does |
|---|---|
| Add reaction | Like or recast a Farcaster cast using an approved signer. |
| Delete cast | Delete a cast using the signer approved by its author. |
| Get cast | Read a cast by its hash or public URL. |
| Get channel | Read a Farcaster channel's information. |
| Get conversation | Read a cast and its reply thread. |
| Get signer status | Check whether a Neynar signer can act for a Farcaster account. |
| Get user by username | Look up a public Farcaster profile and its numeric identifier. |
| Get users by ID | Look up up to 100 Farcaster profiles by numeric ID. |
| List cast reactions | Read likes and recasts for a public cast. |
| List channel casts | Read recent casts from one or more Farcaster channels. |
| List followed users | See which users an account follows. |
| List followers | See which users follow an account. |
| List notifications | Read recent activity notifications for a Farcaster user. |
| List quote casts | Find casts quoting the selected cast. |
| List user casts | Get a user's casts newest first, with optional replies. |
| Publish cast | Publish a cast or reply using a signer approved by your account. |
| Remove reaction | Remove a like or recast using the signer that added it. |
| Search casts | Find public casts matching a query. |
| Search channels | Find public channels by name or ID. |
| Search users | Find Farcaster profiles by username. |
Add reaction
Like or recast a Farcaster cast using an approved signer.
Inputs
- Signer UUID
signer_uuidtextRequired - Enter a Neynar signer UUID approved by your Farcaster account.
- Reaction type
reaction_typetextRequired - Choose a like or a recast.One of:
like,recast. - Target
targettextRequired - Enter the cast hash or target URL.
- Target author fid
target_author_fidnumber - Enter the Farcaster ID of the cast author, if required for the target.At least 1.
Outputs
dataobject- The response from Farcaster.
Example output
{
"data": {
"success": true
}
}Delete cast
Delete a cast using the signer approved by its author.
Inputs
- Signer UUID
signer_uuidtextRequired - Enter a Neynar signer UUID approved by your Farcaster account.
- Cast hash
cast_hashtextRequired - Enter the hash returned when the cast was published.
Outputs
dataobject- The response from Farcaster.
Example output
{
"data": {
"success": true
}
}Get cast
Read a cast by its hash or public URL.
Inputs
- Identifier type
identifier_typetextRequired - Choose how to identify the cast.One of:
hash,url. - Identifier
identifiertextRequired - Enter the cast hash or its Farcaster URL.
Outputs
dataobject- The response from Farcaster.
Example output
{
"data": {
"cast": {
"author": {
"display_name": "example",
"fid": 1,
"username": "example"
},
"hash": "example",
"text": "example",
"timestamp": "example"
}
}
}Get channel
Read a Farcaster channel's information.
Inputs
- Identifier
identifiertextRequired - Enter the channel ID or parent URL.
- Identifier type
identifier_typetext - Choose which identifier you entered.One of:
id,parent_url(Parent url). Default:id.
Outputs
dataobject- The response from Farcaster.
Example output
{
"data": {
"channel": {
"id": "example",
"name": "example",
"parent_url": "example"
}
}
}Get conversation
Read a cast and its reply thread.
Inputs
- Identifier type
identifier_typetextRequired - Choose how to identify the cast.One of:
hash,url. - Identifier
identifiertextRequired - Enter the cast hash or its Farcaster URL.
- Reply depth
reply_depthnumber - Choose how many levels of replies to expand.At least 0.
- Sort type
sort_typetext - Choose how to order replies.One of:
chron,desc_chron(Desc chron),algorithmic. - Limit
limitnumber - Maximum number of entries to return.From 1 to 50.
- Cursor
cursortext - Use the cursor returned by the previous page.
Outputs
dataobject- The response from Farcaster.
Example output
{
"data": {
"conversation": {
"cast": {
"author": {
"display_name": "example",
"fid": 1,
"username": "example"
},
"hash": "example",
"text": "example",
"timestamp": "example"
}
},
"next": {
"cursor": "example"
}
}
}Get signer status
Check whether a Neynar signer can act for a Farcaster account.
Inputs
- Signer UUID
signer_uuidtextRequired - Enter a Neynar signer UUID approved by your Farcaster account.
Outputs
dataobject- The response from Farcaster.
Example output
{
"data": {
"signer_uuid": "example",
"status": "example"
}
}Get user by username
Look up a public Farcaster profile and its numeric identifier.
Inputs
- Username
usernametextRequired - Enter the Farcaster username.
Outputs
dataobject- The response from Farcaster.
Example output
{
"data": {
"user": {
"display_name": "example",
"fid": 1,
"username": "example"
}
}
}Get users by ID
Look up up to 100 Farcaster profiles by numeric ID.
Inputs
- Fids
fidslistRequired - Enter the Farcaster IDs.
Outputs
dataobject- The response from Farcaster.
Example output
{
"data": {
"users": [
{
"display_name": "example",
"fid": 1,
"username": "example"
}
]
}
}List cast reactions
Read likes and recasts for a public cast.
Inputs
- Cast hash
cast_hashtextRequired - Enter the cast hash.
- Types
typeslistRequired - Choose likes, recasts, or all reactions.One or more of:
all,likes,recasts. - Limit
limitnumber - Maximum number of entries to return.From 1 to 100.
- Cursor
cursortext - Use the cursor returned by the previous page.
Outputs
dataobject- The response from Farcaster.
Example output
{
"data": {
"next": {
"cursor": "example"
},
"reactions": [
{}
]
}
}List channel casts
Read recent casts from one or more Farcaster channels.
Inputs
- Channel IDS
channel_idslistRequired - Enter the IDs of up to ten channels.
- With replies
with_repliestrue/false - Include replies in the result.
- With recasts
with_recaststrue/false - Include recasts in the result.
- Limit
limitnumber - Maximum number of entries to return.From 1 to 100.
- Cursor
cursortext - Use the cursor returned by the previous page.
Outputs
dataobject- The response from Farcaster.
Example output
{
"data": {
"casts": [
{
"author": {
"display_name": "example",
"fid": 1,
"username": "example"
},
"hash": "example",
"text": "example",
"timestamp": "example"
}
],
"next": {
"cursor": "example"
}
}
}List followed users
See which users an account follows.
Inputs
- Farcaster ID
fidnumberRequired - Enter the user's numeric Farcaster ID.At least 1.
- Sort type
sort_typetext - Choose how to order followed users.One of:
desc_chron(Desc chron),algorithmic. - Limit
limitnumber - Maximum number of entries to return.From 1 to 100.
- Cursor
cursortext - Use the cursor returned by the previous page.
Outputs
dataobject- The response from Farcaster.
Example output
{
"data": {
"next": {
"cursor": "example"
},
"users": [
{
"user": {
"display_name": "example",
"fid": 1,
"username": "example"
}
}
]
}
}List followers
See which users follow an account.
Inputs
- Farcaster ID
fidnumberRequired - Enter the user's numeric Farcaster ID.At least 1.
- Sort type
sort_typetext - Choose how to order followers.One of:
desc_chron(Desc chron),algorithmic. - Limit
limitnumber - Maximum number of entries to return.From 1 to 100.
- Cursor
cursortext - Use the cursor returned by the previous page.
Outputs
dataobject- The response from Farcaster.
Example output
{
"data": {
"next": {
"cursor": "example"
},
"users": [
{
"user": {
"display_name": "example",
"fid": 1,
"username": "example"
}
}
]
}
}List notifications
Read recent activity notifications for a Farcaster user.
Inputs
- Farcaster ID
fidnumberRequired - Enter the user's numeric Farcaster ID.At least 1.
- Types
typeslist - Choose which notifications to return.One or more of:
follows,recasts,likes,mentions,replies,quotes. - Limit
limitnumber - Maximum number of entries to return.From 1 to 25.
- Cursor
cursortext - Use the cursor returned by the previous page.
Outputs
dataobject- The response from Farcaster.
Example output
{
"data": {
"next": {
"cursor": "example"
},
"notifications": [
{
"cast": {
"author": {
"display_name": "example",
"fid": 1,
"username": "example"
},
"hash": "example",
"text": "example",
"timestamp": "example"
},
"count": 1,
"most_recent_timestamp": "example",
"type": "example"
}
],
"unseen_notifications_count": 1
}
}List quote casts
Find casts quoting the selected cast.
Inputs
- Identifier type
identifier_typetextRequired - Choose how to identify the cast.One of:
hash,url. - Identifier
identifiertextRequired - Enter the cast hash or its Farcaster URL.
- Limit
limitnumber - Maximum number of entries to return.From 1 to 100.
- Cursor
cursortext - Use the cursor returned by the previous page.
Outputs
dataobject- The response from Farcaster.
Example output
{
"data": {
"casts": [
{
"author": {
"display_name": "example",
"fid": 1,
"username": "example"
},
"hash": "example",
"text": "example",
"timestamp": "example"
}
],
"next": {
"cursor": "example"
}
}
}List user casts
Get a user's casts newest first, with optional replies.
Inputs
- Farcaster ID
fidnumberRequired - Enter the user's numeric Farcaster ID.At least 1.
- Channel ID
channel_idtext - Enter the channel ID, such as farcaster.
- Include replies
include_repliestrue/false - Include reply casts.
- Limit
limitnumber - Maximum number of entries to return.From 1 to 150.
- Cursor
cursortext - Use the cursor returned by the previous page.
Outputs
dataobject- The response from Farcaster.
Example output
{
"data": {
"casts": [
{
"author": {
"display_name": "example",
"fid": 1,
"username": "example"
},
"hash": "example",
"text": "example",
"timestamp": "example"
}
],
"next": {
"cursor": "example"
}
}
}Publish cast
Publish a cast or reply using a signer approved by your account.
Inputs
- Signer UUID
signer_uuidtextRequired - Enter a Neynar signer UUID approved by your Farcaster account.
- Text
texttextRequired - Enter the cast or reply text.
- Parent
parenttext - Enter a parent cast hash to reply to, or a channel parent URL.
- Channel ID
channel_idtext - Choose a destination channel by ID.
- Embed URLS
embed_urlslist - Enter up to two URLs to attach.
- Idempotency key
idempotency_keytext - Set a distinct key per cast to prevent duplicates on repeated calls.
Outputs
dataobject- The response from Farcaster.
Example output
{
"data": {
"cast": {
"author": {
"display_name": "example",
"fid": 1,
"username": "example"
},
"hash": "example",
"text": "example",
"timestamp": "example"
},
"success": true
}
}Remove reaction
Remove a like or recast using the signer that added it.
Inputs
- Signer UUID
signer_uuidtextRequired - Enter a Neynar signer UUID approved by your Farcaster account.
- Reaction type
reaction_typetextRequired - Choose a like or a recast.One of:
like,recast. - Target
targettextRequired - Enter the cast hash or target URL.
- Target author fid
target_author_fidnumber - Enter the Farcaster ID of the cast author, if required for the target.At least 1.
Outputs
dataobject- The response from Farcaster.
Example output
{
"data": {
"success": true
}
}Search casts
Find public casts matching a query.
Inputs
- Query
querytextRequired - Enter what you want to find.
- Channel ID
channel_idtext - Enter the channel ID, such as farcaster.
- Mode
modetext - Choose how the search matches terms.One of:
literal,semantic,hybrid. - Author fid
author_fidnumber - Limit results to this Farcaster ID.At least 1.
- Limit
limitnumber - Maximum number of entries to return.From 1 to 100.
- Cursor
cursortext - Use the cursor returned by the previous page.
Outputs
dataobject- The response from Farcaster.
Example output
{
"data": {
"result": {
"casts": [
{
"author": {
"display_name": "example",
"fid": 1,
"username": "example"
},
"hash": "example",
"text": "example",
"timestamp": "example"
}
],
"next": {
"cursor": "example"
}
}
}
}Search channels
Find public channels by name or ID.
Inputs
- Query
querytextRequired - Enter what you want to find.
- Limit
limitnumber - Maximum number of entries to return.From 1 to 200.
- Cursor
cursortext - Use the cursor returned by the previous page.
Outputs
dataobject- The response from Farcaster.
Example output
{
"data": {
"channels": [
{
"id": "example",
"name": "example",
"parent_url": "example"
}
],
"next": {
"cursor": "example"
}
}
}Search users
Find Farcaster profiles by username.
Inputs
- Query
querytextRequired - Enter what you want to find.
- Limit
limitnumber - Maximum number of entries to return.From 1 to 10.
- Cursor
cursortext - Use the cursor returned by the previous page.
Outputs
dataobject- The response from Farcaster.
Example output
{
"data": {
"result": {
"next": {
"cursor": "example"
},
"users": [
{
"display_name": "example",
"fid": 1,
"username": "example"
}
]
}
}
}