{ "openapi": "3.0.1", "info": { "title": "E-commerce Product Scraper — Price, Stock & GTIN, Any Store", "description": "Paste product, category or store URLs from almost any online shop and get name, price, currency, stock, SKU, GTIN, brand, images, rating and variants, read from schema.org data, Open Graph and Shopify JSON. Plain HTTP, no browser. From US$4.20 per 1,000 products.", "version": "0.1", "x-build-id": "agHWRu2b0yyPfPX4V" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fabrikit~ecommerce-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fabrikit-ecommerce-product-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/fabrikit~ecommerce-product-scraper/runs": { "post": { "operationId": "runs-sync-fabrikit-ecommerce-product-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/fabrikit~ecommerce-product-scraper/run-sync": { "post": { "operationId": "run-sync-fabrikit-ecommerce-product-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": { "startUrls": { "title": "Store URLs", "type": "array", "description": "Product pages (one row each), or category, collection, search and home pages (the Actor finds the product links on them). Mix stores freely. Left empty, the four example products below are scraped.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max products", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Stop after this many products have been saved (exact). Rows explaining why a start URL gave no product are extra and free. 0 = no limit.", "default": 20 }, "followProductLinks": { "title": "Follow product links on listing pages", "type": "boolean", "description": "When a start URL is not a product page (category, collection, search results, home page), collect the product links on it and scrape them. Off = only product pages are read.", "default": true }, "maxListingPages": { "title": "Listing pages to follow per start URL", "minimum": 1, "maximum": 200, "type": "integer", "description": "How many pages of a category / collection to walk through its \"next page\" link (Shopify collections: pages of 250 products).", "default": 3 }, "useSitemaps": { "title": "Read the store's product sitemap", "type": "boolean", "description": "Also take product URLs from the store's sitemap (robots.txt Sitemap lines, product sitemaps first). Good for a whole catalog; set Max products to keep the run bounded. Home pages without product links use the sitemap automatically.", "default": false }, "includeVariants": { "title": "Include variants", "type": "boolean", "description": "List the variants (size, colour...) with their own SKU, GTIN, price and stock, when the store publishes them.", "default": true }, "maxVariantsPerProduct": { "title": "Max variants per product", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap on the variants array of one product.", "default": 100 }, "includeDescription": { "title": "Include description", "type": "boolean", "description": "Product description as plain text (up to 5,000 characters).", "default": true }, "shopifyVariantData": { "title": "Shopify: read the product JSON", "type": "boolean", "description": "On Shopify stores, also read /products/.js: every variant with SKU, barcode (GTIN), price, compare-at price and stock flag, plus product type and tags. One extra small request per product.", "default": true }, "saveFailedUrls": { "title": "Save rows for start URLs without products", "type": "boolean", "description": "Add a free row with status and error for each start URL that gave no product (blocked, not found, no structured data, robots.txt).", "default": true }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Skip pages the store's robots.txt disallows.", "default": true }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 20, "type": "integer", "description": "Pages read at the same time across all stores (each store gets at most 2 at once, with a short pause between requests).", "default": 6 }, "acceptLanguage": { "title": "Accept-Language", "type": "string", "description": "Language / region sent to the stores (e.g. en-US, de-DE, es-CL). Some stores pick the currency and language from it.", "default": "en-US" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy by default, with a new session per request. Apify Residential is not available in this Actor; to use residential IPs, add your own proxy under Proxy URLs.", "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 }, "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 } } } } } } } } } }