{ "openapi": "3.0.1", "info": { "title": "Amazon Product & Search Scraper (prices, Best Sellers rank)", "description": "Scrape Amazon products by ASIN, URL, search or Best Sellers list: price, list price, rating, review count, Best Sellers rank, availability, seller, images, specs and variants. 12 marketplaces, local prices via delivery ZIP. Clear errors, no empty rows, pay only per product delivered.", "version": "0.1", "x-build-id": "XLnI0aiNYYGIYQE5q" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapemole~amazon-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapemole-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/scrapemole~amazon-product-scraper/runs": { "post": { "operationId": "runs-sync-scrapemole-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/scrapemole~amazon-product-scraper/run-sync": { "post": { "operationId": "run-sync-scrapemole-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": { "products": { "title": "Products (ASINs or product URLs)", "type": "array", "description": "ASINs (e.g. B0CJZW65R3) or product links from any supported Amazon site, one per line. Each returns the full product record. Duplicates are removed.", "items": { "type": "string" } }, "searchQueries": { "title": "Search keywords", "type": "array", "description": "Keywords to search on the selected marketplace, exactly like the Amazon search box. Returns products in result order (position 1, 2, 3...).", "items": { "type": "string" } }, "categoryUrls": { "title": "Best Sellers, New Releases or search URLs", "type": "array", "description": "Links to Amazon Best Sellers, New Releases, Movers & Shakers or Most Wished For lists (top 100 with ranks), or any Amazon search/category results URL with your filters applied.", "items": { "type": "string" } }, "marketplace": { "title": "Marketplace for ASINs and keywords", "enum": [ "amazon.com", "amazon.co.uk", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.nl", "amazon.ca", "amazon.com.au", "amazon.in", "amazon.co.jp", "amazon.com.mx" ], "type": "string", "description": "Which Amazon site ASINs and search keywords use. URLs always use their own site.", "default": "amazon.com" }, "maxItemsPerListing": { "title": "Max products per search or list", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Stop each search or Best Sellers list after this many products. Best Sellers lists have at most 100.", "default": 50 }, "scrapeProductDetails": { "title": "Open each product page from searches and lists", "type": "boolean", "description": "Off: fast and cheap rows straight from the results page (title, price, rating, reviews, rank/position, badges). On: the full product record for every result (Best Sellers rank, availability, seller, features, specs, images, variants), charged as a product.", "default": false }, "includeSponsored": { "title": "Include sponsored results", "type": "boolean", "description": "Search results include ads, flagged with isSponsored. Turn off to keep organic results only.", "default": true }, "deliveryZipCode": { "title": "Delivery ZIP / postcode", "type": "string", "description": "Prices and availability on Amazon depend on where you ship. Leave empty for the marketplace's main city (e.g. New York 10001 on amazon.com, London on amazon.co.uk, Berlin on amazon.de). Applies to the selected marketplace." }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many pages to load at once. Higher is faster but more likely to be rate limited.", "default": 3 }, "maxRetries": { "title": "Max retries per page", "minimum": 0, "maximum": 15, "type": "integer", "description": "CAPTCHAs and blocks are retried with backoff on a fresh session and IP. Blocked inputs also get one more try at the end of the run.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave the default (Apify datacenter proxy, included in the price). Each block gets a new IP and a fresh session.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }