packages/docs/plugin-registry/platform/farcaster.md
The Farcaster plugin connects Eliza agents to the Farcaster decentralized social protocol, enabling agents to cast (post), reply, react, and interact with users on the Farcaster network.
Package: @elizaos/plugin-farcaster
Farcaster is a sufficiently decentralized social protocol. Users own their accounts on-chain (via Ethereum) while messages are stored off-chain on Hubs. The Eliza Farcaster plugin interacts with the network via the Neynar API.
eliza plugins install @elizaos/plugin-farcaster
Neynar provides managed access to the Farcaster Hub network:
Your agent needs a Farcaster account (FID — Farcaster ID):
{
"connectors": {
"farcaster": {
"apiKey": "YOUR_NEYNAR_API_KEY",
"signerUuid": "YOUR_SIGNER_UUID",
"fid": 12345
}
}
}
| Field | Required | Description |
|---|---|---|
apiKey | Yes | Neynar API key |
signerUuid | Yes | Neynar signer UUID for the agent account |
fid | Yes | Farcaster ID (FID) of the agent account |
enabled | No | Set false to disable (default: true) |
pollInterval | No | Seconds between mention checks (default: 120) |
channels | No | Array of Farcaster channel names to monitor |
castIntervalMin | No | Min minutes between autonomous casts (default: 90) |
castIntervalMax | No | Max minutes between autonomous casts (default: 180) |
{
"connectors": {
"farcaster": {
"apiKey": "...",
"signerUuid": "...",
"fid": 12345,
"channels": ["ai", "agents"],
"castIntervalMin": 90,
"castIntervalMax": 180
}
}
}
Neynar webhook or polling
↓
Plugin filters relevant notifications:
- @mention in cast
- Reply to agent's cast
- Direct cast
↓
AgentRuntime processes with Farcaster context
↓
Response posted via Neynar API
| Variable | Required | Description |
|---|---|---|
FARCASTER_NEYNAR_API_KEY | Yes | API key for the Neynar Farcaster API |
FARCASTER_SIGNER_UUID | Yes | UUID of the Neynar signer for the agent account |
FARCASTER_FID | Yes | Farcaster ID (user identifier) for the agent |
FARCASTER_HUB_URL | No | Base URL for the Farcaster hub |
FARCASTER_MODE | No | Operation mode: polling or webhook |
FARCASTER_DRY_RUN | No | Enable dry run mode (no actual posts) |
FARCASTER_POLL_INTERVAL | No | Polling interval in seconds |
When configured, the agent posts casts autonomously at random intervals. The LLM generates cast content based on the character's personality and current context.
Casts are limited to 320 characters. Longer responses are split into cast threads.
| Variable | Description |
|---|---|
FARCASTER_NEYNAR_API_KEY | Neynar API key. When set, the runtime maps this to the connector's apiKey field. |
The plugin auto-enables when connectors.farcaster.apiKey is set or the FARCASTER_NEYNAR_API_KEY environment variable is present.