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

​
Usage

import { sdk } from '@farcaster/miniapp-sdk'

await sdk.actions.openMiniApp({
  domain: 'example-app.com',
  path: '/some/path', // optional
})

​
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.

​
Return Value

void

​
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