Farcaster

App · 20 actions

Read Farcaster profiles, casts, channels, and notifications. Publish casts or react with an approved signer.

Actions

ActionWhat it does
Add reactionLike or recast a Farcaster cast using an approved signer.
Delete castDelete a cast using the signer approved by its author.
Get castRead a cast by its hash or public URL.
Get channelRead a Farcaster channel's information.
Get conversationRead a cast and its reply thread.
Get signer statusCheck whether a Neynar signer can act for a Farcaster account.
Get user by usernameLook up a public Farcaster profile and its numeric identifier.
Get users by IDLook up up to 100 Farcaster profiles by numeric ID.
List cast reactionsRead likes and recasts for a public cast.
List channel castsRead recent casts from one or more Farcaster channels.
List followed usersSee which users an account follows.
List followersSee which users follow an account.
List notificationsRead recent activity notifications for a Farcaster user.
List quote castsFind casts quoting the selected cast.
List user castsGet a user's casts newest first, with optional replies.
Publish castPublish a cast or reply using a signer approved by your account.
Remove reactionRemove a like or recast using the signer that added it.
Search castsFind public casts matching a query.
Search channelsFind public channels by name or ID.
Search usersFind Farcaster profiles by username.

Add reaction

Like or recast a Farcaster cast using an approved signer.

Inputs

Signer UUIDsigner_uuidtextRequired
Enter a Neynar signer UUID approved by your Farcaster account.
Reaction typereaction_typetextRequired
Choose a like or a recast.One of: like, recast.
TargettargettextRequired
Enter the cast hash or target URL.
Target author fidtarget_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 UUIDsigner_uuidtextRequired
Enter a Neynar signer UUID approved by your Farcaster account.
Cast hashcast_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 typeidentifier_typetextRequired
Choose how to identify the cast.One of: hash, url.
IdentifieridentifiertextRequired
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

IdentifieridentifiertextRequired
Enter the channel ID or parent URL.
Identifier typeidentifier_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 typeidentifier_typetextRequired
Choose how to identify the cast.One of: hash, url.
IdentifieridentifiertextRequired
Enter the cast hash or its Farcaster URL.
Reply depthreply_depthnumber
Choose how many levels of replies to expand.At least 0.
Sort typesort_typetext
Choose how to order replies.One of: chron, desc_chron (Desc chron), algorithmic.
Limitlimitnumber
Maximum number of entries to return.From 1 to 50.
Cursorcursortext
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 UUIDsigner_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

UsernameusernametextRequired
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

FidsfidslistRequired
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 hashcast_hashtextRequired
Enter the cast hash.
TypestypeslistRequired
Choose likes, recasts, or all reactions.One or more of: all, likes, recasts.
Limitlimitnumber
Maximum number of entries to return.From 1 to 100.
Cursorcursortext
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 IDSchannel_idslistRequired
Enter the IDs of up to ten channels.
With replieswith_repliestrue/false
Include replies in the result.
With recastswith_recaststrue/false
Include recasts in the result.
Limitlimitnumber
Maximum number of entries to return.From 1 to 100.
Cursorcursortext
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 IDfidnumberRequired
Enter the user's numeric Farcaster ID.At least 1.
Sort typesort_typetext
Choose how to order followed users.One of: desc_chron (Desc chron), algorithmic.
Limitlimitnumber
Maximum number of entries to return.From 1 to 100.
Cursorcursortext
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 IDfidnumberRequired
Enter the user's numeric Farcaster ID.At least 1.
Sort typesort_typetext
Choose how to order followers.One of: desc_chron (Desc chron), algorithmic.
Limitlimitnumber
Maximum number of entries to return.From 1 to 100.
Cursorcursortext
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 IDfidnumberRequired
Enter the user's numeric Farcaster ID.At least 1.
Typestypeslist
Choose which notifications to return.One or more of: follows, recasts, likes, mentions, replies, quotes.
Limitlimitnumber
Maximum number of entries to return.From 1 to 25.
Cursorcursortext
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 typeidentifier_typetextRequired
Choose how to identify the cast.One of: hash, url.
IdentifieridentifiertextRequired
Enter the cast hash or its Farcaster URL.
Limitlimitnumber
Maximum number of entries to return.From 1 to 100.
Cursorcursortext
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 IDfidnumberRequired
Enter the user's numeric Farcaster ID.At least 1.
Channel IDchannel_idtext
Enter the channel ID, such as farcaster.
Include repliesinclude_repliestrue/false
Include reply casts.
Limitlimitnumber
Maximum number of entries to return.From 1 to 150.
Cursorcursortext
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 UUIDsigner_uuidtextRequired
Enter a Neynar signer UUID approved by your Farcaster account.
TexttexttextRequired
Enter the cast or reply text.
Parentparenttext
Enter a parent cast hash to reply to, or a channel parent URL.
Channel IDchannel_idtext
Choose a destination channel by ID.
Embed URLSembed_urlslist
Enter up to two URLs to attach.
Idempotency keyidempotency_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 UUIDsigner_uuidtextRequired
Enter a Neynar signer UUID approved by your Farcaster account.
Reaction typereaction_typetextRequired
Choose a like or a recast.One of: like, recast.
TargettargettextRequired
Enter the cast hash or target URL.
Target author fidtarget_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

QueryquerytextRequired
Enter what you want to find.
Channel IDchannel_idtext
Enter the channel ID, such as farcaster.
Modemodetext
Choose how the search matches terms.One of: literal, semantic, hybrid.
Author fidauthor_fidnumber
Limit results to this Farcaster ID.At least 1.
Limitlimitnumber
Maximum number of entries to return.From 1 to 100.
Cursorcursortext
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

QueryquerytextRequired
Enter what you want to find.
Limitlimitnumber
Maximum number of entries to return.From 1 to 200.
Cursorcursortext
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

QueryquerytextRequired
Enter what you want to find.
Limitlimitnumber
Maximum number of entries to return.From 1 to 10.
Cursorcursortext
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"
        }
      ]
    }
  }
}

On this page