{ "openapi": "3.0.1", "info": { "title": "Amazon Product Scraper & Change Monitor", "description": "Scrape Amazon products, search results, categories, bestsellers, sellers, and competitor sets across 19 marketplaces. Run one-time collection or deterministic change monitoring with structured outputs, uncharged error records, and optional change webhooks.", "version": "0.1", "x-build-id": "BrAkJUuE8redlGwg3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ficuslink~amazon-product-scraper-change-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ficuslink-amazon-product-scraper-change-monitor", "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/ficuslink~amazon-product-scraper-change-monitor/runs": { "post": { "operationId": "runs-sync-ficuslink-amazon-product-scraper-change-monitor", "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/ficuslink~amazon-product-scraper-change-monitor/run-sync": { "post": { "operationId": "run-sync-ficuslink-amazon-product-scraper-change-monitor", "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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "products", "search", "seller", "compset", "monitor" ], "type": "string", "description": "Choose a one-time collection mode or monitor all supported source types over repeated runs.", "default": "products" }, "asins": { "title": "ASINs", "type": "array", "description": "Amazon ASINs. Each ASIN is checked in every selected marketplace.", "items": { "type": "string" } }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Amazon product URLs from any supported marketplace.", "items": { "type": "string", "pattern": "^https?://" } }, "queries": { "title": "Search queries", "type": "array", "description": "Keywords searched in every selected marketplace.", "items": { "type": "string" } }, "startUrls": { "title": "Search, category, or bestseller URLs", "type": "array", "description": "Amazon search result, category, bestseller, or product URLs.", "items": { "type": "object", "properties": { "url": { "title": "URL", "description": "Amazon search, category, bestseller, or product URL.", "type": "string" } }, "required": [ "url" ] } }, "sellerUrls": { "title": "Seller storefront URLs", "type": "array", "description": "Amazon seller profile or storefront URLs.", "items": { "type": "string", "pattern": "^https?://" } }, "product": { "title": "Reference product", "type": "string", "description": "ASIN or product URL used as the reference in compset mode." }, "competitors": { "title": "Competitor products", "maxItems": 50, "type": "array", "description": "Up to 50 competitor ASINs or product URLs.", "items": { "type": "string" } }, "marketplaces": { "title": "Marketplaces", "uniqueItems": true, "type": "array", "description": "Marketplaces used for ASINs and queries. URLs retain their own marketplace.", "items": { "type": "string", "enum": [ "amazon.com", "amazon.co.uk", "amazon.in", "amazon.de", "amazon.fr", "amazon.es", "amazon.it", "amazon.ca", "amazon.co.jp", "amazon.com.au", "amazon.com.br", "amazon.com.mx", "amazon.nl", "amazon.sg", "amazon.sa", "amazon.ae", "amazon.pl", "amazon.se", "amazon.com.be" ] }, "default": [ "amazon.com" ] }, "language": { "title": "Language", "type": "string", "description": "Optional Accept-Language value, for example en-US." }, "proxyCountry": { "title": "Proxy country", "type": "string", "description": "Optional ISO 3166-1 alpha-2 override. By default it follows the marketplace." }, "deliveryCountry": { "title": "Delivery country", "type": "string", "description": "Optional delivery-country hint for the Amazon page." }, "zipCode": { "title": "Delivery ZIP or postal code", "type": "string", "description": "Optional delivery ZIP or postal code." }, "maxItems": { "title": "Maximum products", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum successful product results for the run.", "default": 100 }, "maxItemsPerSource": { "title": "Maximum products per source", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum products discovered from each listing source.", "default": 200 }, "maxSearchPages": { "title": "Maximum listing pages per source", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum pages visited for each listing source.", "default": 7 }, "scrapeProductDetails": { "title": "Scrape product details", "type": "boolean", "description": "Open each discovered product page for detailed fields.", "default": true }, "maxOffers": { "title": "Maximum offers per product", "minimum": 0, "maximum": 100, "type": "integer", "description": "Zero disables separate offer-page collection.", "default": 0 }, "scrapeSellers": { "title": "Scrape seller details", "type": "boolean", "description": "Open seller profiles found on product and offer pages.", "default": false }, "scrapeVariantPrices": { "title": "Scrape variant prices", "type": "boolean", "description": "Open variants whose prices are not visible on the base page.", "default": false }, "includeProductPageReviews": { "title": "Include reviews shown on product pages", "type": "boolean", "description": "Copy reviews visible on the product detail page.", "default": false }, "sort": { "title": "Search sorting", "type": "string", "description": "Optional Amazon sort code, such as price-asc-rank or review-rank." }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Optional minimum search price." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Optional maximum search price." }, "category": { "title": "Search category", "type": "string", "description": "Optional Amazon search alias such as electronics." }, "monitorName": { "title": "Monitor name", "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,79}$", "type": "string", "description": "Stable name for saved state. Required in monitor mode." }, "outputProfile": { "title": "Output profile", "enum": [ "full", "compat", "minimal" ], "type": "string", "description": "Choose full records, Junglee-compatible fields, or compact records.", "default": "full" }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum parallel page requests.", "default": 6 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential Apify Proxy is used by default. Custom proxy settings override it.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "captureScreenshotOnChange": { "title": "Screenshot changed products", "type": "boolean", "description": "Capture a browser screenshot only for changed products.", "default": false }, "webhookUrl": { "title": "Change webhook URL", "pattern": "^https://", "type": "string", "description": "HTTPS endpoint notified for changed, new, and confirmed-missing records." }, "webhookHeaders": { "title": "Secret webhook headers", "type": "object", "description": "Optional authentication headers. Values are stored as secrets.", "additionalProperties": true }, "categoryOrProductUrls": { "title": "Junglee: category or product URLs", "type": "array", "description": "Compatibility alias for category and product URLs.", "items": { "type": "object", "properties": { "url": { "title": "URL", "description": "Amazon category or product URL.", "type": "string" } }, "required": [ "url" ] } }, "maxItemsPerStartUrl": { "title": "Junglee: maximum items per URL", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Compatibility alias for maxItemsPerSource." }, "maxProductVariantsAsSeparateResults": { "title": "Junglee: maximum variants as separate results", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum variants emitted as separate product results.", "default": 0 }, "scrapeProductVariantPrices": { "title": "Junglee: scrape variant prices", "type": "boolean", "description": "Compatibility alias for scrapeVariantPrices." } } }, "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 } } } } } } } } } }