---
title: "Relevant mini apps"
method: GET
path: "/v2/farcaster/frame/relevant/"
tags: ["Frame"]
---

# Relevant mini apps

`GET /v2/farcaster/frame/relevant/`

Fetch a list of mini apps relevant to the user based on casts by users with strong affinity score for the user

## Query parameters

- `viewer_fid` integer, required
- `time_window` '1h' | '6h' | '12h' | '24h' | '7d'
- `networks` string[]

## Response `200`

Success

- object
  - `relevant_frames` object[], required
    - `frame` object, required — FrameV2 object
      - `author` User
        - `auth_addresses` object[], required
          - `address` string, required — Ethereum address
          - `app` UserDehydrated, required
            - `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
        - `custody_address` string, required — Ethereum address
        - `display_name` string, nullable
        - `experimental` object
          - `deprecation_notice` string
          - `neynar_user_score` number, double, required — Score that represents the probability that the account is not spam.
        - `fid` integer, required — The unique identifier of a farcaster user or app (unsigned integer)
        - `follower_count` integer, required — The number of followers the user has.
        - `following_count` integer, required — The number of users the user is following.
        - `object` 'user', required
        - `pfp_url` string, nullable — The URL of the user's profile picture
        - `pro` object
          - `expires_at` string, date-time, required
          - `status` 'subscribed' | 'unsubscribed', required — The subscription status of the user
          - `subscribed_at` string, date-time, required
        - `profile` object, required
          - `banner` object
            - `url` string, uri — The URL of the user's banner image
          - `bio` object, required
            - `mentioned_channels` ChannelDehydrated[]
              - …
            - `mentioned_channels_ranges` TextRange[] — Positions within the text (inclusive start, exclusive end) where each mention occurs. Each index within this list corresponds to the same-numbered index in the mentioned_channels list.
              - …
            - `mentioned_profiles` UserDehydrated[]
              - …
            - `mentioned_profiles_ranges` TextRange[] — Positions within the text (inclusive start, exclusive end) where each mention occurs. Each index within this list corresponds to the same-numbered index in the mentioned_profiles list.
              - …
            - `text` string, required
          - `live_at` object
            - `is_live` boolean, required
            - `updated_at` string, date-time, required
            - `url` string, required — The URL of the user's current live activity
          - `location` Location — Coordinates and place names for a location
            - `address` LocationAddress
              - …
            - `latitude` number, double, required
            - `longitude` number, double, required
            - `radius` number — The radius in meters for the location search. Any location within this radius will be returned.
        - `registered_at` string, date-time, required
        - `score` number, double — Score that represents the probability that the account is not spam.
        - `username` string, required
        - `verifications` EthAddress[], required
        - `verified_accounts` object[], required
          - `platform` 'x' | 'github'
          - `username` string
        - `verified_addresses` object, required
          - `eth_addresses` EthAddress[], required — List of verified Ethereum addresses of the user sorted by oldest to most recent.
          - `primary` object, required
            - `eth_address` string, required — Ethereum address
            - `sol_address` string, required — Solana address
          - `sol_addresses` SolAddress[], required — List of verified Solana addresses of the user sorted by oldest to most recent.
        - `viewer_context` UserViewerContext — Adds context on the viewer's follow relationship with the user.
          - `blocked_by` boolean, required — Indicates if the viewer is blocked by the user.
          - `blocking` boolean, required — Indicates if the viewer is blocking the user.
          - `followed_by` boolean, required — Indicates if the viewer is followed by the user.
          - `following` boolean, required — Indicates if the viewer is following the user.
      - `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
            - object — Rich OEmbed data
              - …
            - object — Video OEmbed data
              - …
            - object — Photo OEmbed data
              - …
            - object — Link OEmbed data
              - …
          - `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
      - `title` string — Button title of a mini app
      - `version` string, required — Version of the mini app, 'next' for v2, 'vNext' for v1
    - `remaining_relevant_users` UserDehydrated[], required — Array of remaining relevant users in dehydrated form
      - `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
    - `top_relevant_users` User[], required — Array of the most relevant users
      - `auth_addresses` object[], required
        - `address` string, required — Ethereum address
        - `app` UserDehydrated, required
          - `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
      - `custody_address` string, required — Ethereum address
      - `display_name` string, nullable
      - `experimental` object
        - `deprecation_notice` string
        - `neynar_user_score` number, double, required — Score that represents the probability that the account is not spam.
      - `fid` integer, required — The unique identifier of a farcaster user or app (unsigned integer)
      - `follower_count` integer, required — The number of followers the user has.
      - `following_count` integer, required — The number of users the user is following.
      - `object` 'user', required
      - `pfp_url` string, nullable — The URL of the user's profile picture
      - `pro` object
        - `expires_at` string, date-time, required
        - `status` 'subscribed' | 'unsubscribed', required — The subscription status of the user
        - `subscribed_at` string, date-time, required
      - `profile` object, required
        - `banner` object
          - `url` string, uri — The URL of the user's banner image
        - `bio` object, required
          - `mentioned_channels` ChannelDehydrated[]
            - `id` string, required
            - `image_url` string
            - `name` string, required
            - `object` 'channel_dehydrated', required
            - `viewer_context` ChannelUserContext — Adds context on the viewer's or author's role in the channel.
              - …
          - `mentioned_channels_ranges` TextRange[] — Positions within the text (inclusive start, exclusive end) where each mention occurs. Each index within this list corresponds to the same-numbered index in the mentioned_channels list.
            - `end` number, required
            - `start` number, required
          - `mentioned_profiles` 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
          - `mentioned_profiles_ranges` TextRange[] — Positions within the text (inclusive start, exclusive end) where each mention occurs. Each index within this list corresponds to the same-numbered index in the mentioned_profiles list.
            - `end` number, required
            - `start` number, required
          - `text` string, required
        - `live_at` object
          - `is_live` boolean, required
          - `updated_at` string, date-time, required
          - `url` string, required — The URL of the user's current live activity
        - `location` Location — Coordinates and place names for a location
          - `address` LocationAddress
            - `city` string, required
            - `country` string, required
            - `country_code` string
            - `state` string
            - `state_code` string
          - `latitude` number, double, required
          - `longitude` number, double, required
          - `radius` number — The radius in meters for the location search. Any location within this radius will be returned.
      - `registered_at` string, date-time, required
      - `score` number, double — Score that represents the probability that the account is not spam.
      - `username` string, required
      - `verifications` EthAddress[], required
      - `verified_accounts` object[], required
        - `platform` 'x' | 'github'
        - `username` string
      - `verified_addresses` object, required
        - `eth_addresses` EthAddress[], required — List of verified Ethereum addresses of the user sorted by oldest to most recent.
        - `primary` object, required
          - `eth_address` string, required — Ethereum address
          - `sol_address` string, required — Solana address
        - `sol_addresses` SolAddress[], required — List of verified Solana addresses of the user sorted by oldest to most recent.
      - `viewer_context` UserViewerContext — Adds context on the viewer's follow relationship with the user.
        - `blocked_by` boolean, required — Indicates if the viewer is blocked by the user.
        - `blocking` boolean, required — Indicates if the viewer is blocking the user.
        - `followed_by` boolean, required — Indicates if the viewer is followed by the user.
        - `following` boolean, required — Indicates if the viewer is following the user.

---

[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)