GET
/
v2
/
farcaster
/
cast
/
By hash or URL
curl --request GET \
  --url https://api.neynar.com/v2/farcaster/cast/ \
  --header 'x-api-key: <api-key>'
{
  "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": {
        "status": "subscribed",
        "subscribed_at": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z"
      },
      "pfp_url": "<string>",
      "profile": {
        "bio": {
          "text": "<any>",
          "mentioned_profiles": "<any>",
          "mentioned_profiles_ranges": "<any>",
          "mentioned_channels": "<any>",
          "mentioned_channels_ranges": "<any>"
        },
        "location": {
          "latitude": "<any>",
          "longitude": "<any>",
          "address": "<any>",
          "radius": "<any>"
        },
        "banner": {
          "url": "<any>"
        }
      },
      "follower_count": 123,
      "following_count": 123,
      "verifications": [
        "0x5a927ac639636e534b678e81768ca19e2c6280b7"
      ],
      "auth_addresses": [
        {
          "address": "<any>",
          "app": "<any>"
        }
      ],
      "verified_addresses": {
        "eth_addresses": [
          "<any>"
        ],
        "sol_addresses": [
          "<any>"
        ],
        "primary": {
          "eth_address": "<any>",
          "sol_address": "<any>"
        }
      },
      "verified_accounts": [
        {
          "platform": "<any>",
          "username": "<any>"
        }
      ],
      "power_badge": true,
      "experimental": {
        "deprecation_notice": "<string>",
        "neynar_user_score": 123
      },
      "viewer_context": {
        "following": true,
        "followed_by": true,
        "blocking": true,
        "blocked_by": true
      },
      "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": {
            "fid": 3
          },
          "author": {
            "object": "<any>",
            "fid": "<any>",
            "username": "<any>",
            "display_name": "<any>",
            "pfp_url": "<any>",
            "custody_address": "<any>",
            "score": "<any>"
          },
          "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": "<any>",
                "hash": "<any>"
              },
              "cast": {
                "object": "cast_dehydrated",
                "hash": "<string>",
                "author": {
                  "object": "<any>",
                  "fid": "<any>",
                  "username": "<any>",
                  "display_name": "<any>",
                  "pfp_url": "<any>",
                  "custody_address": "<any>",
                  "score": "<any>"
                },
                "app": {}
              }
            }
          ],
          "channel": {
            "id": "<string>",
            "name": "<string>",
            "object": "channel_dehydrated",
            "image_url": "<string>",
            "viewer_context": {
              "following": true,
              "role": "member"
            }
          }
        }
      }
    ],
    "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": {
          "status": "subscribed",
          "subscribed_at": "2023-11-07T05:31:56Z",
          "expires_at": "2023-11-07T05:31:56Z"
        },
        "pfp_url": "<string>",
        "profile": {
          "bio": {
            "text": "<any>",
            "mentioned_profiles": "<any>",
            "mentioned_profiles_ranges": "<any>",
            "mentioned_channels": "<any>",
            "mentioned_channels_ranges": "<any>"
          },
          "location": {
            "latitude": "<any>",
            "longitude": "<any>",
            "address": "<any>",
            "radius": "<any>"
          },
          "banner": {
            "url": "<any>"
          }
        },
        "follower_count": 123,
        "following_count": 123,
        "verifications": [
          "0x5a927ac639636e534b678e81768ca19e2c6280b7"
        ],
        "auth_addresses": [
          {
            "address": "<any>",
            "app": "<any>"
          }
        ],
        "verified_addresses": {
          "eth_addresses": [
            "<any>"
          ],
          "sol_addresses": [
            "<any>"
          ],
          "primary": {
            "eth_address": "<any>",
            "sol_address": "<any>"
          }
        },
        "verified_accounts": [
          {
            "platform": "<any>",
            "username": "<any>"
          }
        ],
        "power_badge": true,
        "experimental": {
          "deprecation_notice": "<string>",
          "neynar_user_score": 123
        },
        "viewer_context": {
          "following": true,
          "followed_by": true,
          "blocking": true,
          "blocked_by": true
        },
        "score": 123
      }
    ],
    "mentioned_profiles_ranges": [
      {
        "start": 1,
        "end": 1
      }
    ],
    "mentioned_channels": [
      {
        "id": "<string>",
        "name": "<string>",
        "object": "channel_dehydrated",
        "image_url": "<string>",
        "viewer_context": {
          "following": true,
          "role": "member"
        }
      }
    ],
    "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": {
          "status": "subscribed",
          "subscribed_at": "2023-11-07T05:31:56Z",
          "expires_at": "2023-11-07T05:31:56Z"
        },
        "pfp_url": "<string>",
        "profile": {
          "bio": {
            "text": "<any>",
            "mentioned_profiles": "<any>",
            "mentioned_profiles_ranges": "<any>",
            "mentioned_channels": "<any>",
            "mentioned_channels_ranges": "<any>"
          },
          "location": {
            "latitude": "<any>",
            "longitude": "<any>",
            "address": "<any>",
            "radius": "<any>"
          },
          "banner": {
            "url": "<any>"
          }
        },
        "follower_count": 123,
        "following_count": 123,
        "verifications": [
          "0x5a927ac639636e534b678e81768ca19e2c6280b7"
        ],
        "auth_addresses": [
          {
            "address": "<any>",
            "app": "<any>"
          }
        ],
        "verified_addresses": {
          "eth_addresses": [
            "<any>"
          ],
          "sol_addresses": [
            "<any>"
          ],
          "primary": {
            "eth_address": "<any>",
            "sol_address": "<any>"
          }
        },
        "verified_accounts": [
          {
            "platform": "<any>",
            "username": "<any>"
          }
        ],
        "power_badge": true,
        "experimental": {
          "deprecation_notice": "<string>",
          "neynar_user_score": 123
        },
        "viewer_context": {
          "following": true,
          "followed_by": true,
          "blocking": true,
          "blocked_by": true
        },
        "score": 123
      },
      "moderator_fids": [
        3
      ],
      "member_count": 123,
      "moderator": {
        "object": "user",
        "fid": 3,
        "username": "<string>",
        "display_name": "<string>",
        "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "pro": {
          "status": "subscribed",
          "subscribed_at": "2023-11-07T05:31:56Z",
          "expires_at": "2023-11-07T05:31:56Z"
        },
        "pfp_url": "<string>",
        "profile": {
          "bio": {
            "text": "<any>",
            "mentioned_profiles": "<any>",
            "mentioned_profiles_ranges": "<any>",
            "mentioned_channels": "<any>",
            "mentioned_channels_ranges": "<any>"
          },
          "location": {
            "latitude": "<any>",
            "longitude": "<any>",
            "address": "<any>",
            "radius": "<any>"
          },
          "banner": {
            "url": "<any>"
          }
        },
        "follower_count": 123,
        "following_count": 123,
        "verifications": [
          "0x5a927ac639636e534b678e81768ca19e2c6280b7"
        ],
        "auth_addresses": [
          {
            "address": "<any>",
            "app": "<any>"
          }
        ],
        "verified_addresses": {
          "eth_addresses": [
            "<any>"
          ],
          "sol_addresses": [
            "<any>"
          ],
          "primary": {
            "eth_address": "<any>",
            "sol_address": "<any>"
          }
        },
        "verified_accounts": [
          {
            "platform": "<any>",
            "username": "<any>"
          }
        ],
        "power_badge": true,
        "experimental": {
          "deprecation_notice": "<string>",
          "neynar_user_score": 123
        },
        "viewer_context": {
          "following": true,
          "followed_by": true,
          "blocking": true,
          "blocked_by": true
        },
        "score": 123
      },
      "pinned_cast_hash": "0x71d5225f77e0164388b1d4c120825f3a2c1f131c",
      "hosts": [
        {
          "object": "user",
          "fid": 3,
          "username": "<string>",
          "display_name": "<string>",
          "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
          "pro": {
            "status": "subscribed",
            "subscribed_at": "2023-11-07T05:31:56Z",
            "expires_at": "2023-11-07T05:31:56Z"
          },
          "pfp_url": "<string>",
          "profile": {
            "bio": {
              "text": "<any>",
              "mentioned_profiles": "<any>",
              "mentioned_profiles_ranges": "<any>",
              "mentioned_channels": "<any>",
              "mentioned_channels_ranges": "<any>"
            },
            "location": {
              "latitude": "<any>",
              "longitude": "<any>",
              "address": "<any>",
              "radius": "<any>"
            },
            "banner": {
              "url": "<any>"
            }
          },
          "follower_count": 123,
          "following_count": 123,
          "verifications": [
            "0x5a927ac639636e534b678e81768ca19e2c6280b7"
          ],
          "auth_addresses": [
            {
              "address": "<any>",
              "app": "<any>"
            }
          ],
          "verified_addresses": {
            "eth_addresses": [
              "<any>"
            ],
            "sol_addresses": [
              "<any>"
            ],
            "primary": {
              "eth_address": "<any>",
              "sol_address": "<any>"
            }
          },
          "verified_accounts": [
            {
              "platform": "<any>",
              "username": "<any>"
            }
          ],
          "power_badge": true,
          "experimental": {
            "deprecation_notice": "<string>",
            "neynar_user_score": 123
          },
          "viewer_context": {
            "following": true,
            "followed_by": true,
            "blocking": true,
            "blocked_by": true
          },
          "score": 123
        }
      ],
      "viewer_context": {
        "following": true,
        "role": "member"
      },
      "description_mentioned_profiles": [
        {
          "object": "<any>",
          "fid": "<any>",
          "username": "<any>",
          "display_name": "<any>",
          "pfp_url": "<any>",
          "custody_address": "<any>",
          "score": "<any>"
        }
      ],
      "description_mentioned_profiles_ranges": [
        {
          "start": 1,
          "end": 1
        }
      ]
    },
    "viewer_context": {
      "liked": true,
      "recasted": true
    },
    "author_channel_context": {
      "following": true,
      "role": "member"
    }
  }
}

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://farcaster.xyz/rish/0xafa59bb7"

​
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"

​
viewer_fid
integer

adds viewer_context to cast object to show whether viewer has liked or recasted the cast.

Required range: x >= 1

Response

Success

The response is of type object.