---
title: "Embedded URL metadata"
method: GET
path: "/v2/farcaster/cast/embed/crawl/"
tags: ["Cast"]
---

# Embedded URL metadata

`GET /v2/farcaster/cast/embed/crawl/`

Crawls the given URL and returns metadata useful when embedding the URL in a cast.

## Query parameters

- `url` string, required

## Response `200`

Success

- CastEmbedCrawlResponse
  - `metadata` EmbedUrlMetadata, required
    - `_status` string, required
    - `content_length` integer, nullable
    - `content_type` string, nullable
    - `frame` union
      - FrameV1 — Mini app v1 object
        - `buttons` FrameActionButton[]
          - `action_type` 'post' | 'post_redirect' | 'tx' | 'link' | 'mint', required — The action type of a mini app button. Action types "mint" & "link" are to be handled on the client side only and so they will produce a no/op for POST /farcaster/frame/action.
          - `index` integer, required — Index of the button
          - `post_url` string — Used specifically for the tx action type to post a successful transaction hash
          - `target` string — Target of the button
          - `title` string — Title of the button
        - `frames_url` string, required — Launch URL of the mini app
        - `image` string, required — URL of the image
        - `image_aspect_ratio` string
        - `input` object
          - `text` string — Input text for the mini app
        - `post_url` string — Post URL to take an action on this mini app
        - `state` object
          - `serialized` string — State for the mini app in a serialized format
        - `title` string
        - `version` string, required — Version of the mini app, 'next' for v2, 'vNext' for v1
      - FrameV2 — Mini app v2 object
        - `author` UserDehydrated
          - `custody_address` string — Ethereum address
          - `display_name` string, nullable
          - `fid` integer, required — The unique identifier of a farcaster user or app (unsigned integer)
          - `object` 'user_dehydrated', required
          - `pfp_url` string, nullable
          - `score` number
          - `username` string
        - `frames_url` string, required — Launch URL of the mini app
        - `image` string, required — URL of the image
        - `manifest` FarcasterManifest
          - `account_association` EncodedJsonFarcasterSignature, required — Encoded JSON Farcaster signature
            - `header` string, required
            - `payload` string, required
            - `signature` string, required
          - `frame` object
            - `button_title` string
            - `description` string — Detailed description of the configuration
            - `hero_image_url` string, uri — URL of the hero image displayed for the configuration
            - `home_url` string, required
            - `icon_url` string, required
            - `image_url` string
            - `name` string, required
            - `noindex` boolean — Whether search engines should not index this configuration
            - `og_description` string — Description used for Open Graph previews
            - `og_image_url` string, uri — Image URL used for Open Graph previews
            - `og_title` string — Title used for Open Graph previews
            - `primary_category` string — Primary category the configuration belongs to
            - `screenshot_urls` string[] — URLs of screenshots showcasing the configuration
            - `splash_background_color` string
            - `splash_image_url` string
            - `subtitle` string — Short subtitle for the configuration
            - `tagline` string — Short tagline for the configuration
            - `tags` string[] — Tags associated with the configuration
            - `version` '1' | '0.0.0' | '0.0.1' | 'next', required
            - `webhook_url` string
          - `miniapp` object
            - `button_title` string
            - `description` string — Detailed description of the configuration
            - `hero_image_url` string, uri — URL of the hero image displayed for the configuration
            - `home_url` string, required
            - `icon_url` string, required
            - `image_url` string
            - `name` string, required
            - `noindex` boolean — Whether search engines should not index this configuration
            - `og_description` string — Description used for Open Graph previews
            - `og_image_url` string, uri — Image URL used for Open Graph previews
            - `og_title` string — Title used for Open Graph previews
            - `primary_category` string — Primary category the configuration belongs to
            - `screenshot_urls` string[] — URLs of screenshots showcasing the configuration
            - `splash_background_color` string
            - `splash_image_url` string
            - `subtitle` string — Short subtitle for the configuration
            - `tagline` string — Short tagline for the configuration
            - `tags` string[] — Tags associated with the configuration
            - `version` '1' | '0.0.0' | '0.0.1' | 'next', required
            - `webhook_url` string
        - `metadata` object
          - `html` HtmlMetadata, required
            - `favicon` string
            - `modifiedTime` string
            - `oembed` union
              - …
            - `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` ImageObject[]
              - …
            - `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` VideoObject[]
              - …
            - `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
        - `title` string — Button title of a mini app
        - `version` string, required — Version of the mini app, 'next' for v2, 'vNext' for v1
    - `html` HtmlMetadata
      - `favicon` string
      - `modifiedTime` string
      - `oembed` union
        - object — Rich OEmbed data
          - `author_name` string, nullable — The name of the author/owner of the resource.
          - `author_url` string, nullable — A URL for the author/owner of the resource.
          - `cache_age` string, nullable — The suggested cache lifetime for this resource, in seconds. Consumers may choose to use this value or not.
          - `height` number, nullable — The height in pixels required to display the HTML.
          - `html` string, nullable, required — The HTML required to display the resource. The HTML should have no padding or margins. Consumers may wish to load the HTML in an off-domain iframe to avoid XSS vulnerabilities. The markup should be valid XHTML 1.0 Basic.
          - `provider_name` string, nullable — The name of the resource provider.
          - `provider_url` string, nullable — The url of the resource provider.
          - `thumbnail_height` number, nullable — The height of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_width must also be present.
          - `thumbnail_url` string, nullable — A URL to a thumbnail image representing the resource. The thumbnail must respect any maxwidth and maxheight parameters. If this parameter is present, thumbnail_width and thumbnail_height must also be present.
          - `thumbnail_width` number, nullable — The width of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_height must also be present.
          - `title` string, nullable — A text title, describing the resource.
          - `type` 'rich', required
          - `version` string, nullable, required
          - `width` number, nullable — The width in pixels required to display the HTML.
        - object — Video OEmbed data
          - `author_name` string, nullable — The name of the author/owner of the resource.
          - `author_url` string, nullable — A URL for the author/owner of the resource.
          - `cache_age` string, nullable — The suggested cache lifetime for this resource, in seconds. Consumers may choose to use this value or not.
          - `height` number, nullable — The height in pixels required to display the HTML.
          - `html` string, nullable, required — The HTML required to embed a video player. The HTML should have no padding or margins. Consumers may wish to load the HTML in an off-domain iframe to avoid XSS vulnerabilities.
          - `provider_name` string, nullable — The name of the resource provider.
          - `provider_url` string, nullable — The url of the resource provider.
          - `thumbnail_height` number, nullable — The height of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_width must also be present.
          - `thumbnail_url` string, nullable — A URL to a thumbnail image representing the resource. The thumbnail must respect any maxwidth and maxheight parameters. If this parameter is present, thumbnail_width and thumbnail_height must also be present.
          - `thumbnail_width` number, nullable — The width of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_height must also be present.
          - `title` string, nullable — A text title, describing the resource.
          - `type` 'video', required
          - `version` string, nullable, required
          - `width` number, nullable — The width in pixels required to display the HTML.
        - object — Photo OEmbed data
          - `author_name` string, nullable — The name of the author/owner of the resource.
          - `author_url` string, nullable — A URL for the author/owner of the resource.
          - `cache_age` string, nullable — The suggested cache lifetime for this resource, in seconds. Consumers may choose to use this value or not.
          - `height` number, nullable — The height in pixels of the image specified in the url parameter.
          - `provider_name` string, nullable — The name of the resource provider.
          - `provider_url` string, nullable — The url of the resource provider.
          - `thumbnail_height` number, nullable — The height of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_width must also be present.
          - `thumbnail_url` string, nullable — A URL to a thumbnail image representing the resource. The thumbnail must respect any maxwidth and maxheight parameters. If this parameter is present, thumbnail_width and thumbnail_height must also be present.
          - `thumbnail_width` number, nullable — The width of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_height must also be present.
          - `title` string, nullable — A text title, describing the resource.
          - `type` 'photo', required
          - `url` string, nullable, required — The source URL of the image. Consumers should be able to insert this URL into an <img> element. Only HTTP and HTTPS URLs are valid.
          - `version` string, nullable, required
          - `width` number, nullable — The width in pixels of the image specified in the url parameter.
        - object — Link OEmbed data
          - `author_name` string, nullable — The name of the author/owner of the resource.
          - `author_url` string, nullable — A URL for the author/owner of the resource.
          - `cache_age` string, nullable — The suggested cache lifetime for this resource, in seconds. Consumers may choose to use this value or not.
          - `provider_name` string, nullable — The name of the resource provider.
          - `provider_url` string, nullable — The url of the resource provider.
          - `thumbnail_height` number, nullable — The height of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_width must also be present.
          - `thumbnail_url` string, nullable — A URL to a thumbnail image representing the resource. The thumbnail must respect any maxwidth and maxheight parameters. If this parameter is present, thumbnail_width and thumbnail_height must also be present.
          - `thumbnail_width` number, nullable — The width of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_height must also be present.
          - `title` string, nullable — A text title, describing the resource.
          - `type` 'link', required
          - `version` string, nullable, required
      - `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` ImageObject[]
        - `alt` string
        - `height` string
        - `type` string
        - `url` string, required
        - `width` 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` VideoObject[]
        - `height` string
        - `type` string
        - `url` string, required
        - `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
    - `image` object
      - `height_px` integer
      - `width_px` integer
    - `video` object
      - `duration_s` number
      - `stream` object[]
        - `codec_name` string
        - `height_px` integer
        - `width_px` integer

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.dev/neynar/apis/neynar-api.md) · [All operations](https://skmtc.dev/neynar/apis/neynar-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/neynar/neynar-api/revisions/dbb91bfb0d1a/schema)