{ "openapi": "3.0.1", "info": { "title": "Amazon Product Scraper", "description": "Scrape Amazon product listings by keyword search, ASIN, or URL. Extract title, price, ratings, reviews, images, features, specifications, seller info, and BSR rank. Also scrapes full review text with helpful votes. No Amazon account required.", "version": "0.1", "x-build-id": "2XeWJIGigoqeF3FxZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rupom888~amazon-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rupom888-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/rupom888~amazon-product-scraper/runs": { "post": { "operationId": "runs-sync-rupom888-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/rupom888~amazon-product-scraper/run-sync": { "post": { "operationId": "run-sync-rupom888-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", "required": [ "scrapeType", "queries" ], "properties": { "scrapeType": { "title": "Scrape Type", "enum": [ "search", "product", "reviews" ], "type": "string", "description": "What to scrape: search by keyword, specific product by ASIN/URL, or product reviews.", "default": "search" }, "queries": { "title": "Keywords / ASINs / URLs", "type": "array", "description": "For search: keywords (e.g. 'wireless headphones'). For product/reviews: ASINs (e.g. 'B08N5WRWNW') or Amazon product URLs.", "items": { "type": "string" } }, "resultsPerQuery": { "title": "Results Per Query", "minimum": 1, "maximum": 500, "type": "integer", "description": "Number of search results to extract per keyword (search mode only).", "default": 50 }, "asins": { "title": "Direct ASIN List", "type": "array", "description": "Optional: provide a list of ASINs to look up directly (e.g. ['B08N5WRWNW', 'B07XJ8C8F5']). Bypasses keyword search. Each ASIN is fetched as a full product page.", "items": { "type": "string" } }, "scrapeDetails": { "title": "Scrape Full Product Details", "type": "boolean", "description": "When in search mode, visit each product page for full details (features, specs, all images, reviews count). Slower but richer data.", "default": false }, "scrapeVariants": { "title": "Scrape Product Variants", "type": "boolean", "description": "Extract detailed variant options (color, size, style) with their individual ASINs, prices, and availability from the product page twister widget.", "default": false }, "department": { "title": "Department Filter", "type": "string", "description": "Amazon department/category code to filter search results (e.g. 'electronics', 'fashion', 'home-garden', 'sports-outdoors')." }, "minPrice": { "title": "Min Price ($)", "minimum": 0, "type": "number", "description": "Minimum product price in USD.", "default": 0 }, "maxPrice": { "title": "Max Price ($)", "minimum": 0, "type": "number", "description": "Maximum product price in USD (0 = no limit).", "default": 0 }, "minRating": { "title": "Minimum Rating (stars)", "minimum": 0, "maximum": 4, "type": "integer", "description": "Filter results to products with at least this star rating. Use 3 for 3+ stars, 4 for 4+ stars, 0 for no filter.", "default": 0 }, "sortBy": { "title": "Sort By", "enum": [ "relevance", "price_asc", "price_desc", "rating", "newest" ], "type": "string", "description": "Sort order for search results.", "default": "relevance" }, "primeOnly": { "title": "Prime Eligible Only", "type": "boolean", "description": "Only return Amazon Prime eligible products.", "default": false }, "excludeSponsored": { "title": "Exclude Sponsored Products", "type": "boolean", "description": "Skip sponsored/ad listings from search results.", "default": false }, "reviewSort": { "title": "Review Sort", "enum": [ "helpful", "recent" ], "type": "string", "description": "Sort order for reviews (reviews mode only).", "default": "helpful" }, "reviewsPerProduct": { "title": "Reviews Per Product", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Number of reviews to extract per ASIN (reviews mode only).", "default": 50 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Residential proxy strongly recommended for Amazon — datacenter IPs are frequently blocked." } } }, "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 } } } } } } } } } }