{ "openapi": "3.0.1", "info": { "title": "Amazon Product Scraper", "description": "Extract product listings, prices, reviews, and seller offers from any Amazon marketplace worldwide.", "version": "1.0", "x-build-id": "LUhwW4SiSw1c3jxlM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maged120~amazon-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maged120-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/maged120~amazon-scraper/runs": { "post": { "operationId": "runs-sync-maged120-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/maged120~amazon-scraper/run-sync": { "post": { "operationId": "run-sync-maged120-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", "properties": { "keywords": { "title": "Search Keywords", "type": "array", "description": "Keywords to search on Amazon. One keyword per entry.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Amazon search, category, or product page URLs to scrape directly.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "asins": { "title": "Product ASINs", "type": "array", "description": "Amazon Standard Identification Numbers to scrape directly. One per line.", "items": { "type": "string" } }, "amazonDomain": { "title": "Amazon Marketplace", "enum": [ "amazon.com", "amazon.co.uk", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.ca", "amazon.co.jp", "amazon.com.au", "amazon.com.br", "amazon.in", "amazon.com.mx", "amazon.eg", "amazon.nl", "amazon.pl", "amazon.se", "amazon.sg", "amazon.sa", "amazon.ae", "amazon.com.tr" ], "type": "string", "description": "Which Amazon marketplace to scrape.", "default": "amazon.com" }, "sortBy": { "title": "Sort Results By", "enum": [ "relevanceblender", "price-asc-rank", "price-desc-rank", "review-rank", "date-range-rank", "exact-aware-popularity-rank" ], "type": "string", "description": "Sort order for search results.", "default": "relevanceblender" }, "department": { "title": "Department / Category", "enum": [ "aps", "electronics", "stripbooks-intl-ship", "apparel", "automotive", "baby-products", "beauty", "computers", "garden", "grocery", "health-personal-care", "home-garden", "industrial", "digital-text", "movies-tv", "music", "musical-instruments", "office-products", "pets", "photo", "software", "sporting", "tools", "toys-and-games", "videogames", "handmade" ], "type": "string", "description": "Limit search to a specific Amazon department.", "default": "aps" }, "minPrice": { "title": "Minimum Price", "minimum": 0, "type": "integer", "description": "Minimum product price filter (in marketplace currency). Leave empty for no minimum." }, "maxPrice": { "title": "Maximum Price", "minimum": 0, "type": "integer", "description": "Maximum product price filter (in marketplace currency). Leave empty for no maximum.", "default": 200 }, "primeOnly": { "title": "Prime Eligible Only", "type": "boolean", "description": "Only return products eligible for Amazon Prime shipping.", "default": false }, "maxResults": { "title": "Max Results", "minimum": 0, "type": "integer", "description": "Maximum total dataset items to push (0 = unlimited).", "default": 200 }, "maxPages": { "title": "Max Search Pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum search result pages per keyword (each page ~20 results).", "default": 1 }, "scrapeProductDetails": { "title": "Scrape Full Product Details", "type": "boolean", "description": "Visit each product page: description, specs, images, BSR, brand, availability, variations.", "default": false }, "scrapeReviews": { "title": "Scrape Customer Reviews", "type": "boolean", "description": "Scrape customer reviews for each product.", "default": false }, "maxReviewsPerProduct": { "title": "Max Reviews Per Product", "minimum": 0, "type": "integer", "description": "Maximum customer reviews per product (0 = unlimited).", "default": 20 }, "scrapeOffers": { "title": "Scrape Third-Party Offers", "type": "boolean", "description": "Scrape all seller offers per product (price, condition, seller, shipping).", "default": false }, "outputSearchResults": { "title": "Output Search Result Rows", "type": "boolean", "description": "Push one dataset row per search result (quick data: title, price, rating, thumbnail).", "default": true }, "outputProducts": { "title": "Output Full Product Rows", "type": "boolean", "description": "Push one dataset row per full product detail page.", "default": true }, "outputReviews": { "title": "Output Review Rows", "type": "boolean", "description": "Push one dataset row per customer review.", "default": true }, "outputOffers": { "title": "Output Offer Rows", "type": "boolean", "description": "Push one dataset row per third-party seller offer.", "default": true }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Residential proxy is strongly recommended for Amazon." } } }, "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 } } } } } } } } } }