GET
/
farcaster
/
frame
/
catalog
curl --request GET \
  --url https://api.neynar.com/v2/farcaster/frame/catalog \
  --header 'x-api-key: <api-key>'
{
  "frames": [
    {
      "version": "<string>",
      "image": "<string>",
      "frames_url": "<string>",
      "title": "<string>",
      "manifest": {
        "account_association": {
          "header": "<string>",
          "payload": "<string>",
          "signature": "<string>"
        },
        "frame": {
          "version": "0.0.0",
          "name": "<string>",
          "home_url": "<string>",
          "icon_url": "<string>",
          "image_url": "<string>",
          "button_title": "<string>",
          "splash_image_url": "<string>",
          "splash_background_color": "<string>",
          "webhook_url": "<string>"
        },
        "triggers": [
          {
            "type": "cast",
            "id": "<string>",
            "url": "<string>",
            "name": "<string>"
          }
        ]
      },
      "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,
            "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
        }
      },
      "metadata": {
        "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
          }
        }
      }
    }
  ],
  "next": {
    "cursor": "<string>"
  }
}

Authorizations

x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Query Parameters

limit
integer
default:100

Number of results to fetch

Required range: x <= 100
cursor
string

Pagination cursor

time_window
enum<string>
default:24h

Time window used to calculate the change in trending score for each mini app, used to sort mini app results

Available options:
1h,
6h,
12h,
24h,
7d

Response

200 - application/json
Successful response

The response is of type object.