GET
/
v2
/
farcaster
/
frame
/
relevant
/
Relevant mini apps
curl --request GET \
  --url https://api.neynar.com/v2/farcaster/frame/relevant/ \
  --header 'x-api-key: <api-key>'
{
  "relevant_frames": [
    {
      "frame": {
        "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>",
          "display_name": "<string>",
          "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
          "pro": {
            "status": "subscribed",
            "subscribed_at": "2023-11-07T05:31:56Z",
            "expires_at": "2023-11-07T05:31:56Z"
          },
          "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>"
              },
              "radius": 1
            },
            "banner": {
              "url": "<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
          },
          "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": [
              {
                "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
            }
          }
        }
      },
      "top_relevant_users": [
        {
          "object": "user",
          "fid": 3,
          "username": "<string>",
          "display_name": "<string>",
          "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
          "pro": {
            "status": "subscribed",
            "subscribed_at": "2023-11-07T05:31:56Z",
            "expires_at": "2023-11-07T05:31:56Z"
          },
          "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>"
              },
              "radius": 1
            },
            "banner": {
              "url": "<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
          },
          "viewer_context": {
            "following": true,
            "followed_by": true,
            "blocking": true,
            "blocked_by": true
          },
          "score": 123
        }
      ],
      "remaining_relevant_users": [
        {
          "object": "user_dehydrated",
          "fid": 3,
          "username": "<string>",
          "display_name": "<string>",
          "pfp_url": "<string>",
          "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
        }
      ]
    }
  ]
}

Authorizations

x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Query Parameters

viewer_fid
integer
required

FID of the user to fetch relevant mini apps for

Required range: x >= 1
time_window
enum<string>
default:7d

Time window used to limit statistics used to calculate mini app relevance

Available options:
1h,
6h,
12h,
24h,
7d
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.

Example:
["ethereum", "base", "solana"]

Response

200 - application/json

Success

The response is of type object.