GET
/
farcaster
/
cast
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",
      "pfp_url": "<string>",
      "profile": {
        "bio": {
          "text": "<string>",
          "mentioned_profiles": [
            {
              "object": "user_dehydrated",
              "fid": 3,
              "username": "<string>",
              "display_name": "<string>",
              "pfp_url": "<string>",
              "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
            }
          ],
          "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
            }
          ]
        },
        "location": {
          "latitude": 0,
          "longitude": 0,
          "radius": 1,
          "address": {
            "city": "<string>",
            "state": "<string>",
            "state_code": "<string>",
            "country": "<string>",
            "country_code": "<string>"
          }
        }
      },
      "follower_count": 123,
      "following_count": 123,
      "verifications": [
        "0x5a927ac639636e534b678e81768ca19e2c6280b7"
      ],
      "verified_addresses": {
        "eth_addresses": [
          "0x5a927ac639636e534b678e81768ca19e2c6280b7"
        ],
        "sol_addresses": [
          "<string>"
        ],
        "primary": {
          "eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
          "sol_address": "<string>"
        }
      },
      "verified_accounts": [
        {
          "platform": "x",
          "username": "<string>"
        }
      ],
      "power_badge": true,
      "experimental": {
        "deprecation_notice": "<string>",
        "neynar_user_score": 123
      },
      "score": 123,
      "viewer_context": {
        "following": true,
        "followed_by": true,
        "blocking": true,
        "blocked_by": true
      }
    },
    "app": {
      "object": "user_dehydrated",
      "fid": 3,
      "username": "<string>",
      "display_name": "<string>",
      "pfp_url": "<string>",
      "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
    },
    "text": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "embeds": [
      {
        "url": "<string>",
        "metadata": {
          "_status": "<string>",
          "content_type": "<string>",
          "content_length": 123,
          "image": {
            "height_px": 123,
            "width_px": 123
          },
          "video": {
            "duration_s": 123,
            "stream": [
              {
                "codec_name": "<string>",
                "height_px": 123,
                "width_px": 123
              }
            ]
          },
          "html": {
            "favicon": "<string>",
            "modifiedTime": "<string>",
            "ogArticleAuthor": "<string>",
            "ogArticleExpirationTime": "<string>",
            "ogArticleModifiedTime": "<string>",
            "ogArticlePublishedTime": "<string>",
            "ogArticlePublisher": "<string>",
            "ogArticleSection": "<string>",
            "ogArticleTag": "<string>",
            "ogAudio": "<string>",
            "ogAudioSecureURL": "<string>",
            "ogAudioType": "<string>",
            "ogAudioURL": "<string>",
            "ogAvailability": "<string>",
            "ogDate": "<string>",
            "ogDescription": "<string>",
            "ogDeterminer": "<string>",
            "ogEpisode": "<string>",
            "ogImage": [
              {
                "height": "<string>",
                "type": "<string>",
                "url": "<string>",
                "width": "<string>",
                "alt": "<string>"
              }
            ],
            "ogLocale": "<string>",
            "ogLocaleAlternate": "<string>",
            "ogLogo": "<string>",
            "ogMovie": "<string>",
            "ogPriceAmount": "<string>",
            "ogPriceCurrency": "<string>",
            "ogProductAvailability": "<string>",
            "ogProductCondition": "<string>",
            "ogProductPriceAmount": "<string>",
            "ogProductPriceCurrency": "<string>",
            "ogProductRetailerItemId": "<string>",
            "ogSiteName": "<string>",
            "ogTitle": "<string>",
            "ogType": "<string>",
            "ogUrl": "<string>",
            "ogVideo": [
              {
                "height": "<string>",
                "type": "<string>",
                "url": "<string>",
                "width": "<string>"
              }
            ],
            "ogVideoActor": "<string>",
            "ogVideoActorId": "<string>",
            "ogVideoActorRole": "<string>",
            "ogVideoDirector": "<string>",
            "ogVideoDuration": "<string>",
            "ogVideoOther": "<string>",
            "ogVideoReleaseDate": "<string>",
            "ogVideoSecureURL": "<string>",
            "ogVideoSeries": "<string>",
            "ogVideoTag": "<string>",
            "ogVideoTvShow": "<string>",
            "ogVideoWriter": "<string>",
            "ogWebsite": "<string>",
            "updatedTime": "<string>",
            "oembed": {
              "type": "rich",
              "version": "<string>",
              "title": "<string>",
              "author_name": "<string>",
              "author_url": "<string>",
              "provider_name": "<string>",
              "provider_url": "<string>",
              "cache_age": "<string>",
              "thumbnail_url": "<string>",
              "thumbnail_width": 123,
              "thumbnail_height": 123,
              "html": "<string>",
              "width": 123,
              "height": 123
            }
          },
          "frame": {
            "version": "<string>",
            "image": "<string>",
            "frames_url": "<string>",
            "buttons": [
              {
                "title": "<string>",
                "index": 123,
                "action_type": "post",
                "target": "<string>",
                "post_url": "<string>"
              }
            ],
            "post_url": "<string>",
            "title": "<string>",
            "image_aspect_ratio": "<string>",
            "input": {
              "text": "<string>"
            },
            "state": {
              "serialized": "<string>"
            }
          }
        }
      }
    ],
    "type": "cast-mention",
    "frames": [
      {
        "version": "<string>",
        "image": "<string>",
        "frames_url": "<string>",
        "buttons": [
          {
            "title": "<string>",
            "index": 123,
            "action_type": "post",
            "target": "<string>",
            "post_url": "<string>"
          }
        ],
        "post_url": "<string>",
        "title": "<string>",
        "image_aspect_ratio": "<string>",
        "input": {
          "text": "<string>"
        },
        "state": {
          "serialized": "<string>"
        }
      }
    ],
    "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",
        "pfp_url": "<string>",
        "profile": {
          "bio": {
            "text": "<string>",
            "mentioned_profiles": [
              {
                "object": "user_dehydrated",
                "fid": 3,
                "username": "<string>",
                "display_name": "<string>",
                "pfp_url": "<string>",
                "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
              }
            ],
            "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
              }
            ]
          },
          "location": {
            "latitude": 0,
            "longitude": 0,
            "radius": 1,
            "address": {
              "city": "<string>",
              "state": "<string>",
              "state_code": "<string>",
              "country": "<string>",
              "country_code": "<string>"
            }
          }
        },
        "follower_count": 123,
        "following_count": 123,
        "verifications": [
          "0x5a927ac639636e534b678e81768ca19e2c6280b7"
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0x5a927ac639636e534b678e81768ca19e2c6280b7"
          ],
          "sol_addresses": [
            "<string>"
          ],
          "primary": {
            "eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
            "sol_address": "<string>"
          }
        },
        "verified_accounts": [
          {
            "platform": "x",
            "username": "<string>"
          }
        ],
        "power_badge": true,
        "experimental": {
          "deprecation_notice": "<string>",
          "neynar_user_score": 123
        },
        "score": 123,
        "viewer_context": {
          "following": true,
          "followed_by": true,
          "blocking": true,
          "blocked_by": true
        }
      }
    ],
    "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>",
      "object": "channel",
      "name": "<string>",
      "description": "<string>",
      "description_mentioned_profiles": [
        {
          "object": "user_dehydrated",
          "fid": 3,
          "username": "<string>",
          "display_name": "<string>",
          "pfp_url": "<string>",
          "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
        }
      ],
      "description_mentioned_profiles_ranges": [
        {
          "start": 1,
          "end": 1
        }
      ],
      "created_at": 123,
      "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",
        "pfp_url": "<string>",
        "profile": {
          "bio": {
            "text": "<string>",
            "mentioned_profiles": [
              {
                "object": "user_dehydrated",
                "fid": 3,
                "username": "<string>",
                "display_name": "<string>",
                "pfp_url": "<string>",
                "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
              }
            ],
            "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
              }
            ]
          },
          "location": {
            "latitude": 0,
            "longitude": 0,
            "radius": 1,
            "address": {
              "city": "<string>",
              "state": "<string>",
              "state_code": "<string>",
              "country": "<string>",
              "country_code": "<string>"
            }
          }
        },
        "follower_count": 123,
        "following_count": 123,
        "verifications": [
          "0x5a927ac639636e534b678e81768ca19e2c6280b7"
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0x5a927ac639636e534b678e81768ca19e2c6280b7"
          ],
          "sol_addresses": [
            "<string>"
          ],
          "primary": {
            "eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
            "sol_address": "<string>"
          }
        },
        "verified_accounts": [
          {
            "platform": "x",
            "username": "<string>"
          }
        ],
        "power_badge": true,
        "experimental": {
          "deprecation_notice": "<string>",
          "neynar_user_score": 123
        },
        "score": 123,
        "viewer_context": {
          "following": true,
          "followed_by": true,
          "blocking": true,
          "blocked_by": true
        }
      },
      "moderator_fids": [
        3
      ],
      "member_count": 123,
      "moderator": {
        "object": "user",
        "fid": 3,
        "username": "<string>",
        "display_name": "<string>",
        "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "pfp_url": "<string>",
        "profile": {
          "bio": {
            "text": "<string>",
            "mentioned_profiles": [
              {
                "object": "user_dehydrated",
                "fid": 3,
                "username": "<string>",
                "display_name": "<string>",
                "pfp_url": "<string>",
                "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
              }
            ],
            "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
              }
            ]
          },
          "location": {
            "latitude": 0,
            "longitude": 0,
            "radius": 1,
            "address": {
              "city": "<string>",
              "state": "<string>",
              "state_code": "<string>",
              "country": "<string>",
              "country_code": "<string>"
            }
          }
        },
        "follower_count": 123,
        "following_count": 123,
        "verifications": [
          "0x5a927ac639636e534b678e81768ca19e2c6280b7"
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0x5a927ac639636e534b678e81768ca19e2c6280b7"
          ],
          "sol_addresses": [
            "<string>"
          ],
          "primary": {
            "eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
            "sol_address": "<string>"
          }
        },
        "verified_accounts": [
          {
            "platform": "x",
            "username": "<string>"
          }
        ],
        "power_badge": true,
        "experimental": {
          "deprecation_notice": "<string>",
          "neynar_user_score": 123
        },
        "score": 123,
        "viewer_context": {
          "following": true,
          "followed_by": true,
          "blocking": true,
          "blocked_by": true
        }
      },
      "pinned_cast_hash": "0xfe90f9de682273e05b201629ad2338bdcd89b6be",
      "hosts": [
        {
          "object": "user",
          "fid": 3,
          "username": "<string>",
          "display_name": "<string>",
          "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
          "pfp_url": "<string>",
          "profile": {
            "bio": {
              "text": "<string>",
              "mentioned_profiles": [
                {
                  "object": "user_dehydrated",
                  "fid": 3,
                  "username": "<string>",
                  "display_name": "<string>",
                  "pfp_url": "<string>",
                  "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
                }
              ],
              "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
                }
              ]
            },
            "location": {
              "latitude": 0,
              "longitude": 0,
              "radius": 1,
              "address": {
                "city": "<string>",
                "state": "<string>",
                "state_code": "<string>",
                "country": "<string>",
                "country_code": "<string>"
              }
            }
          },
          "follower_count": 123,
          "following_count": 123,
          "verifications": [
            "0x5a927ac639636e534b678e81768ca19e2c6280b7"
          ],
          "verified_addresses": {
            "eth_addresses": [
              "0x5a927ac639636e534b678e81768ca19e2c6280b7"
            ],
            "sol_addresses": [
              "<string>"
            ],
            "primary": {
              "eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
              "sol_address": "<string>"
            }
          },
          "verified_accounts": [
            {
              "platform": "x",
              "username": "<string>"
            }
          ],
          "power_badge": true,
          "experimental": {
            "deprecation_notice": "<string>",
            "neynar_user_score": 123
          },
          "score": 123,
          "viewer_context": {
            "following": true,
            "followed_by": true,
            "blocking": true,
            "blocked_by": true
          }
        }
      ],
      "viewer_context": {
        "following": true,
        "role": "member"
      }
    },
    "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 (Its either a url or a hash)

​
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
​
viewer_fid
integer

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

Example:

3

Response

200
application/json

Successful operation.

The response is of type object.