{ "openapi": "3.0.1", "info": { "title": "Amazon Product & Seller Scraper", "description": "Scrape Amazon products, prices & sellers fast. Extract titles, images, specs, variant prices, stock status & ASINs, or a seller's full catalog, across 22 Amazon marketplaces", "version": "0.1", "x-build-id": "IZfYRaODpz2wiJAib" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/wilcode~amazon-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-wilcode-amazon-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/wilcode~amazon-scraper/runs": { "post": { "operationId": "runs-sync-wilcode-amazon-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/wilcode~amazon-scraper/run-sync": { "post": { "operationId": "run-sync-wilcode-amazon-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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "product", "prices", "sellerProducts" ], "type": "string", "description": "What to scrape.\n\n- **Product details** — full product data (title, images, features, specs, price, variants) from product URLs or ASINs.\n- **Prices only** — price + availability per ASIN via Amazon's twister API. Much faster and cheaper than full product scraping.\n- **Seller products** — the product listing of a seller/brand storefront.", "default": "product" }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Amazon product page URLs (/dp/, /gp/product/, /gp/aw/d/). Used in **Product details** mode.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "asins": { "title": "ASINs", "uniqueItems": true, "type": "array", "description": "Bare 10-character ASINs, resolved against the **Amazon domain** below. Required in **Prices only** mode; optional in **Product details** mode (in addition to, or instead of, product URLs).", "items": { "type": "string" } }, "sellerUrls": { "title": "Seller URLs", "type": "array", "description": "Amazon seller storefront URLs. Used in **Seller products** mode. Supported formats:\n\n- `https://www.amazon.com/s?me=SELLER_ID&marketplaceID=ATVPDKIKX0DER`\n- `https://www.amazon.com/sp?seller=SELLER_ID`\n- `https://www.amazon.com/s?me=SELLER_ID`", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "domain": { "title": "Amazon domain", "enum": [ "amazon.com", "amazon.co.uk", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.nl", "amazon.com.be", "amazon.pl", "amazon.se", "amazon.ca", "amazon.com.mx", "amazon.com.br", "amazon.com.au", "amazon.co.jp", "amazon.in", "amazon.sg", "amazon.ae", "amazon.sa", "amazon.eg", "amazon.co.za", "amazon.com.tr" ], "type": "string", "description": "The Amazon marketplace used for bare ASINs and for **Prices only** mode. Also decides the default currency.", "default": "amazon.com" }, "fetchPrices": { "title": "Fetch variant prices", "type": "boolean", "description": "In **Product details** mode, also call Amazon's twister API for each variant's price and availability. Only runs for products that really have variants (more than one ASIN) — single-ASIN products already carry price data from their page. Costs extra requests.", "default": false }, "maxAsins": { "title": "Max ASINs per product", "minimum": 0, "type": "integer", "description": "Cap on how many ASINs (and variants) one product may return. `0` = unlimited. When capped, a greedy pass keeps at least one variant per option value (each Size, each Color), and the requested ASIN is always kept.", "default": 100 }, "page": { "title": "Page", "minimum": 1, "type": "integer", "description": "Which page of seller results to fetch. Ignored when **Scrape all pages** is on.", "default": 1 }, "allPages": { "title": "Scrape all pages", "type": "boolean", "description": "Walk every page of the seller's listing, up to **Max pages**.", "default": false }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "Safety limit for **Scrape all pages** (hard cap: 20).", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Amazon blocks datacenter and direct traffic aggressively — **residential proxies are strongly recommended**. Each retry automatically uses a fresh proxy session. You may also supply your own proxy URLs instead of Apify Proxy.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "maxRequestRetries": { "title": "Max retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "Retries per page fetch, each on a fresh proxy. A blocked page, a failed request, or a page that loaded with missing variants all trigger a retry.", "default": 3 } } }, "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 } } } } } } } } } }