{ "openapi": "3.0.1", "info": { "title": "Amazon Product Scraper – Prices, Reviews & BSR (20 Markets)", "description": "Scrape Amazon search results, product URLs and ASINs on 20 marketplaces: price, list price, rating, reviews, Prime, sponsored, badges, brand, features, seller and Best Sellers Rank.", "version": "1.2", "x-build-id": "7X3vteNxgd8rdMIzH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ninhothedev~amazon-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ninhothedev-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/ninhothedev~amazon-product-scraper/runs": { "post": { "operationId": "runs-sync-ninhothedev-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/ninhothedev~amazon-product-scraper/run-sync": { "post": { "operationId": "run-sync-ninhothedev-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", "properties": { "searchTerms": { "title": "Search keywords", "type": "array", "description": "Keywords to search on Amazon, e.g. 'wireless earbuds'. One search per line. Leave empty if you only scrape URLs or ASINs below.", "items": { "type": "string" } }, "productUrls": { "title": "Product URLs or ASINs", "type": "array", "description": "Amazon product pages (any format: /dp/, /gp/product/, with or without tracking parameters) or bare 10-character ASINs such as B0BTYDLTM3. Bare ASINs use the Marketplace selected below. Each product is scraped from its detail page (brand, bullet points, images, seller, Best Sellers Rank…).", "items": { "type": "string" } }, "searchUrls": { "title": "Amazon search or category URLs", "type": "array", "description": "Paste any Amazon search-results URL, including filters and category nodes (e.g. https://www.amazon.de/s?k=usb+c+kabel&rh=p_72%3A419122031). The marketplace is detected from the domain. Product URLs pasted here are also accepted.", "items": { "type": "string" } }, "marketplace": { "title": "Marketplace", "enum": [ "com", "de", "gb", "fr", "it", "es", "nl", "be", "ie", "se", "pl", "ca", "au", "mx", "br", "jp", "in", "ae", "tr", "sg" ], "type": "string", "description": "Amazon country site used for Search keywords and bare ASINs.", "default": "com" }, "sort": { "title": "Sort order", "enum": [ "featured", "price_asc", "price_desc", "newest", "reviews", "bestsellers" ], "type": "string", "description": "How Amazon sorts the search results.", "default": "featured" }, "priceMin": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Lower price bound in the marketplace currency (optional)." }, "priceMax": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Upper price bound in the marketplace currency (optional)." }, "maxItemsPerSearch": { "title": "Max results per search", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum products per keyword / search URL. Amazon shows ~16–60 products per page and usually up to 7–20 pages.", "default": 100 }, "maxItems": { "title": "Max results in total", "minimum": 0, "type": "integer", "description": "Global cap on saved products across searches and product inputs, including rows already saved in a resumed run. 0 means no additional row cap. Set Maximum total charge in run options too.", "default": 0 }, "maxPages": { "title": "Max pages per search", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many result pages to paginate through per search (1–20).", "default": 10 }, "scrapeDetails": { "title": "Enrich with product page details", "type": "boolean", "description": "Also open each product page to add brand, bullet points (features), all images, availability, seller, fulfilment, Best Sellers Rank and category breadcrumbs. Slower (one extra request per product). Product URLs/ASINs are always enriched.", "default": false }, "maxConcurrency": { "title": "Detail page concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Parallel enrichment requests for search-result rows (1–10), bounded by remaining result and event budgets. Standalone product inputs run sequentially to avoid extra requests after a small limit.", "default": 3 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. By default the actor connects directly and automatically falls back to Apify datacenter proxies, rotating sessions when Amazon shows a CAPTCHA. For large runs or heavily protected marketplaces choose Apify Proxy → RESIDENTIAL (the country is matched to the marketplace automatically)." } } }, "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 } } } } } } } } } }