{ "openapi": "3.0.1", "info": { "title": "Shopify App Store Scraper: Apps, Reviews & Catalog", "description": "Scrape Shopify App Store search, 87-field app details, pricing plans, reviews, categories, developer portfolios, and localized full catalogs.", "version": "0.0", "x-build-id": "nYCY6K9DG9O95wWTL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapingmonkey~shopify-app-store-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapingmonkey-shopify-app-store-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/scrapingmonkey~shopify-app-store-scraper/runs": { "post": { "operationId": "runs-sync-scrapingmonkey-shopify-app-store-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/scrapingmonkey~shopify-app-store-scraper/run-sync": { "post": { "operationId": "run-sync-scrapingmonkey-shopify-app-store-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "mode" ], "properties": { "mode": { "title": "Scraping mode", "enum": [ "search", "details", "reviews", "category", "collection", "appGroup", "developer", "catalog" ], "type": "string", "description": "Choose the Shopify App Store data source to scrape.", "default": "search" }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords to search for. Required in search mode; maxResults applies to every term.", "items": { "type": "string" }, "default": [ "email marketing" ] }, "appIds": { "title": "App IDs or URLs", "type": "array", "description": "Shopify app handles or full apps.shopify.com details/reviews URLs. Required in details and reviews modes.", "items": { "type": "string" }, "default": [] }, "categoryUrls": { "title": "Category URLs or handles", "type": "array", "description": "Category URLs or handles such as sales-channels-selling-online. Required in category mode.", "items": { "type": "string" }, "default": [] }, "collectionUrls": { "title": "Collection URLs or handles", "type": "array", "description": "Curated Shopify collection URLs or handles. Required in collection mode.", "items": { "type": "string" }, "default": [] }, "appGroupUrls": { "title": "App group URLs or handles", "type": "array", "description": "Shopify app-group URLs or handles. Required in appGroup mode.", "items": { "type": "string" }, "default": [] }, "developerIds": { "title": "Developer handles or URLs", "type": "array", "description": "Developer handles or /partners/ URLs. Required in developer mode.", "items": { "type": "string" }, "default": [] }, "catalogTypes": { "title": "Catalog types", "type": "array", "description": "Localized sitemap catalogs to export in catalog mode.", "items": { "type": "string" }, "default": [ "apps" ] }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Maximum rows per search term, app, listing URL, developer, or catalog type.", "default": 50 }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum simultaneous Shopify requests. Lower this if a large run encounters throttling.", "default": 8 }, "language": { "title": "Store locale", "enum": [ "ar", "cs", "da", "de", "en", "es", "fi", "fr", "he", "it", "ja", "ko", "nb", "nl", "pl", "pt-BR", "pt-PT", "sv", "th", "tr", "ur", "zh-CN", "zh-TW" ], "type": "string", "description": "Localized Shopify App Store locale. Catalog mode supports all 23 published locales.", "default": "en" }, "enrichResults": { "title": "Enrich discovery results", "type": "boolean", "description": "Fetch full app details for search, category, collection, app-group, developer, or apps-catalog rows. Enriched rows are billed as app details.", "default": false }, "includeReviews": { "title": "Include reviews in full app details", "type": "boolean", "description": "Store matching reviews in includedReviews when details are fetched directly or through enrichment.", "default": false }, "builtForShopifyOnly": { "title": "Built for Shopify only", "type": "boolean", "description": "Apply Shopify's Built for Shopify program filter to search and discovery listings.", "default": false }, "searchFeatures": { "title": "Search compatibility filters", "type": "array", "description": "Optional compatibility filters used by Shopify search.", "items": { "type": "string" }, "default": [] }, "searchCategories": { "title": "Search category filters", "type": "array", "description": "Optional top-level Shopify category filters used in search mode.", "items": { "type": "string" }, "default": [] }, "reviewSort": { "title": "Review sort", "enum": [ "newest", "relevant", "highest", "lowest" ], "type": "string", "description": "Newest and relevant use Shopify ordering; highest and lowest traverse ratings in score order.", "default": "newest" }, "reviewScores": { "title": "Review star ratings", "type": "array", "description": "Optional multi-score filter. Leave empty to collect every star rating.", "items": { "type": "string" }, "default": [] }, "reviewKeywords": { "title": "Review keywords", "type": "array", "description": "Keep reviews containing any or all keywords in the review, reviewer, or developer reply text.", "items": { "type": "string" }, "default": [] }, "reviewKeywordMatch": { "title": "Keyword matching", "enum": [ "any", "all" ], "type": "string", "description": "Require any keyword or every keyword.", "default": "any" }, "reviewCountries": { "title": "Reviewer countries", "type": "array", "description": "Optional exact country names as displayed by Shopify, for example United States.", "items": { "type": "string" }, "default": [] }, "reviewUsage": { "title": "Time using app", "type": "array", "description": "Optional exact usage labels as displayed by Shopify.", "items": { "type": "string" }, "default": [] }, "reviewHasDeveloperReply": { "title": "Developer reply filter", "type": "boolean", "description": "When set, keep only reviews with a developer reply (true) or without one (false). Leave unset for both." }, "reviewsSince": { "title": "Reviews since", "type": "string", "description": "Keep reviews on or after this YYYY-MM-DD date." }, "reviewsUntil": { "title": "Reviews until", "type": "string", "description": "Keep reviews on or before this YYYY-MM-DD date." }, "monitoring": { "title": "Enable change monitoring", "type": "boolean", "description": "Compare rows with the previous run in a named key-value store and add change metadata.", "default": false }, "monitoringOnlyChanges": { "title": "Save only new or changed rows", "type": "boolean", "description": "When monitoring is enabled, omit unchanged rows from the dataset.", "default": false }, "monitorStoreName": { "title": "Monitoring store name", "type": "string", "description": "Persistent key-value store used for change snapshots.", "default": "shopify-app-store-monitor" } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }