{ "openapi": "3.0.1", "info": { "title": "Amazon Scraper API β€” Products, Reviews, Sellers, Best Sellers", "description": "Extract Amazon product data, customer reviews, seller profiles and buy-box offers from 19 marketplaces (US, UK, DE,\n FR, IT, ES, JP, IN, AU…). Full PDP, BSR, stars histogram, variants, A+, seller VAT + 4-period feedback. No Amazon API\n needed, no captcha. Pay-per-event from $0.001/record.", "version": "0.1", "x-build-id": "lxf2RgEGuDYC6dEZ2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pro100chok~amazon-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pro100chok-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/pro100chok~amazon-scraper/runs": { "post": { "operationId": "runs-sync-pro100chok-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/pro100chok~amazon-scraper/run-sync": { "post": { "operationId": "run-sync-pro100chok-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", "required": [ "scrapeType" ], "properties": { "scrapeType": { "title": "🎯 What to scrape", "enum": [ "product", "search", "category", "reviews", "seller", "offers" ], "type": "string", "description": "Pick one mode. Each mode pulls a different surface of Amazon and outputs a different shape (see Storage β†’ Dataset views).\n\nπŸ›οΈ **Product** β€” full product details (title, price, brand, breadcrumbs, features, A+ description, images, variants, stars-breakdown, seller, BSR, delivery, ASIN…)\nπŸ” **Search** β€” products ranked by keyword (with Sponsored / Prime / Best-Seller flags)\nπŸ† **Category** β€” products from a /Best-Sellers/ or any category URL\n⭐ **Reviews** β€” review-level rows (rating, title, body, date, verified, helpful, images, variant)\nπŸͺ **Seller** β€” seller profile (business name, address, lifetime/12mo/3mo/1mo feedback, ratings, policies)\nπŸ’² **Offers** β€” every offer for one ASIN (price, condition, seller, Prime, delivery)", "default": "product" }, "productUrls": { "title": "πŸ›οΈ Product URLs or ASINs", "type": "array", "description": "One per line. Accepts full URLs (`https://www.amazon.com/dp/B07XJ8C8F5`) or bare ASINs (`B07XJ8C8F5`). Bare ASINs default to the marketplace below.", "items": { "type": "string" } }, "searchKeywords": { "title": "πŸ” Search keywords", "type": "array", "description": "One keyword per line (e.g. `wireless headphones`, `mechanical keyboard`).", "items": { "type": "string" } }, "searchSort": { "title": "↕️ Sort search results", "enum": [ "relevance", "price-asc-rank", "price-desc-rank", "review-rank", "date-desc-rank" ], "type": "string", "description": "Amazon search sort order.", "default": "relevance" }, "maxSearchPages": { "title": "πŸ“„ Max search pages per keyword", "minimum": 1, "maximum": 20, "type": "integer", "description": "Amazon caps search at ~20 pages.", "default": 5 }, "categoryUrls": { "title": "πŸ† Category URLs", "type": "array", "description": "One per line. Best-seller, New-releases, Movers-&-Shakers or any `/s?...` listing URL.\nExample: `https://www.amazon.com/Best-Sellers/zgbs/electronics`", "items": { "type": "string" } }, "reviewProductUrls": { "title": "⭐ Product URLs or ASINs for reviews", "type": "array", "description": "One per line. Each review is pushed as a separate dataset item.", "items": { "type": "string" } }, "reviewsSort": { "title": "↕️ Reviews sort", "enum": [ "helpful", "recent" ], "type": "string", "description": "Sort order for review pages.", "default": "helpful" }, "reviewsFilterByStar": { "title": "⭐ Star-rating filter", "enum": [ "all_stars", "five_star", "four_star", "three_star", "two_star", "one_star", "positive", "critical" ], "type": "string", "description": "Limit reviews to a single star rating, or to overall positive / critical buckets.", "default": "all_stars" }, "reviewsFilterByMedia": { "title": "πŸ–ΌοΈ Media filter", "enum": [ "all_contents", "media_reviews_only" ], "type": "string", "description": "Show all reviews or only those that include photos / videos.", "default": "all_contents" }, "reviewsFilterByVerified": { "title": "βœ… Only verified-purchase reviews", "type": "boolean", "description": "If true, restrict results to reviews from buyers Amazon verified as purchasers.", "default": false }, "maxReviewsPerProduct": { "title": "πŸ”’ Max reviews per product", "minimum": 0, "type": "integer", "description": "Amazon hard-caps public reviews at ~100 across all sorts. Set 0 for no limit.", "default": 100 }, "sellerInputs": { "title": "πŸͺ Seller IDs or URLs", "type": "array", "description": "One per line. Accepts seller IDs (`A2L77EE7U53NWQ`) or full seller profile URLs.\nFind a seller ID on any product page β†’ \"Sold by …\" β†’ click β†’ copy `?seller=` value.", "items": { "type": "string" } }, "includeSellerReviews": { "title": "πŸ’¬ Include individual seller feedback", "type": "boolean", "description": "Embed individual customer feedback rows (rating + text + reviewer + date) into the seller record under `reviews: [...]`. Each embedded feedback row is charged as one `review` event ($0.0015).", "default": false }, "maxSellerReviews": { "title": "πŸ”’ Max seller-feedback rows", "minimum": 0, "type": "integer", "description": "Cap on individual feedback rows fetched per seller (paginated via `&page=N`). 0 = no limit. Default 10 β‰ˆ one page.", "default": 10 }, "offerAsins": { "title": "πŸ’² Product URLs or ASINs for offers", "type": "array", "description": "One per line. Returns every seller / condition / price for the ASIN.", "items": { "type": "string" } }, "offerCondition": { "title": "🏷️ Condition filter", "enum": [ "all", "new", "used", "refurbished", "collectible" ], "type": "string", "description": "Limit offers by item condition.", "default": "all" }, "maxItemsPerInput": { "title": "πŸ”’ Max items per input", "minimum": 0, "type": "integer", "description": "Global cap per keyword / category URL. 0 = unlimited (Amazon will still cap at ~20 pages Γ— 24 β‰ˆ 480 organic).", "default": 100 }, "marketplace": { "title": "🌍 Marketplace", "enum": [ "com", "co.uk", "de", "fr", "it", "es", "nl", "se", "pl", "ca", "com.mx", "com.br", "co.jp", "in", "com.au", "sg", "ae", "sa", "com.tr" ], "type": "string", "description": "Default Amazon domain. Bare ASINs/seller IDs go here. Full URLs override.", "default": "com" }, "maxConcurrency": { "title": "⚑ Max concurrent requests", "minimum": 1, "maximum": 20, "type": "integer", "description": "Higher = faster but more proxy IPs needed. Default 4 is safe for residential proxies.", "default": 4 } } }, "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 } } } } } } } } } }