Capacitor Native Market Plugin

Send users to your app's store page from your Capacitor app, to rate it, update it or discover your other apps on the App Store and Google Play.

🤖 Building with an AI coding agent? Install Capgo skills so Claude Code, Codex, Cursor, Copilot, or Gemini CLI know how to install and use @capgo/capacitor-native-market in your Capacitor app: npx skills add Cap-go/capgo-skills. Then ask your agent: "Add @capgo/capacitor-native-market to my Capacitor app and wire it up." Agent setup guides · Hosted MCP

Key features

• Store listing: openStoreListing() opens an app's page on the App Store or Google Play.
• Search: search() opens a store search for your terms.
• Developer page: openDevPage() on Google Play.
• Collections: openCollection() and openEditorChoicePage() on Google Play.
• Platforms: iOS and Android. Developer pages, collections and Editor's choice are Android only. Not available on web.

Why Native Market?

Deep-link your users directly to your app's store listing, developer page, or search results. Essential for:

• Prompting app reviews - Direct users to leave ratings and reviews
• Update notifications - Send users to download the latest version
• Cross-promotion - Link to your other apps or developer page
• Search visibility - Open store searches for specific terms

Simple, focused plugin that handles all the platform-specific store linking logic for you.

Maintainers

Maintenance Status: Actively Maintained

Documentation

The most complete doc is available here: https://capgo.app/docs/plugins/native-market/

Compatibility

Note: The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

Installation

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

Then use the following prompt:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-native-market` plugin in my project.

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

To use npm

npm install @capgo/capacitor-native-market

To use yarn

yarn add @capgo/capacitor-native-market

Sync native files

npx cap sync

iOS Platform: No further action required.

Android Platform: No further action required.

Configuration

No configuration required for this plugin

Supported methods

Usage

import { NativeMarket } from '@capgo/capacitor-native-market';

/**
 * This method will launch link in Play/App Store.
 * @param appId - ID of your application. Eg. com.example.app
 * @param [country] - International country code if application is not published in the US App store (only for iOS). Eg. IT
 * @returns void
 */
NativeMarket.openStoreListing({
  appId: 'com.example.app',
  country: 'IT',
});

/**
 * This method will deep-link directly to an Play/App store listing page.
 * @param devId - ID of developer. Eg. com.example.app
 * @returns void
 */
NativeMarket.openDevPage({
  devId: '5700313618786177705',
});

/**
 * This method will link users to a collection or top charts.
 * @param name - name of the collection. Click [here](https://developer.android.com/distribute/marketing-tools/linking-to-google-play#OpeningCollection) for android options.
 * @returns void
 */
NativeMarket.openCollection({
  name: 'featured',
});

/**
 * This method will link users to Editor's choice page.
 * @param editorChoice - ID of your application. Eg. editorial_fitness_apps_us
 * @returns void
 */
NativeMarket.openEditorChoicePage({
  editorChoice: 'editorial_fitness_apps_us',
});

/**
 * This method will link users to custom search query.
 * @param editorChoice - terms to be searched in Play/App store.
 * @returns void
 */
NativeMarket.search({
  terms: 'capacitor',
});

API

• openStoreListing(...)
• openDevPage(...)
• openCollection(...)
• openEditorChoicePage(...)
• search(...)
• getPluginVersion()

Capacitor Native Market Plugin for opening app store listings and pages.

openStoreListing(...)

openStoreListing(options: { appId: string; country?: string; }) => Promise<void>

Launch app listing page in Play Store (Android) or App Store (iOS).

Since: 1.0.0

openDevPage(...)

openDevPage(options: { devId: string; }) => Promise<void>

Deep-link directly to a developer's page in the Play Store. Android only.

Since: 1.0.0

openCollection(...)

openCollection(options: { name: string; }) => Promise<void>

Link users to a collection or top charts in the Play Store. Android only.

Since: 1.0.0

openEditorChoicePage(...)

openEditorChoicePage(options: { editorChoice: string; }) => Promise<void>

Link users to Editor's choice page in the Play Store. Android only.

Since: 1.0.0

search(...)

search(options: { terms: string; }) => Promise<void>

Search the Play Store with custom search terms. Android only.

Since: 1.0.0

getPluginVersion()

getPluginVersion() => Promise<{ version: string; }>

Get the native Capacitor plugin version.

Returns: Promise<{ version: string; }>

Since: 1.0.0

iOS Notes

If your app is not published in the US App Store, you might not be able to find it. In this case you must specify country code for lookup search to work.