{ "openapi": "3.0.1", "info": { "title": "E-commerce Product Scraper - Any Store (Structured Data)", "version": "0.1", "x-build-id": "ari0KVCdGb8U55Vlt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/plotpointtech~ecommerce-product-scraper-any-store/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-plotpointtech-ecommerce-product-scraper-any-store", "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/plotpointtech~ecommerce-product-scraper-any-store/runs": { "post": { "operationId": "runs-sync-plotpointtech-ecommerce-product-scraper-any-store", "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/plotpointtech~ecommerce-product-scraper-any-store/run-sync": { "post": { "operationId": "run-sync-plotpointtech-ecommerce-product-scraper-any-store", "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": "Any mix of: product page URLs, category / collection page URLs, store home pages (the whole catalog is found through the store's product feed or sitemap), or sitemap URLs (.xml).", "default": [ "https://cutterbuck.com/baltimore-orioles-stretch-oxford-shirt/", "https://www.zumiez.com/dravus-monarch-black-t-shirt.html" ], "items": { "type": "string" } }, "maxProductsPerStartUrl": { "title": "Max products per category / store URL", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "For category pages, store home pages and sitemaps: stop after this many products. A product page URL always gives one product.", "default": 20 }, "maxResults": { "title": "Max products in total (0 = no limit)", "minimum": 0, "type": "integer", "description": "Stop the whole run after this many products. You can also cap spending with the run's maximum cost.", "default": 0 }, "maxListingPages": { "title": "Max pages per category", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many pages of a category to follow (next-page links) when collecting product links.", "default": 5 }, "includeVariants": { "title": "Include variants", "type": "boolean", "description": "Add the list of variants (size, color...) with their own SKU, GTIN, price and stock, when the store exposes them. Variants stay inside the product row (no extra charge).", "default": true }, "usePlatformApis": { "title": "Use Shopify / WooCommerce fast paths", "type": "boolean", "description": "On Shopify and WooCommerce stores, read the public product feeds these platforms publish (products.json, product .js, WooCommerce Store API). Faster and more complete (all variants, compare-at prices, stock).", "default": true }, "renderJavaScript": { "title": "Browser rendering", "enum": [ "never", "fallback", "always" ], "type": "string", "description": "Some stores add product data with JavaScript. 'Fallback' opens a page in a headless browser only when plain HTTP finds no product data and no product links. Each page rendered in a browser is charged as a separate 'Browser-rendered page' event on top of the product price. Choose 'Never' to avoid browser charges.", "default": "fallback" }, "trackPriceChanges": { "title": "Track price changes", "type": "boolean", "description": "Remember each product's price in a named key-value store and add previousPrice, priceChanged, priceChange, priceChangePercent and availabilityChanged on the next run. Schedule the same input to monitor prices.", "default": false }, "priceHistoryStoreName": { "title": "Price history store name", "type": "string", "description": "Named key-value store that keeps the previous prices. Use a different name for each separate watch list.", "default": "product-price-history" }, "outputOnlyChanges": { "title": "Output only new or changed products", "type": "boolean", "description": "With price tracking on: only save products that are new, or whose price or availability changed since the last run. Unchanged products are not saved and not charged.", "default": false }, "descriptionMaxLength": { "title": "Description length", "minimum": 0, "type": "integer", "description": "Cut product descriptions to this many characters (0 = no limit).", "default": 2000 }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "Pages fetched at the same time across all stores. Each store is still paced individually and its robots.txt crawl delay is honored.", "default": 5 }, "minDelayPerSiteSecs": { "title": "Minimum delay per store (seconds)", "minimum": 0, "maximum": 30, "type": "number", "description": "Minimum gap between two requests to the same store.", "default": 0.4 } } }, "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 } } } } } } } } } }