GET
/
farcaster
/
cast
/
embed
/
crawl
curl --request GET \
  --url https://api.neynar.com/v2/farcaster/cast/embed/crawl \
  --header 'x-api-key: <api-key>'
{
  "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>"
      }
    }
  }
}

Authorizations

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

API key to authorize requests

Query Parameters

​
url
string
required

URL to crawl metadata of

Response

200
application/json

Successful operation.

The response is of type object.