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

The mini app URL to crawl

Response

200
application/json

The response object containing the mini app object

The mini app object containing the meta tags