Skip to main content
GET
/
v2
/
farcaster
/
frame
/
catalog
Mini apps 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>",
          "subtitle": "<string>",
          "description": "<string>",
          "screenshot_urls": [
            "<string>"
          ],
          "primary_category": "<string>",
          "tags": [
            "<string>"
          ],
          "hero_image_url": "<string>",
          "tagline": "<string>",
          "og_title": "<string>",
          "og_description": "<string>",
          "og_image_url": "<string>",
          "noindex": true
        },
        "miniapp": {
          "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>",
          "subtitle": "<string>",
          "description": "<string>",
          "screenshot_urls": [
            "<string>"
          ],
          "primary_category": "<string>",
          "tags": [
            "<string>"
          ],
          "hero_image_url": "<string>",
          "tagline": "<string>",
          "og_title": "<string>",
          "og_description": "<string>",
          "og_image_url": "<string>",
          "noindex": true
        }
      },
      "author": {
        "object": "user",
        "fid": 3,
        "username": "<string>",
        "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "profile": {
          "bio": {
            "text": "<string>",
            "mentioned_profiles": [
              {
                "object": "user_dehydrated",
                "fid": 3,
                "username": "<string>",
                "display_name": "<string>",
                "pfp_url": "<string>",
                "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
                "score": 123
              }
            ],
            "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>",
              "country": "<string>",
              "state": "<string>",
              "state_code": "<string>",
              "country_code": "<string>"
            },
            "radius": 1
          },
          "banner": {
            "url": "<string>"
          }
        },
        "follower_count": 123,
        "following_count": 123,
        "verifications": [
          "0x5a927ac639636e534b678e81768ca19e2c6280b7"
        ],
        "auth_addresses": [
          {
            "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
            "app": {
              "object": "user_dehydrated",
              "fid": 3,
              "username": "<string>",
              "display_name": "<string>",
              "pfp_url": "<string>",
              "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
              "score": 123
            }
          }
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0x5a927ac639636e534b678e81768ca19e2c6280b7"
          ],
          "sol_addresses": [
            "<string>"
          ],
          "primary": {
            "eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
            "sol_address": "<string>"
          }
        },
        "verified_accounts": [
          {
            "platform": "x",
            "username": "<string>"
          }
        ],
        "display_name": "<string>",
        "pro": {
          "status": "subscribed",
          "subscribed_at": "2023-11-07T05:31:56Z",
          "expires_at": "2023-11-07T05:31:56Z"
        },
        "pfp_url": "<string>",
        "experimental": {
          "neynar_user_score": 123,
          "deprecation_notice": "<string>"
        },
        "viewer_context": {
          "following": true,
          "followed_by": true,
          "blocking": true,
          "blocked_by": true
        },
        "score": 123
      },
      "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": [
            {
              "url": "<string>",
              "height": "<string>",
              "type": "<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": [
            {
              "url": "<string>",
              "height": "<string>",
              "type": "<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>",
            "html": "<string>",
            "width": 123,
            "height": 123,
            "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
          }
        }
      }
    }
  ],
  "next": {
    "cursor": "<string>"
  }
}

Authorizations

x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Query Parameters

limit
integer<int32>
default:100

Number of results to fetch

Required range: 1 <= x <= 100
Example:

100

cursor
string

Pagination cursor

time_window
enum<string>
default:7d

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
Example:

"7d"

categories
enum<string>[]

Comma separated list of categories to include in the results. Includes all if left blank. Example: categories=games,social OR categories=games&categories=social

Available options:
games,
social,
finance,
utility,
productivity,
health-fitness,
news-media,
music,
shopping,
education,
developer-tools,
entertainment,
art-creativity
Example:
["games", "social"]
networks
enum<string>[]

List of blockchain networks by which to filter results. Mini apps included in the results will specify at least one of the supplied networks or specify none. The list can be provided as comma-separated string or array.

Networks supported by mini apps

Available options:
ethereum,
base,
arbitrum,
arbitrum-sepolia,
base-sepolia,
degen,
gnosis,
optimism,
optimism-sepolia,
polygon,
ethereum-sepolia,
zora,
unichain,
monad-testnet,
celo,
solana
Example:
["ethereum", "base", "solana"]

Response

200 - application/json

Success

frames
FrameV2WithFullAuthor · object[]
required
next
NextCursor · object
required

Returns next cursor