{ "openapi": "3.0.1", "info": { "title": "Amazon Product Scraper - Prices, ASIN & Demand Signal", "description": "Product research and price monitoring on Amazon without the Product Advertising API. Scrape search results into typed rows: price with an explicit currency, ASIN, brand, rating, review count and the bought-in-past-month demand signal. Rows in the wrong currency are flagged, not mixed in.", "version": "0.1", "x-build-id": "ORaNCnKebxhsKh4Bo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/henrycrawl~amazon-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-henrycrawl-amazon-products-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/henrycrawl~amazon-products-scraper/runs": { "post": { "operationId": "runs-sync-henrycrawl-amazon-products-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/henrycrawl~amazon-products-scraper/run-sync": { "post": { "operationId": "run-sync-henrycrawl-amazon-products-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": { "keywords": { "title": "Search keywords", "type": "array", "description": "Each keyword runs as its own Amazon search using the filters below.", "items": { "type": "string" } }, "startUrls": { "title": "Amazon search URLs", "type": "array", "description": "Paste Amazon search or category URLs. Scraped in addition to any keywords.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "amazonDomain": { "title": "Amazon marketplace", "enum": [ "www.amazon.com", "www.amazon.co.uk", "www.amazon.de", "www.amazon.fr", "www.amazon.it", "www.amazon.es", "www.amazon.ca", "www.amazon.com.au", "www.amazon.co.jp" ], "type": "string", "description": "Which Amazon marketplace to search. The expected currency is derived from this.", "default": "www.amazon.com" }, "proxyCountry": { "title": "Proxy country", "enum": [ "US", "GB", "DE", "FR", "IT", "ES", "CA", "AU", "JP" ], "type": "string", "description": "Match this to the marketplace. Amazon prices by geography: requesting amazon.com from elsewhere returns local currency and local delivery, and those rows are flagged as unusable.", "default": "US" }, "maxProducts": { "title": "Max products (hard cap)", "minimum": 1, "maximum": 50000, "type": "integer", "description": "The run stops at exactly this many products. Enforced, so you cannot be billed for more rows than you asked for.", "default": 100 }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "price_low", "price_high", "newest", "rating" ], "type": "string", "description": "Amazon's own sort options.", "default": "relevance" }, "minPrice": { "title": "Min price", "type": "integer", "description": "Lower price bound, in the marketplace currency." }, "maxPrice": { "title": "Max price", "type": "integer", "description": "Upper price bound, in the marketplace currency." }, "primeOnly": { "title": "Prime only", "type": "boolean", "description": "Restrict to Prime-eligible offers.", "default": false }, "excludeSponsored": { "title": "Exclude sponsored results", "type": "boolean", "description": "Drops paid placements. Off by default because ad presence is itself useful competitive data; every row carries isSponsored either way.", "default": false }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "Keep this low. Amazon rate limits per session and aggressive parallelism trades throughput for blocks.", "default": 2 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Defaults to Apify residential proxy in the selected country. Amazon answers datacenter ranges with HTTP 503.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }