> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # SearchMarketListings # Package: marketListing # Namespace: MarketListingService # Method link: https://dev.wix.com/docs/api-reference/app-management/market-listing/search-market-listings.md ## Introduction Searches published market listings by keyword or app name. Intended for AI agents and automation tools that need to find published app listings before taking action, such as installing an app. Defaults to listings in English (`en`). --- ## REST API ### Schema ``` Method: searchMarketListings Description: Searches published market listings by keyword or app name. Intended for AI agents and automation tools that need to find published app listings before taking action, such as installing an app. Defaults to listings in English (`en`). URL: https://www.wixapis.com/devcenter/app-market-listing/v1/market-listings/search Method: POST Method parameters: param name: languageCode | type: languageCode | description: 2-letter language code in ISO 639-1 alpha-2 format. Returns listings in this language. Default: `en` param name: paging | type: Paging - name: limit | type: integer | description: Number of items to load. - name: offset | type: integer | description: Number of items to skip in the current sort order. param name: searchTerm | type: searchTerm | description: Text to search by app name or keyword. Return type: SearchMarketListingsResponse - name: marketListings | type: array | description: Published market listings matching the search. - name: id | type: string | description: Market listing GUID. - name: appId | type: string | description: GUID of the app the listing belongs to. - name: languageCode | type: string | description: 2-letter language code in ISO 639-1 alpha-2 format. For example, `en` for English. - name: basicInfo | type: BasicInfo | description: Basic marketing information about the app, including its name, description, and categories. - name: name | type: string | description: Display name of the app shown in the Wix App Market. - name: teaser | type: string | description: Short description of the app shown in listing previews. - name: longDescription | type: string | description: Full description of the app shown on the listing detail page. - name: benefits | type: array | description: Key benefits of the app displayed on its listing page. - name: title | type: string | description: Benefit title. - name: searchKeywords | type: array | description: Keywords used to improve the app's discoverability in search. - name: demoUrl | type: string | description: URL of a demo page or video for the app. - name: categories | type: array | description: App Market categories the app belongs to. - name: assetsMap | type: Map | description: Map of marketing assets keyed by asset type. JSON field name is `assetsMap`. Common keys include `appIcon`, `screenshots`, and `banners`. The platform may add other keys over time. - name: assets | type: array | description: - name: url | type: string | description: - name: mediaType | type: MediaType | description: - enum: VIDEO, IMAGE, YOUTUBE - name: contactInfo | type: ContactInfo | description: Developer contact and legal information for the app. - name: website | type: string | description: URL of the developer's website. - name: developerMetaSiteId | type: string | description: GUID of the developer's Wix development site associated with the app. - name: supportEmail | type: string | description: Support email address for the app. - name: privacyPolicyUrl | type: string | description: URL of the app's privacy policy. - name: termsOfUseUrl | type: string | description: URL of the app's terms of use. - name: installationRequirement | type: InstallationRequirement | description: Conditions that control where and how the app can be installed. - name: requiredApps | type: array | description: Apps created by Wix that must already be installed for this app to function. For example, Wix Stores. - name: id | type: string | description: Required app GUID. - name: slug | type: string | description: URL-friendly identifier for the required app, as it appears in the Wix App Market URL. For example, in `https://www.wix.com/app-market/wix-stores`, the slug is `wix-stores`. Optional — use `id` alone if you have the app's GUID. - name: includeCountries | type: array | description: 2-letter country codes in ISO-3166 alpha-2 format for countries where this app is available for installation. Empty means available in all countries not listed in `excludeCountries`. - name: excludeCountries | type: array | description: 2-letter country codes in ISO-3166 alpha-2 format for countries where this app is not available for installation. - name: includeLanguages | type: array | description: 2-letter language codes in ISO 639-1 alpha-2 format for languages supported by this app. Empty means all languages are supported, except those in `excludeLanguages`. - name: excludeLanguages | type: array | description: 2-letter language codes in ISO 639-1 alpha-2 format for languages not supported by this app. - name: allowLanguageCustomization | type: boolean | description: Whether the user can choose their preferred language when installing the app. - name: requiredWixPremium | type: boolean | description: Whether a Wix Premium plan is required to install this app. - name: revision | type: string | description: Revision number, which increments by 1 each time the market listing is updated. To prevent conflicting changes, the current revision must be passed when updating the market listing. - name: createdDate | type: string | description: Date and time the market listing was created. - name: updatedDate | type: string | description: Date and time the market listing was updated. - name: status | type: Status | description: Lifecycle status of the listing. - enum: - DRAFT: Editable working copy of the listing in the app dashboard. - PUBLISHED: Live listing visible to users in the Wix App Market. - APPROVED: Post-review, pre-publication state. The listing has passed review but hasn't been promoted to `PUBLISHED` yet. Status transitions are handled manually and can't be set directly. - name: classification | type: Classification | description: How the app integrates with Wix and who can install it. Each app has exactly one classification. - enum: - SITE_APP: A publicly listed app that users install on their Wix sites. - API_KEY: An app that authenticates using an API key to access Wix services, without installing on a site. - VELO_APP: An app built for the Velo development environment. - PRIVATE_APP: An app restricted to the owner account and its sub-accounts. Not available in the public App Market. - HEADLESS: A headless app that accesses Wix public services without installing on a site. - FUNCTION_ACTIVATION_APP: An app scoped to a specific site that tracks activated functions on that site. - name: pricingData | type: PricingData | description: Pricing and free trial information for the app. - name: externalPricingPageUrl | type: string | description: URL of the app's external pricing page, when hosted outside Wix. - name: externalCheckout | type: boolean | description: Whether checkout for this app happens on an external site instead of in Wix. - name: freeTrialDays | type: integer | description: Number of free trial days offered by the app developer. - name: internalFreeTrialDays | type: integer | description: Number of free trial days provided and managed by Wix. - name: llmContext | type: LLMContext | description: Custom description used by LLM-based tools for AI-generated content and recommendations. Available only with the `APP_MARKET.LLM_CONTEXT` permission. - name: instructions | type: string | description: Custom description of the app used by LLM-based tools for AI-generated content and recommendations. - name: llmMetadata | type: LlmMetadata | description: Structured metadata for AI-powered app discovery and recommendations. Available only with the `APP_MARKET.LLM_CONTEXT` permission. - name: primaryUseCases | type: array | description: Primary use cases for the app, used by AI tools for app discovery and recommendations. - name: capabilities | type: Capabilities | description: Functional capabilities of the app. - name: coreFeatures | type: array | description: Core features of the app. - name: advancedFeatures | type: array | description: Advanced features of the app. - name: apiCapabilities | type: array | description: API capabilities exposed by the app. - name: platformFeatures | type: PlatformFeatures | description: Platform and technical constraints of the app. - name: headlessCapable | type: boolean | description: Whether the app supports headless deployments. - name: requiresWixPremium | type: boolean | description: Whether the app requires Wix Premium to function. - name: paging | type: PagingMetadataV2 | description: Paging metadata for the search result set. - name: count | type: integer | description: Number of items returned in the response. - name: offset | type: integer | description: Offset that was requested. - name: total | type: integer | description: Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. - name: tooManyToCount | type: boolean | description: Flag that indicates the server failed to calculate the `total` field. - name: cursors | type: Cursors | description: Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. ``` ### Examples ### Search Market Listings Searches published market listings by keyword or app name. Intended for finding apps before taking actions such as installing them. ```curl curl -X POST \ 'https://www.wixapis.com/app-market-listing/v1/market-listings/search' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ --data-binary '{ "searchTerm": "analytics", "languageCode": "en" }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.marketListing.MarketListingService.searchMarketListings(options) Description: Searches published market listings by keyword or app name. Intended for AI agents and automation tools that need to find published app listings before taking action, such as installing an app. Defaults to listings in English (`en`). Method parameters: param name: options | type: SearchMarketListingsOptions none - name: searchTerm | type: string | description: Text to search by app name or keyword. - name: paging | type: Paging | description: Paging options. Returns up to 50 results per page. - name: limit | type: integer | description: Number of items to load. - name: offset | type: integer | description: Number of items to skip in the current sort order. - name: languageCode | type: string | description: 2-letter language code in ISO 639-1 alpha-2 format. Returns listings in this language. Default: `en` Return type: PROMISE - name: marketListings | type: array | description: Published market listings matching the search. - name: _id | type: string | description: Market listing GUID. - name: appId | type: string | description: GUID of the app the listing belongs to. - name: languageCode | type: string | description: 2-letter language code in ISO 639-1 alpha-2 format. For example, `en` for English. - name: basicInfo | type: BasicInfo | description: Basic marketing information about the app, including its name, description, and categories. - name: name | type: string | description: Display name of the app shown in the Wix App Market. - name: teaser | type: string | description: Short description of the app shown in listing previews. - name: longDescription | type: string | description: Full description of the app shown on the listing detail page. - name: benefits | type: array | description: Key benefits of the app displayed on its listing page. - name: title | type: string | description: Benefit title. - name: searchKeywords | type: array | description: Keywords used to improve the app's discoverability in search. - name: demoUrl | type: string | description: URL of a demo page or video for the app. - name: categories | type: array | description: App Market categories the app belongs to. - name: assetsMap | type: Map | description: Map of marketing assets keyed by asset type. JSON field name is `assetsMap`. Common keys include `appIcon`, `screenshots`, and `banners`. The platform may add other keys over time. - name: assets | type: array | description: - name: url | type: string | description: - name: mediaType | type: MediaType | description: - enum: VIDEO, IMAGE, YOUTUBE - name: contactInfo | type: ContactInfo | description: Developer contact and legal information for the app. - name: website | type: string | description: URL of the developer's website. - name: developerMetaSiteId | type: string | description: GUID of the developer's Wix development site associated with the app. - name: supportEmail | type: string | description: Support email address for the app. - name: privacyPolicyUrl | type: string | description: URL of the app's privacy policy. - name: termsOfUseUrl | type: string | description: URL of the app's terms of use. - name: installationRequirement | type: InstallationRequirement | description: Conditions that control where and how the app can be installed. - name: requiredApps | type: array | description: Apps created by Wix that must already be installed for this app to function. For example, Wix Stores. - name: _id | type: string | description: Required app GUID. - name: slug | type: string | description: URL-friendly identifier for the required app, as it appears in the Wix App Market URL. For example, in `https://www.wix.com/app-market/wix-stores`, the slug is `wix-stores`. Optional — use `id` alone if you have the app's GUID. - name: includeCountries | type: array | description: 2-letter country codes in ISO-3166 alpha-2 format for countries where this app is available for installation. Empty means available in all countries not listed in `excludeCountries`. - name: excludeCountries | type: array | description: 2-letter country codes in ISO-3166 alpha-2 format for countries where this app is not available for installation. - name: includeLanguages | type: array | description: 2-letter language codes in ISO 639-1 alpha-2 format for languages supported by this app. Empty means all languages are supported, except those in `excludeLanguages`. - name: excludeLanguages | type: array | description: 2-letter language codes in ISO 639-1 alpha-2 format for languages not supported by this app. - name: allowLanguageCustomization | type: boolean | description: Whether the user can choose their preferred language when installing the app. - name: requiredWixPremium | type: boolean | description: Whether a Wix Premium plan is required to install this app. - name: revision | type: string | description: Revision number, which increments by 1 each time the market listing is updated. To prevent conflicting changes, the current revision must be passed when updating the market listing. - name: _createdDate | type: Date | description: Date and time the market listing was created. - name: _updatedDate | type: Date | description: Date and time the market listing was updated. - name: status | type: Status | description: Lifecycle status of the listing. - enum: - DRAFT: Editable working copy of the listing in the app dashboard. - PUBLISHED: Live listing visible to users in the Wix App Market. - APPROVED: Post-review, pre-publication state. The listing has passed review but hasn't been promoted to `PUBLISHED` yet. Status transitions are handled manually and can't be set directly. - name: classification | type: Classification | description: How the app integrates with Wix and who can install it. Each app has exactly one classification. - enum: - SITE_APP: A publicly listed app that users install on their Wix sites. - API_KEY: An app that authenticates using an API key to access Wix services, without installing on a site. - VELO_APP: An app built for the Velo development environment. - PRIVATE_APP: An app restricted to the owner account and its sub-accounts. Not available in the public App Market. - HEADLESS: A headless app that accesses Wix public services without installing on a site. - FUNCTION_ACTIVATION_APP: An app scoped to a specific site that tracks activated functions on that site. - name: pricingData | type: PricingData | description: Pricing and free trial information for the app. - name: externalPricingPageUrl | type: string | description: URL of the app's external pricing page, when hosted outside Wix. - name: externalCheckout | type: boolean | description: Whether checkout for this app happens on an external site instead of in Wix. - name: freeTrialDays | type: integer | description: Number of free trial days offered by the app developer. - name: internalFreeTrialDays | type: integer | description: Number of free trial days provided and managed by Wix. - name: llmContext | type: LLMContext | description: Custom description used by LLM-based tools for AI-generated content and recommendations. Available only with the `APP_MARKET.LLM_CONTEXT` permission. - name: instructions | type: string | description: Custom description of the app used by LLM-based tools for AI-generated content and recommendations. - name: llmMetadata | type: LlmMetadata | description: Structured metadata for AI-powered app discovery and recommendations. Available only with the `APP_MARKET.LLM_CONTEXT` permission. - name: primaryUseCases | type: array | description: Primary use cases for the app, used by AI tools for app discovery and recommendations. - name: capabilities | type: Capabilities | description: Functional capabilities of the app. - name: coreFeatures | type: array | description: Core features of the app. - name: advancedFeatures | type: array | description: Advanced features of the app. - name: apiCapabilities | type: array | description: API capabilities exposed by the app. - name: platformFeatures | type: PlatformFeatures | description: Platform and technical constraints of the app. - name: headlessCapable | type: boolean | description: Whether the app supports headless deployments. - name: requiresWixPremium | type: boolean | description: Whether the app requires Wix Premium to function. - name: paging | type: PagingMetadataV2 | description: Paging metadata for the search result set. - name: count | type: integer | description: Number of items returned in the response. - name: offset | type: integer | description: Offset that was requested. - name: total | type: integer | description: Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. - name: tooManyToCount | type: boolean | description: Flag that indicates the server failed to calculate the `total` field. - name: cursors | type: Cursors | description: Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. ``` ### Examples ### searchMarketListings ```javascript import { appMarketListing } from '@wix/app-market-listing'; async function searchMarketListings(options) { const response = await appMarketListing.searchMarketListings(options); }; ``` ### searchMarketListings (with elevated permissions) ```javascript import { appMarketListing } from '@wix/app-market-listing'; import { auth } from '@wix/essentials'; async function mySearchMarketListingsMethod(options) { const elevatedSearchMarketListings = auth.elevate(appMarketListing.searchMarketListings); const response = await elevatedSearchMarketListings(options); } ``` ### searchMarketListings (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { appMarketListing } from '@wix/app-market-listing'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { appMarketListing }, // Include the auth strategy and host as relevant }); async function searchMarketListings(options) { const response = await myWixClient.appMarketListing.searchMarketListings(options); }; ``` ---