{ "openapi": "3.0.1", "info": { "title": "Shopify Store Products Scraper and Price Monitor", "description": "Scrape any Shopify store: products, variants, prices, compare-at prices, stock, images and collections. Track price drops over time. No API key needed.", "version": "0.0", "x-build-id": "Ge9hrNRNnYbsBMmRb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tiger19935~shopify-store-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tiger19935-shopify-store-products-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/tiger19935~shopify-store-products-scraper/runs": { "post": { "operationId": "runs-sync-tiger19935-shopify-store-products-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/tiger19935~shopify-store-products-scraper/run-sync": { "post": { "operationId": "run-sync-tiger19935-shopify-store-products-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": [ "stores" ], "properties": { "stores": { "title": "Stores", "minItems": 1, "type": "array", "description": "One store per row: a domain (allbirds.com) or a full address. A collection link such as https://store.com/collections/sale reads only that collection.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many products per store (after filters).", "default": 1000 }, "outputMode": { "title": "Output rows", "enum": [ "product", "variant" ], "type": "string", "description": "One row per product (variants nested inside) or one row per variant (size, colour, SKU in separate rows). Billing is per product in both modes.", "default": "product" }, "includeVariants": { "title": "Include variants in product rows", "type": "boolean", "description": "Add the list of variants (price, SKU, stock, options) to each product row.", "default": true }, "includeDescription": { "title": "Include description", "type": "boolean", "description": "Add the product description as plain text.", "default": false }, "searchKeywords": { "title": "Keywords filter", "type": "array", "description": "Keep products whose title, vendor, type or tags contain any of these words. Leave empty for all products.", "items": { "type": "string" } }, "onlyAvailable": { "title": "Only products in stock", "type": "boolean", "description": "Skip products where every variant is sold out.", "default": false }, "minPrice": { "title": "Minimum price", "type": "number", "description": "Keep products priced at or above this value (store currency)." }, "maxPrice": { "title": "Maximum price", "type": "number", "description": "Keep products priced at or below this value (store currency)." }, "monitorMode": { "title": "Monitor changes", "type": "boolean", "description": "Compare with the previous run of the same store and return only what changed: new products, price drops and increases, back in stock, sold out, removed. The first run saves a baseline and returns nothing. Schedule the actor to track a store daily.", "default": false }, "platform": { "title": "Platform", "enum": [ "auto", "shopify", "woocommerce" ], "type": "string", "description": "Detected automatically. Force a platform only if detection fails.", "default": "auto" }, "maxConcurrency": { "title": "Parallel stores", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many stores are read at the same time.", "default": 3 }, "requestDelayMs": { "title": "Delay between pages (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Pause between page requests to the same store. Raise it for stores that rate-limit.", "default": 350 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }