{ "openapi": "3.0.1", "info": { "title": "Amazon Search Scraper + Ratings Histogram", "description": "Drop-in compatible with junglee/free-amazon-product-scraper — 12x cheaper and reliable. Amazon search results as JSON: ASIN, title, price, list price, stars, exact ratings count, image, position, page — plus the 1-5 star ratings histogram on every product. No login, no captcha solver.", "version": "1.0", "x-build-id": "4vfwabq0DMnbEpSLY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/diopside~amazon-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-diopside-amazon-search", "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/diopside~amazon-search/runs": { "post": { "operationId": "runs-sync-diopside-amazon-search", "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/diopside~amazon-search/run-sync": { "post": { "operationId": "run-sync-diopside-amazon-search", "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": { "categoryUrls": { "title": "Amazon search / category URLs", "uniqueItems": true, "type": "array", "description": "Amazon search URLs, category URLs or product (`/dp/`) URLs. Any filters you put in the URL (`rh=`, `s=price-asc-rank`, department nodes) are preserved; only `page` is replaced. Same field name and shape as `junglee/free-amazon-product-scraper`, so an existing input works unchanged.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchTerms": { "title": "Search terms (keywords)", "type": "array", "description": "Plain keywords, searched on the marketplace chosen in `domain`. Easier than building URLs by hand; combined with `categoryUrls` if you give both.", "default": [], "items": { "type": "string" } }, "search": { "title": "Search URL (single)", "type": "string", "description": "A single Amazon search URL. Accepted for drop-in compatibility with `igolaizola/amazon-search`." }, "maxItems": { "title": "Max items (total per start URL)", "minimum": 0, "type": "integer", "description": "Alias of `maxItemsPerStartUrl`, accepted for drop-in compatibility with `igolaizola/amazon-search`. 0 = every result Amazon will return." }, "maxItemsPerStartUrl": { "title": "Max results (per start URL)", "minimum": 0, "type": "integer", "description": "Maximum number of products to scrape per start URL. 0 = every result Amazon will return. Same field name as `junglee/free-amazon-product-scraper`." }, "maxSearchPagesPerStartUrl": { "title": "Maximum search pages (per start URL)", "minimum": 1, "type": "integer", "description": "Stop after this many listing pages per start URL (16 results per page). Whichever of this and `maxItemsPerStartUrl` is reached first wins. Same field name as `junglee/free-amazon-product-scraper`." }, "domain": { "title": "Amazon marketplace", "enum": [ "amazon.com", "amazon.co.uk", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.nl", "amazon.se", "amazon.pl", "amazon.ca", "amazon.com.mx", "amazon.com.br", "amazon.com.au", "amazon.co.jp", "amazon.in", "amazon.sg", "amazon.ae", "amazon.sa", "amazon.com.tr", "amazon.com.be", "amazon.eg" ], "type": "string", "description": "Marketplace used for plain `searchTerms` and for product ASINs. Start URLs keep their own marketplace. Prices are reported in this marketplace's currency.", "default": "amazon.com" }, "scrapeRatingsHistogram": { "title": "Include the 1-5 star ratings histogram", "type": "boolean", "description": "Fetch each product's ratings summary (a ~21 KB fragment, not the 2.5 MB product page) to add `ratingsHistogram`, `starsBreakdown` and the **exact** `reviewsCount` / `ratingsTotal` — search cards only show a rounded '1.6K'. Adds roughly one fifth of the run's traffic. Turn off for the fastest, cheapest listing-only run.", "default": true }, "residentialFallback": { "title": "Fall back to residential proxy when blocked", "type": "boolean", "description": "Non-US marketplaces (amazon.co.uk, amazon.de, ...) block Apify datacenter IPs as a tier, so a blocked marketplace is retried once on a residential IP in its own country. amazon.com does not need this and never pays for it. Turn off to keep a run strictly on the proxy tier you configured.", "default": true }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Amazon fingerprints the TLS handshake, not just the IP, and this actor already presents a real Chrome fingerprint — so the default Apify **datacenter** proxy is enough and RESIDENTIAL is not needed. Keep the proxy on; raw platform IPs are the ones Amazon knows best.", "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 } } } } } } } } } }