{ "openapi": "3.0.1", "info": { "title": "Amazon Product Scraper", "description": "From $1/1000 results. Extract product titles, prices, ratings, reviews, images, variants (color, size, style), seller info and more from Amazon search, category, best-seller and product pages — all major Amazon domains supported.", "version": "0.1", "x-build-id": "dgFk1BnFccQYtlGrQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/leadsbrary~amazon-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-leadsbrary-amazon-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/leadsbrary~amazon-product-scraper/runs": { "post": { "operationId": "runs-sync-leadsbrary-amazon-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/leadsbrary~amazon-product-scraper/run-sync": { "post": { "operationId": "run-sync-leadsbrary-amazon-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", "required": [ "categoryOrProductUrls" ], "properties": { "categoryOrProductUrls": { "title": "Amazon URLs", "minItems": 1, "type": "array", "description": "Amazon search, category, best-seller, or product URLs to scrape. Examples: https://www.amazon.com/s?k=keyboard, https://www.amazon.com/dp/B0B3BVWJ6Y.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItemsPerStartUrl": { "title": "Max results per URL", "minimum": 0, "type": "integer", "description": "Maximum number of products to save for each start URL. Set to 0 for unlimited.", "default": 100 }, "scrapeProductDetails": { "title": "Scrape product details", "type": "boolean", "description": "Open each product page for full data (title, description, variants, seller, etc.). Disable to get listing-card data only — much faster.", "default": true }, "maxSearchPagesPerStartUrl": { "title": "Max search pages per URL", "minimum": 1, "type": "integer", "description": "Maximum number of search/category pages to paginate through for each start URL.", "default": 9999 }, "maxProductVariantsAsSeparateResults": { "title": "Max variants as separate results", "minimum": 0, "type": "integer", "description": "Maximum number of variant ASINs to enqueue as separate product results per parent product. Variant details are always included in the variantDimensions field.", "default": 0 }, "scrapeProductVariantPrices": { "title": "Scrape variant prices", "type": "boolean", "description": "Visit a limited number of variant product URLs to get their individual prices. Increases run time and blocking risk.", "default": false }, "maxOffers": { "title": "Max offers per product", "minimum": 0, "type": "integer", "description": "Maximum number of offers to scrape from the offer-listing page per product. Set to 0 to skip.", "default": 0 }, "scrapeSellers": { "title": "Scrape seller data", "type": "boolean", "description": "Extract seller data from product pages and enrich the featured seller from their profile page.", "default": false }, "language": { "title": "Language", "enum": [ "", "cs", "da", "de", "en", "es", "fr", "nl", "pl", "pt", "sv", "tr", "he", "ar", "mrta", "hi", "bn", "ta", "te", "kn", "ml", "ko", "zh_CN", "zh_TW", "ja" ], "type": "string", "description": "Language hint for Amazon pages. Each domain supports a different set of languages — unsupported values are ignored.", "default": "" }, "countryCode": { "title": "Delivery country", "enum": [ "", "US", "GB", "DE", "FR", "ES", "IT", "CA", "AU", "JP", "IN", "MX", "BR", "NL", "SE", "PL", "TR", "AE", "SA", "SG" ], "type": "string", "description": "Best-effort delivery country code. For accurate local prices, use the matching Amazon domain and proxyCountry.", "default": "" }, "zipCode": { "title": "ZIP / postal code", "type": "string", "description": "Best-effort ZIP or postal code for Amazon delivery location, e.g. 10001.", "default": "" }, "locationDeliverableRoutes": { "title": "Apply delivery location on", "type": "array", "description": "Page types where the delivery location should be applied.", "items": { "type": "string", "enum": [ "PRODUCT", "SEARCH", "OFFERS" ], "enumTitles": [ "Product pages", "Search/category pages", "Offer-listing pages" ] }, "default": [ "PRODUCT", "SEARCH", "OFFERS" ] }, "useCaptchaSolver": { "title": "Use CAPTCHA solver", "type": "boolean", "description": "Automatically solve Amazon image CAPTCHAs using your own CAPTCHA service API key. Requires captchaApiKey and captchaProvider.", "default": false }, "captchaProvider": { "title": "CAPTCHA provider", "enum": [ "2captcha", "capsolver" ], "type": "string", "description": "CAPTCHA solving service to use. You must have your own account with the selected provider.", "default": "2captcha" }, "captchaApiKey": { "title": "CAPTCHA API key", "type": "string", "description": "Your personal API key from the selected CAPTCHA provider. Required when useCaptchaSolver is enabled." }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of browser pages to run in parallel. Lower values are safer against blocking.", "default": 3 }, "maxRequestRetries": { "title": "Max request retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many times to retry a failed request before marking it as failed.", "default": 3 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 15, "maximum": 300, "type": "integer", "description": "Timeout for a single page request in seconds.", "default": 90 }, "loadImages": { "title": "Load images", "type": "boolean", "description": "Load image resources in the browser. Disable for faster runs — product image URLs are still extracted from HTML.", "default": false }, "proxyCountry": { "title": "Proxy country", "enum": [ "AUTO_SELECT_PROXY_COUNTRY", "US", "GB", "DE", "FR", "ES", "IT", "CA", "AU", "JP", "IN", "MX", "BR", "NL", "SE", "PL", "TR", "AE", "SA", "SG" ], "type": "string", "description": "Country for the proxy. AUTO_SELECT_PROXY_COUNTRY picks a country matching the Amazon domain (e.g. amazon.de → DE).", "default": "AUTO_SELECT_PROXY_COUNTRY" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Leave empty to run without a proxy. For production use, a reliable proxy is strongly recommended — Amazon blocks datacenter IPs aggressively.", "default": {} } } }, "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 } } } } } } } } } }