{ "openapi": "3.0.1", "info": { "title": "Shopify App Store Scraper", "description": "Scrape the Shopify App Store for app metadata, pricing tiers, ratings, reviews, and Built-for-Shopify badges. Designed for delta-tracking — daily price drops, rating shifts, and badge wins.", "version": "0.1", "x-build-id": "PuYGB1A5ggkw2egJz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alwaysprimedev~shopify-app-store-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alwaysprimedev-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/alwaysprimedev~shopify-app-store-scraper/runs": { "post": { "operationId": "runs-sync-alwaysprimedev-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/alwaysprimedev~shopify-app-store-scraper/run-sync": { "post": { "operationId": "run-sync-alwaysprimedev-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": { "discoveryMode": { "title": "Discovery mode", "enum": [ "sitemap", "categories", "startUrls" ], "type": "string", "description": "How to find apps to scrape. 'sitemap' walks every app in the public sitemap (best for full coverage and incremental runs). 'categories' scrapes only apps that appear in the chosen Shopify category pages (~30-44 curated apps per category). 'startUrls' scrapes a hand-picked list of app pages.", "default": "categories" }, "categories": { "title": "Categories", "uniqueItems": true, "type": "array", "description": "Used when discoveryMode = 'categories'. Choose one or more top-level Shopify App Store categories. Leave empty to fall back to the full sitemap.", "items": { "type": "string", "enum": [ "sales-channels", "finding-products", "selling-products", "orders-and-shipping", "store-design", "marketing-and-conversion", "store-management" ], "enumTitles": [ "Sales channels", "Finding products", "Selling products", "Orders and shipping", "Store design", "Marketing and conversion", "Store management" ] } }, "startUrls": { "title": "Specific app URLs", "type": "array", "description": "Used when discoveryMode = 'startUrls'. Provide one or more app detail page URLs (e.g. https://apps.shopify.com/klaviyo-email-marketing). Use this to monitor a fixed set of apps or competitors.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "scrapeReviews": { "title": "Scrape reviews", "type": "boolean", "description": "When enabled, paginates every app's review pages and pushes one record per review (with rating, author store, country, posted date, body, and developer reply). Disable for cheap app-only runs.", "default": false }, "since": { "title": "Since (incremental mode)", "type": "string", "description": "Optional ISO timestamp. When set with discoveryMode = 'sitemap', only apps whose sitemap lastmod date is on or after this date are scraped — perfect for daily delta runs that only refresh apps which changed." }, "maxItems": { "title": "Max records (overall cap)", "minimum": 0, "type": "integer", "description": "Hard cap on total dataset size. Counts both apps and reviews together. Set to 0 for unlimited.", "default": 50 }, "maxReviewsPerApp": { "title": "Max reviews per app", "minimum": 0, "type": "integer", "description": "Per-app cap on reviews scraped, independent of the overall maxItems. Set to 0 for unlimited (will paginate the entire review history for each app — slow but complete).", "default": 100 }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 25, "type": "integer", "description": "Number of app pages fetched in parallel. Default 3 is polite for datacenter IPs (Shopify rate-limits aggressive bursts). With a residential proxy you can safely raise to 10-15. Hard cap is 25.", "default": 3 } } }, "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 } } } } } } } } } }