# Farcaster

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

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/farcaster

## Actions

### Add reaction

Like or recast a Farcaster cast using an approved signer.

**Inputs**

- Signer UUID (`signer_uuid`, text, required): Enter a Neynar signer UUID approved by your Farcaster account.
- Reaction type (`reaction_type`, text, required): Choose a like or a recast. One of: `like`, `recast`.
- Target (`target`, text, required): Enter the cast hash or target URL.
- Target author fid (`target_author_fid`, number): Enter the Farcaster ID of the cast author, if required for the target. At least 1.

**Outputs**

- `data` (object): The response from Farcaster.

**Example output**

```json
{
  "data": {
    "success": true
  }
}
```

### Delete cast

Delete a cast using the signer approved by its author.

**Inputs**

- Signer UUID (`signer_uuid`, text, required): Enter a Neynar signer UUID approved by your Farcaster account.
- Cast hash (`cast_hash`, text, required): Enter the hash returned when the cast was published.

**Outputs**

- `data` (object): The response from Farcaster.

**Example output**

```json
{
  "data": {
    "success": true
  }
}
```

### Get cast

Read a cast by its hash or public URL.

**Inputs**

- Identifier type (`identifier_type`, text, required): Choose how to identify the cast. One of: `hash`, `url`.
- Identifier (`identifier`, text, required): Enter the cast hash or its Farcaster URL.

**Outputs**

- `data` (object): The response from Farcaster.

**Example output**

```json
{
  "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 (`identifier`, text, required): Enter the channel ID or parent URL.
- Identifier type (`identifier_type`, text): Choose which identifier you entered. One of: `id`, `parent_url` (Parent url). Default: `id`.

**Outputs**

- `data` (object): The response from Farcaster.

**Example output**

```json
{
  "data": {
    "channel": {
      "id": "example",
      "name": "example",
      "parent_url": "example"
    }
  }
}
```

### Get conversation

Read a cast and its reply thread.

**Inputs**

- Identifier type (`identifier_type`, text, required): Choose how to identify the cast. One of: `hash`, `url`.
- Identifier (`identifier`, text, required): Enter the cast hash or its Farcaster URL.
- Reply depth (`reply_depth`, number): Choose how many levels of replies to expand. At least 0.
- Sort type (`sort_type`, text): Choose how to order replies. One of: `chron`, `desc_chron` (Desc chron), `algorithmic`.
- Limit (`limit`, number): Maximum number of entries to return. From 1 to 50.
- Cursor (`cursor`, text): Use the cursor returned by the previous page.

**Outputs**

- `data` (object): The response from Farcaster.

**Example output**

```json
{
  "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_uuid`, text, required): Enter a Neynar signer UUID approved by your Farcaster account.

**Outputs**

- `data` (object): The response from Farcaster.

**Example output**

```json
{
  "data": {
    "signer_uuid": "example",
    "status": "example"
  }
}
```

### Get user by username

Look up a public Farcaster profile and its numeric identifier.

**Inputs**

- Username (`username`, text, required): Enter the Farcaster username.

**Outputs**

- `data` (object): The response from Farcaster.

**Example output**

```json
{
  "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 (`fids`, list, required): Enter the Farcaster IDs.

**Outputs**

- `data` (object): The response from Farcaster.

**Example output**

```json
{
  "data": {
    "users": [
      {
        "display_name": "example",
        "fid": 1,
        "username": "example"
      }
    ]
  }
}
```

### List cast reactions

Read likes and recasts for a public cast.

**Inputs**

- Cast hash (`cast_hash`, text, required): Enter the cast hash.
- Types (`types`, list, required): Choose likes, recasts, or all reactions. One or more of: `all`, `likes`, `recasts`.
- Limit (`limit`, number): Maximum number of entries to return. From 1 to 100.
- Cursor (`cursor`, text): Use the cursor returned by the previous page.

**Outputs**

- `data` (object): The response from Farcaster.

**Example output**

```json
{
  "data": {
    "next": {
      "cursor": "example"
    },
    "reactions": [
      {}
    ]
  }
}
```

### List channel casts

Read recent casts from one or more Farcaster channels.

**Inputs**

- Channel IDS (`channel_ids`, list, required): Enter the IDs of up to ten channels.
- With replies (`with_replies`, true/false): Include replies in the result.
- With recasts (`with_recasts`, true/false): Include recasts in the result.
- Limit (`limit`, number): Maximum number of entries to return. From 1 to 100.
- Cursor (`cursor`, text): Use the cursor returned by the previous page.

**Outputs**

- `data` (object): The response from Farcaster.

**Example output**

```json
{
  "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 (`fid`, number, required): Enter the user's numeric Farcaster ID. At least 1.
- Sort type (`sort_type`, text): Choose how to order followed users. One of: `desc_chron` (Desc chron), `algorithmic`.
- Limit (`limit`, number): Maximum number of entries to return. From 1 to 100.
- Cursor (`cursor`, text): Use the cursor returned by the previous page.

**Outputs**

- `data` (object): The response from Farcaster.

**Example output**

```json
{
  "data": {
    "next": {
      "cursor": "example"
    },
    "users": [
      {
        "user": {
          "display_name": "example",
          "fid": 1,
          "username": "example"
        }
      }
    ]
  }
}
```

### List followers

See which users follow an account.

**Inputs**

- Farcaster ID (`fid`, number, required): Enter the user's numeric Farcaster ID. At least 1.
- Sort type (`sort_type`, text): Choose how to order followers. One of: `desc_chron` (Desc chron), `algorithmic`.
- Limit (`limit`, number): Maximum number of entries to return. From 1 to 100.
- Cursor (`cursor`, text): Use the cursor returned by the previous page.

**Outputs**

- `data` (object): The response from Farcaster.

**Example output**

```json
{
  "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 (`fid`, number, required): Enter the user's numeric Farcaster ID. At least 1.
- Types (`types`, list): Choose which notifications to return. One or more of: `follows`, `recasts`, `likes`, `mentions`, `replies`, `quotes`.
- Limit (`limit`, number): Maximum number of entries to return. From 1 to 25.
- Cursor (`cursor`, text): Use the cursor returned by the previous page.

**Outputs**

- `data` (object): The response from Farcaster.

**Example output**

```json
{
  "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_type`, text, required): Choose how to identify the cast. One of: `hash`, `url`.
- Identifier (`identifier`, text, required): Enter the cast hash or its Farcaster URL.
- Limit (`limit`, number): Maximum number of entries to return. From 1 to 100.
- Cursor (`cursor`, text): Use the cursor returned by the previous page.

**Outputs**

- `data` (object): The response from Farcaster.

**Example output**

```json
{
  "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 (`fid`, number, required): Enter the user's numeric Farcaster ID. At least 1.
- Channel ID (`channel_id`, text): Enter the channel ID, such as farcaster.
- Include replies (`include_replies`, true/false): Include reply casts.
- Limit (`limit`, number): Maximum number of entries to return. From 1 to 150.
- Cursor (`cursor`, text): Use the cursor returned by the previous page.

**Outputs**

- `data` (object): The response from Farcaster.

**Example output**

```json
{
  "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_uuid`, text, required): Enter a Neynar signer UUID approved by your Farcaster account.
- Text (`text`, text, required): Enter the cast or reply text.
- Parent (`parent`, text): Enter a parent cast hash to reply to, or a channel parent URL.
- Channel ID (`channel_id`, text): Choose a destination channel by ID.
- Embed URLS (`embed_urls`, list): Enter up to two URLs to attach.
- Idempotency key (`idempotency_key`, text): Set a distinct key per cast to prevent duplicates on repeated calls.

**Outputs**

- `data` (object): The response from Farcaster.

**Example output**

```json
{
  "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_uuid`, text, required): Enter a Neynar signer UUID approved by your Farcaster account.
- Reaction type (`reaction_type`, text, required): Choose a like or a recast. One of: `like`, `recast`.
- Target (`target`, text, required): Enter the cast hash or target URL.
- Target author fid (`target_author_fid`, number): Enter the Farcaster ID of the cast author, if required for the target. At least 1.

**Outputs**

- `data` (object): The response from Farcaster.

**Example output**

```json
{
  "data": {
    "success": true
  }
}
```

### Search casts

Find public casts matching a query.

**Inputs**

- Query (`query`, text, required): Enter what you want to find.
- Channel ID (`channel_id`, text): Enter the channel ID, such as farcaster.
- Mode (`mode`, text): Choose how the search matches terms. One of: `literal`, `semantic`, `hybrid`.
- Author fid (`author_fid`, number): Limit results to this Farcaster ID. At least 1.
- Limit (`limit`, number): Maximum number of entries to return. From 1 to 100.
- Cursor (`cursor`, text): Use the cursor returned by the previous page.

**Outputs**

- `data` (object): The response from Farcaster.

**Example output**

```json
{
  "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 (`query`, text, required): Enter what you want to find.
- Limit (`limit`, number): Maximum number of entries to return. From 1 to 200.
- Cursor (`cursor`, text): Use the cursor returned by the previous page.

**Outputs**

- `data` (object): The response from Farcaster.

**Example output**

```json
{
  "data": {
    "channels": [
      {
        "id": "example",
        "name": "example",
        "parent_url": "example"
      }
    ],
    "next": {
      "cursor": "example"
    }
  }
}
```

### Search users

Find Farcaster profiles by username.

**Inputs**

- Query (`query`, text, required): Enter what you want to find.
- Limit (`limit`, number): Maximum number of entries to return. From 1 to 10.
- Cursor (`cursor`, text): Use the cursor returned by the previous page.

**Outputs**

- `data` (object): The response from Farcaster.

**Example output**

```json
{
  "data": {
    "result": {
      "next": {
        "cursor": "example"
      },
      "users": [
        {
          "display_name": "example",
          "fid": 1,
          "username": "example"
        }
      ]
    }
  }
}
```
