Skip to main content
Opens another Mini App from within your Mini App.

Usage

Parameters

domain

  • Type: string
The domain of the Mini App to open.

path (optional)

  • Type: string
An optional path to append to the Mini App’s home URL. ##Options
  • url: The URL of the Mini App to open. This can be either:
    • A Mini App embed URL (e.g., https://example.com/specific-page)
    • A Mini App launch URL (e.g., https://farcaster.xyz/miniapps/[id]/[name])

Return Value

Promise<void> The promise resolves when navigation is successful. If navigation fails, the promise will be rejected with an error.

Error Handling

Always await the openMiniApp call and handle potential errors:

Referrer Information

When a Mini App is opened using openMiniApp, the target app receives a special location context with referrer information:

Use Cases

Hub or Portfolio Apps

Create a central hub that showcases multiple Mini Apps:

Referral Systems

Implement referral tracking between Mini Apps:

Notes

  • This will prompt the user to open the new app
  • The current Mini App will be closed when the new app is opened
  • There is no way to navigate back to the original app
  • The opened Mini App will receive a location.type of 'open_miniapp' with a referrerDomain indicating where the user came from