Sign in

v1

latestOpenAPI 3.0.42026-07-26159287356.1 KB
Frame

Relevant mini apps

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

get/v2/farcaster/frame/relevant/

Query parameters

viewer_fidinteger required

FID of the user to fetch relevant mini apps for

time_window'1h' | '6h' | '12h' | '24h' | '7d'
Example:7d

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

networksstring[]

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.

[
  "ethereum",
  "base",
  "solana"
]

Response

Success

Example response

{
  "relevant_frames": [
    {
      "frame": {
        "author": {
          "auth_addresses": [
            {
              "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
              "app": {
                "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
                "fid": 3
              }
            }
          ],
          "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
          "fid": 3,
          "profile": {
            "bio": {
              "mentioned_profiles": [
                {
                  "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
                  "fid": 3
                }
              ]
            }
          },
          "verifications": [
            "0x5a927ac639636e534b678e81768ca19e2c6280b7"
          ],
          "verified_addresses": {
            "eth_addresses": [
              "0x5a927ac639636e534b678e81768ca19e2c6280b7"
            ],
            "primary": {
              "eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
            }
          }
        }
      },
      "remaining_relevant_users": [
        {
          "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
          "fid": 3
        }
      ],
      "top_relevant_users": [
        {
          "auth_addresses": [
            {
              "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
              "app": {
                "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
                "fid": 3
              }
            }
          ],
          "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
          "fid": 3,
          "profile": {
            "bio": {
              "mentioned_profiles": [
                {
                  "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
                  "fid": 3
                }
              ]
            }
          },
          "verifications": [
            "0x5a927ac639636e534b678e81768ca19e2c6280b7"
          ],
          "verified_addresses": {
            "eth_addresses": [
              "0x5a927ac639636e534b678e81768ca19e2c6280b7"
            ],
            "primary": {
              "eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
            }
          }
        }
      ]
    }
  ]
}