{ "openapi": "3.0.1", "info": { "title": "E-commerce Store Catalog Scraper", "description": "92% success. Give it any store URL — get the full product catalog as clean JSON: products, variants, prices, sale prices, stock and images. Auto-detects Shopify, WooCommerce, PrestaShop and Magento.", "version": "0.1", "x-build-id": "fH6X5RlxTYaK0VvE9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/itsyas~store-catalog-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-itsyas-store-catalog-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/itsyas~store-catalog-scraper/runs": { "post": { "operationId": "runs-sync-itsyas-store-catalog-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/itsyas~store-catalog-scraper/run-sync": { "post": { "operationId": "run-sync-itsyas-store-catalog-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": [ "storeUrl" ], "properties": { "storeUrl": { "title": "Store URL", "type": "string", "description": "The e-commerce store to scrape, e.g. https://my-shop.com. The platform (Shopify, WooCommerce, PrestaShop, Magento) is detected automatically." }, "platform": { "title": "Platform", "enum": [ "auto", "shopify", "woocommerce", "prestashop", "magento" ], "type": "string", "description": "Skip auto-detection if you already know the platform.", "default": "auto" }, "maxProducts": { "title": "Max products", "minimum": 1, "type": "integer", "description": "Stop after this many products (cost control). Leave empty for the full catalog." }, "stockDetail": { "title": "Numeric stock detail (Shopify)", "enum": [ "auto", "always", "never" ], "type": "string", "description": "Shopify only: recover exact stock quantities via one extra request per product. 'Auto' probes a few products first and skips the slow pass when the shop doesn't publish quantities. Availability (in/out of stock) is ALWAYS included regardless.", "default": "auto" }, "customStoreLlm": { "title": "Scrape custom-built stores (AI)", "type": "boolean", "description": "For stores that are NOT Shopify/WooCommerce/PrestaShop/Magento, let an AI agent build an extraction recipe by exploring the site. Costs more (see pricing) and is capped per store. Leave off to only scrape the four supported platforms.", "default": false }, "llmBudgetUsd": { "title": "AI budget cap per store (USD)", "enum": [ "1", "2", "3" ], "type": "string", "description": "Hard ceiling on AI spend for each custom store. The run stops cleanly if reached. Only applies when 'Scrape custom-built stores' is on.", "default": "2" }, "anthropicApiKey": { "title": "Your Anthropic API key (optional)", "type": "string", "description": "Optional: bring your own Anthropic key so the AI runs on YOUR account (cheaper per-result pricing applies). Leave empty to use ours (custom-store pricing applies)." }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Skip URLs disallowed by the store's robots.txt. Only disable this when the store owner has authorised the scrape.", "default": 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 } } } } } } } } } }