GET
/
v2
/
farcaster
/
cast
/
conversation
/
Conversation for a cast
curl --request GET \
  --url https://api.neynar.com/v2/farcaster/cast/conversation/ \
  --header 'x-api-key: <api-key>'
{
  "conversation": {
    "cast": {
      "object": "cast",
      "hash": "<string>",
      "parent_hash": "<string>",
      "parent_url": "<string>",
      "root_parent_url": "<string>",
      "parent_author": {
        "fid": 3
      },
      "author": {
        "object": "user",
        "fid": 3,
        "username": "<string>",
        "display_name": "<string>",
        "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "pro": {},
        "pfp_url": "<string>",
        "profile": {},
        "follower_count": 123,
        "following_count": 123,
        "verifications": [
          "<any>"
        ],
        "auth_addresses": [
          "<any>"
        ],
        "verified_addresses": {},
        "verified_accounts": [
          "<any>"
        ],
        "power_badge": true,
        "experimental": {},
        "viewer_context": {},
        "score": 123
      },
      "app": {
        "object": "user_dehydrated",
        "fid": 3,
        "username": "<string>",
        "display_name": "<string>",
        "pfp_url": "<string>",
        "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "score": 123
      },
      "text": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "embeds": [
        {
          "cast_id": {
            "fid": 3,
            "hash": "<string>"
          },
          "cast": {
            "hash": "<string>",
            "parent_hash": "<string>",
            "parent_url": "<string>",
            "root_parent_url": "<string>",
            "parent_author": {},
            "author": {},
            "app": {},
            "text": "<string>",
            "timestamp": "2023-11-07T05:31:56Z",
            "embeds": [
              "<any>"
            ],
            "channel": {}
          }
        }
      ],
      "type": "cast-mention",
      "reactions": {
        "likes": [
          {
            "fid": 3,
            "fname": "<string>"
          }
        ],
        "recasts": [
          {
            "fid": 3,
            "fname": "<string>"
          }
        ],
        "likes_count": 123,
        "recasts_count": 123
      },
      "replies": {
        "count": 123
      },
      "thread_hash": "<string>",
      "mentioned_profiles": [
        {
          "object": "user",
          "fid": 3,
          "username": "<string>",
          "display_name": "<string>",
          "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
          "pro": {},
          "pfp_url": "<string>",
          "profile": {},
          "follower_count": 123,
          "following_count": 123,
          "verifications": [
            "<any>"
          ],
          "auth_addresses": [
            "<any>"
          ],
          "verified_addresses": {},
          "verified_accounts": [
            "<any>"
          ],
          "power_badge": true,
          "experimental": {},
          "viewer_context": {},
          "score": 123
        }
      ],
      "mentioned_profiles_ranges": [
        {
          "start": 1,
          "end": 1
        }
      ],
      "mentioned_channels": [
        {
          "id": "<string>",
          "name": "<string>",
          "object": "channel_dehydrated",
          "image_url": "<string>",
          "viewer_context": {
            "following": "<any>",
            "role": "<any>"
          }
        }
      ],
      "mentioned_channels_ranges": [
        {
          "start": 1,
          "end": 1
        }
      ],
      "channel": {
        "id": "<string>",
        "url": "<string>",
        "name": "<string>",
        "description": "<string>",
        "object": "channel",
        "created_at": "2023-11-07T05:31:56Z",
        "follower_count": 123,
        "external_link": {
          "title": "<string>",
          "url": "<string>"
        },
        "image_url": "<string>",
        "parent_url": "<string>",
        "lead": {
          "object": "user",
          "fid": 3,
          "username": "<string>",
          "display_name": "<string>",
          "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
          "pro": {},
          "pfp_url": "<string>",
          "profile": {},
          "follower_count": 123,
          "following_count": 123,
          "verifications": [
            "<any>"
          ],
          "auth_addresses": [
            "<any>"
          ],
          "verified_addresses": {},
          "verified_accounts": [
            "<any>"
          ],
          "power_badge": true,
          "experimental": {},
          "viewer_context": {},
          "score": 123
        },
        "moderator_fids": [
          3
        ],
        "member_count": 123,
        "moderator": {
          "object": "user",
          "fid": 3,
          "username": "<string>",
          "display_name": "<string>",
          "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
          "pro": {},
          "pfp_url": "<string>",
          "profile": {},
          "follower_count": 123,
          "following_count": 123,
          "verifications": [
            "<any>"
          ],
          "auth_addresses": [
            "<any>"
          ],
          "verified_addresses": {},
          "verified_accounts": [
            "<any>"
          ],
          "power_badge": true,
          "experimental": {},
          "viewer_context": {},
          "score": 123
        },
        "pinned_cast_hash": "0x71d5225f77e0164388b1d4c120825f3a2c1f131c",
        "hosts": [
          {}
        ],
        "viewer_context": {
          "following": "<any>",
          "role": "<any>"
        },
        "description_mentioned_profiles": [
          {}
        ],
        "description_mentioned_profiles_ranges": [
          {}
        ]
      },
      "viewer_context": {
        "liked": true,
        "recasted": true
      },
      "author_channel_context": {
        "following": "<any>",
        "role": "<any>"
      },
      "direct_replies": [
        {
          "object": "cast",
          "hash": "<string>",
          "parent_hash": "<string>",
          "parent_url": "<string>",
          "root_parent_url": "<string>",
          "parent_author": {
            "fid": 3
          },
          "author": {
            "object": "user",
            "fid": 3,
            "username": "<string>",
            "display_name": "<string>",
            "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
            "pro": {},
            "pfp_url": "<string>",
            "profile": {},
            "follower_count": 123,
            "following_count": 123,
            "verifications": [
              "<any>"
            ],
            "auth_addresses": [
              "<any>"
            ],
            "verified_addresses": {},
            "verified_accounts": [
              "<any>"
            ],
            "power_badge": true,
            "experimental": {},
            "viewer_context": {},
            "score": 123
          },
          "app": {
            "object": "<any>",
            "fid": "<any>",
            "username": "<any>",
            "display_name": "<any>",
            "pfp_url": "<any>",
            "custody_address": "<any>",
            "score": "<any>"
          },
          "text": "<string>",
          "timestamp": "2023-11-07T05:31:56Z",
          "embeds": [
            {
              "cast_id": {
                "fid": 3,
                "hash": "<string>"
              },
              "cast": {
                "hash": "<string>",
                "parent_hash": "<string>",
                "parent_url": "<string>",
                "root_parent_url": "<string>",
                "parent_author": {},
                "author": {},
                "app": {},
                "text": "<string>",
                "timestamp": "2023-11-07T05:31:56Z",
                "embeds": [
                  "<any>"
                ],
                "channel": {}
              }
            }
          ],
          "type": "cast-mention",
          "reactions": {
            "likes": [
              {
                "fid": 3,
                "fname": "<string>"
              }
            ],
            "recasts": [
              {
                "fid": 3,
                "fname": "<string>"
              }
            ],
            "likes_count": 123,
            "recasts_count": 123
          },
          "replies": {
            "count": 123
          },
          "thread_hash": "<string>",
          "mentioned_profiles": [
            {
              "object": "user",
              "fid": 3,
              "username": "<string>",
              "display_name": "<string>",
              "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
              "pro": {},
              "pfp_url": "<string>",
              "profile": {},
              "follower_count": 123,
              "following_count": 123,
              "verifications": [
                "<any>"
              ],
              "auth_addresses": [
                "<any>"
              ],
              "verified_addresses": {},
              "verified_accounts": [
                "<any>"
              ],
              "power_badge": true,
              "experimental": {},
              "viewer_context": {},
              "score": 123
            }
          ],
          "mentioned_profiles_ranges": [
            {
              "start": 1,
              "end": 1
            }
          ],
          "mentioned_channels": [
            {
              "id": "<string>",
              "name": "<string>",
              "object": "channel_dehydrated",
              "image_url": "<string>",
              "viewer_context": {
                "following": "<any>",
                "role": "<any>"
              }
            }
          ],
          "mentioned_channels_ranges": [
            {
              "start": 1,
              "end": 1
            }
          ],
          "channel": {
            "id": "<string>",
            "url": "<string>",
            "name": "<string>",
            "description": "<string>",
            "object": "channel",
            "created_at": "2023-11-07T05:31:56Z",
            "follower_count": 123,
            "external_link": {
              "title": "<string>",
              "url": "<string>"
            },
            "image_url": "<string>",
            "parent_url": "<string>",
            "lead": {
              "object": "user",
              "fid": 3,
              "username": "<string>",
              "display_name": "<string>",
              "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
              "pro": {},
              "pfp_url": "<string>",
              "profile": {},
              "follower_count": 123,
              "following_count": 123,
              "verifications": [
                "<any>"
              ],
              "auth_addresses": [
                "<any>"
              ],
              "verified_addresses": {},
              "verified_accounts": [
                "<any>"
              ],
              "power_badge": true,
              "experimental": {},
              "viewer_context": {},
              "score": 123
            },
            "moderator_fids": [
              3
            ],
            "member_count": 123,
            "moderator": {
              "object": "user",
              "fid": 3,
              "username": "<string>",
              "display_name": "<string>",
              "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
              "pro": {},
              "pfp_url": "<string>",
              "profile": {},
              "follower_count": 123,
              "following_count": 123,
              "verifications": [
                "<any>"
              ],
              "auth_addresses": [
                "<any>"
              ],
              "verified_addresses": {},
              "verified_accounts": [
                "<any>"
              ],
              "power_badge": true,
              "experimental": {},
              "viewer_context": {},
              "score": 123
            },
            "pinned_cast_hash": "0x71d5225f77e0164388b1d4c120825f3a2c1f131c",
            "hosts": [
              {}
            ],
            "viewer_context": {
              "following": "<any>",
              "role": "<any>"
            },
            "description_mentioned_profiles": [
              {}
            ],
            "description_mentioned_profiles_ranges": [
              {}
            ]
          },
          "viewer_context": {
            "liked": true,
            "recasted": true
          },
          "author_channel_context": {
            "following": "<any>",
            "role": "<any>"
          },
          "direct_replies": [
            {}
          ]
        }
      ]
    },
    "chronological_parent_casts": [
      {
        "object": "cast",
        "hash": "<string>",
        "parent_hash": "<string>",
        "parent_url": "<string>",
        "root_parent_url": "<string>",
        "parent_author": {
          "fid": 3
        },
        "author": {
          "object": "user",
          "fid": 3,
          "username": "<string>",
          "display_name": "<string>",
          "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
          "pro": {},
          "pfp_url": "<string>",
          "profile": {},
          "follower_count": 123,
          "following_count": 123,
          "verifications": [
            "<any>"
          ],
          "auth_addresses": [
            "<any>"
          ],
          "verified_addresses": {},
          "verified_accounts": [
            "<any>"
          ],
          "power_badge": true,
          "experimental": {},
          "viewer_context": {},
          "score": 123
        },
        "app": {
          "object": "<any>",
          "fid": "<any>",
          "username": "<any>",
          "display_name": "<any>",
          "pfp_url": "<any>",
          "custody_address": "<any>",
          "score": "<any>"
        },
        "text": "<string>",
        "timestamp": "2023-11-07T05:31:56Z",
        "embeds": [
          {
            "cast_id": {
              "fid": 3,
              "hash": "<string>"
            },
            "cast": {
              "hash": "<string>",
              "parent_hash": "<string>",
              "parent_url": "<string>",
              "root_parent_url": "<string>",
              "parent_author": {},
              "author": {},
              "app": {},
              "text": "<string>",
              "timestamp": "2023-11-07T05:31:56Z",
              "embeds": [
                "<any>"
              ],
              "channel": {}
            }
          }
        ],
        "type": "cast-mention",
        "reactions": {
          "likes": [
            {
              "fid": 3,
              "fname": "<string>"
            }
          ],
          "recasts": [
            {
              "fid": 3,
              "fname": "<string>"
            }
          ],
          "likes_count": 123,
          "recasts_count": 123
        },
        "replies": {
          "count": 123
        },
        "thread_hash": "<string>",
        "mentioned_profiles": [
          {
            "object": "user",
            "fid": 3,
            "username": "<string>",
            "display_name": "<string>",
            "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
            "pro": {},
            "pfp_url": "<string>",
            "profile": {},
            "follower_count": 123,
            "following_count": 123,
            "verifications": [
              "<any>"
            ],
            "auth_addresses": [
              "<any>"
            ],
            "verified_addresses": {},
            "verified_accounts": [
              "<any>"
            ],
            "power_badge": true,
            "experimental": {},
            "viewer_context": {},
            "score": 123
          }
        ],
        "mentioned_profiles_ranges": [
          {
            "start": 1,
            "end": 1
          }
        ],
        "mentioned_channels": [
          {
            "id": "<string>",
            "name": "<string>",
            "object": "channel_dehydrated",
            "image_url": "<string>",
            "viewer_context": {
              "following": "<any>",
              "role": "<any>"
            }
          }
        ],
        "mentioned_channels_ranges": [
          {
            "start": 1,
            "end": 1
          }
        ],
        "channel": {
          "id": "<string>",
          "url": "<string>",
          "name": "<string>",
          "description": "<string>",
          "object": "channel",
          "created_at": "2023-11-07T05:31:56Z",
          "follower_count": 123,
          "external_link": {
            "title": "<string>",
            "url": "<string>"
          },
          "image_url": "<string>",
          "parent_url": "<string>",
          "lead": {
            "object": "user",
            "fid": 3,
            "username": "<string>",
            "display_name": "<string>",
            "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
            "pro": {},
            "pfp_url": "<string>",
            "profile": {},
            "follower_count": 123,
            "following_count": 123,
            "verifications": [
              "<any>"
            ],
            "auth_addresses": [
              "<any>"
            ],
            "verified_addresses": {},
            "verified_accounts": [
              "<any>"
            ],
            "power_badge": true,
            "experimental": {},
            "viewer_context": {},
            "score": 123
          },
          "moderator_fids": [
            3
          ],
          "member_count": 123,
          "moderator": {
            "object": "user",
            "fid": 3,
            "username": "<string>",
            "display_name": "<string>",
            "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
            "pro": {},
            "pfp_url": "<string>",
            "profile": {},
            "follower_count": 123,
            "following_count": 123,
            "verifications": [
              "<any>"
            ],
            "auth_addresses": [
              "<any>"
            ],
            "verified_addresses": {},
            "verified_accounts": [
              "<any>"
            ],
            "power_badge": true,
            "experimental": {},
            "viewer_context": {},
            "score": 123
          },
          "pinned_cast_hash": "0x71d5225f77e0164388b1d4c120825f3a2c1f131c",
          "hosts": [
            {}
          ],
          "viewer_context": {
            "following": "<any>",
            "role": "<any>"
          },
          "description_mentioned_profiles": [
            {}
          ],
          "description_mentioned_profiles_ranges": [
            {}
          ]
        },
        "viewer_context": {
          "liked": true,
          "recasted": true
        },
        "author_channel_context": {
          "following": "<any>",
          "role": "<any>"
        }
      }
    ]
  },
  "next": {
    "cursor": "<string>"
  }
}

​
Tutorial on ranking replies: Rank high quality conversations

Authorizations

​
x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Headers

​
x-neynar-experimental
boolean
default:false

Enables experimental features including filtering based on the Neynar score. See docs for more details.

Query Parameters

​
identifier
string
required

Cast identifier (It's either a URL or a hash)

Example:

"https://warpcast.com/rish/0x9288c1"

​
type
enum<string>
required

The query param accepted by the API. Sent along with identifier param. url - Cast identifier is a url hash - Cast identifier is a hash

Available options:
url,
hash
Example:

"url"

​
reply_depth
integer | null
default:2

The depth of replies in the conversation that will be returned (default 2)

Required range: 0 <= x <= 5
​
include_chronological_parent_casts
boolean | null
default:false

Include all parent casts in chronological order

​
viewer_fid
integer

Providing this will return a conversation that respects this user's mutes and blocks and includes viewer_context.

Required range: x >= 1
​
sort_type
enum<string>

Sort type for the ordering of descendants. Default is chron

Available options:
chron,
desc_chron,
algorithmic
Example:

"chron"

​
fold
enum<string>

Show conversation above or below the fold. Lower quality responses are hidden below the fold. Not passing in a value shows the full conversation without any folding.

Available options:
above,
below
​
limit
integer
default:20

Number of results to fetch

Required range: 1 <= x <= 50
Example:

30

​
cursor
string

Pagination cursor.

Response

Success

The response is of type object.