{ "openapi": "3.0.1", "info": { "title": "Shopify App Store Scraper", "description": "Scrape Shopify App Store apps, pricing plans, ratings, and merchant reviews. MCP/API-ready.", "version": "0.1", "x-build-id": "sWmF2c0vgU6Oln9Ub" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~shopify-app-store-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-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/khadinakbar~shopify-app-store-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-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/khadinakbar~shopify-app-store-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-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", "properties": { "queries": { "title": "Search queries", "type": "array", "description": "Free-text keywords searched on the Shopify App Store, one app niche per line (e.g. 'email marketing', 'product reviews'). Each query returns a paginated list of matching app cards. Leave empty if you are passing app, category, or review URLs in 'Start URLs' instead. NOT an app URL — to scrape one specific app use 'Start URLs'.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Direct apps.shopify.com URLs; the mode is auto-detected per URL. App page (apps.shopify.com/klaviyo-email-marketing) returns full app detail; a /reviews URL returns merchant reviews; a /categories/ URL returns the category app list; a /search?q= URL runs a search. Use this for precise targets instead of free-text 'Search queries'.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "mode": { "title": "Mode", "enum": [ "auto", "search", "category", "app_detail", "reviews" ], "type": "string", "description": "Forces a scraping mode instead of auto-detecting from the URL. 'auto' (default) detects search vs category vs app_detail vs reviews from each input. Set explicitly only to override detection (e.g. force 'reviews' on a bare app URL). Most users should leave this on 'auto'.", "default": "auto" }, "scrapeReviews": { "title": "Also scrape reviews for each app", "type": "boolean", "description": "When scraping app detail pages (or apps found via search/category with 'Enrich details' on), also paginate that app's merchant reviews and emit one record per review. Adds review-scraped charges. Defaults to false. Ignored when the input is already a /reviews URL.", "default": false }, "enrichDetails": { "title": "Enrich search/category results with full detail", "type": "boolean", "description": "For search and category modes, visit each app's detail page to add full metadata (description, pricing plans, developer, works-with, languages) instead of just the listing card. Slower and adds one app-scraped charge per app. Defaults to false (fast card-level listing only).", "default": false }, "maxApps": { "title": "Max apps per query/category", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on how many apps to return per search query or category, across pagination. Caps the app-scraped charge so cost stays predictable. Defaults to 50; set 0 or leave default for typical runs. Does not limit reviews — use 'Max reviews per app' for that.", "default": 50 }, "maxReviews": { "title": "Max reviews per app", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Hard cap on reviews scraped per app (10 reviews per page). Caps the review-scraped charge. Defaults to 100. Only applies when scraping reviews (a /reviews URL, or 'Also scrape reviews' enabled).", "default": 100 }, "reviewSort": { "title": "Review sort order", "enum": [ "most_recent", "highest_rating", "lowest_rating", "most_helpful" ], "type": "string", "description": "Order reviews are returned in when scraping reviews. 'most_recent' (default) is newest first; 'highest_rating' / 'lowest_rating' sort by stars; 'most_helpful' uses Shopify's helpfulness ranking. Ignored outside review scraping.", "default": "most_recent" }, "reviewRating": { "title": "Filter reviews by star rating", "minimum": 0, "maximum": 5, "type": "integer", "description": "Only scrape reviews with this exact star rating (1-5). Leave at 0 (default) to scrape all ratings. Useful for pulling only 1-star complaints or 5-star praise. Ignored outside review scraping.", "default": 0 }, "country": { "title": "Proxy country", "type": "string", "description": "Two-letter country code for the Apify residential/datacenter proxy egress (e.g. 'US', 'GB'). Affects geo-targeted pricing/currency shown on listings. Defaults to 'US'. Uppercase ISO-3166 alpha-2.", "default": "US" }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum parallel requests. Defaults to 10. Lower it (e.g. 5) for very large jobs (thousands of apps) if you hit rate-limit (HTTP 429) blocks — slower but steadier. Raising it rarely helps and risks more blocks.", "default": 10 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy settings. Defaults to Apify Proxy (AUTO) which is sufficient — apps.shopify.com is not aggressively bot-protected. Override only if you need a specific proxy group or country.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }