{ "openapi": "3.0.1", "info": { "title": "Amazon Scraper: Products, Search Results & Best Sellers", "description": "Scrape Amazon products by URL, ASIN or keyword, search results and Best Seller lists on any marketplace: price, rating and star breakdown, reviews count, Best Sellers Rank, specs, images, variants, seller, delivery for your ZIP and seller offers. No login, no browser.", "version": "0.2", "x-build-id": "3TCdJieXBnc0PJWF5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/deepmine~amazon-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-deepmine-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/deepmine~amazon-scraper/runs": { "post": { "operationId": "runs-sync-deepmine-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/deepmine~amazon-scraper/run-sync": { "post": { "operationId": "run-sync-deepmine-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": { "categoryOrProductUrls": { "title": "πŸ”— Amazon URLs (products, searches, best sellers)", "type": "array", "description": "Product pages (amazon.com/dp/B0…), search results with any filters (amazon.com/s?k=keyboard), category pages (amazon.com/b?node=…) and ranked lists: Best Sellers, New Releases, Movers & Shakers. Any Amazon marketplace.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "keywords": { "title": "πŸ” Search keywords", "type": "array", "description": "Searched on the marketplace set under More inputs, like an amazon.com/s?k=… URL, e.g. usb c cable.", "items": { "type": "string" } }, "maxItemsPerStartUrl": { "title": "πŸ“Š Max products per URL or keyword", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Each search or ranked list stops after this many products (a Best Seller list has 100). A product URL always gives one. Products found twice count once.", "default": 100 }, "scrapeProductDetails": { "title": "πŸ“ Full product details", "type": "boolean", "description": "On: open every product found and return the full row (specs, Best Sellers Rank, features, images, variants, seller, delivery). Off: only what the list shows (title, price, rating, reviews, image, position), much faster. Same price.", "default": true }, "maxOffers": { "title": "πŸ›οΈ Seller offers per product ($)", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Also list up to this many seller offers per product (price, condition, seller, ships from, delivery) in the Offers dataset, charged per offer. 0 = none.", "default": 0 }, "scrapeSellers": { "title": "πŸͺ Seller profiles ($)", "type": "boolean", "description": "Also read each seller's Amazon profile (business name, address, phone, storefront, ratings over 30 days, 90 days, 12 months and lifetime) for the buy box seller and, with offers on, every offer's seller: one row per seller in the Sellers dataset, and the profile on their product and offer rows. Charged once per seller per run, however many products it sells. Amazon itself is never charged.", "default": false }, "asins": { "title": "πŸ†” ASINs", "type": "array", "description": "Product IDs (10 characters, e.g. B0DCH8VDXF), looked up on the marketplace below.", "items": { "type": "string" } }, "domain": { "title": "🌍 Marketplace for ASINs and keywords", "pattern": "^\\s*(https?://)?((www|smile|m)\\.)?amazon\\.[a-z.]{2,8}/?\\s*$", "type": "string", "description": "The Amazon site ASINs and keywords are looked up on. Pick one, or type a host such as amazon.de or www.amazon.de.", "default": "www.amazon.com" }, "zipCode": { "title": "πŸ“ Delivery postcode", "type": "string", "description": "Read prices and delivery for this postcode, e.g. 10001 (amazon.com) or 10115 (amazon.de). Empty = each marketplace's capital; amazon.com uses the proxy's US location. The run stops if Amazon rejects it." }, "countryCode": { "title": "🌐 Deliver to country", "type": "string", "description": "Two-letter country to deliver to, for international shipping prices, e.g. DE on amazon.com. Empty = the marketplace's own country. Not used with a postcode." }, "maxProductVariantsAsSeparateResults": { "title": "🎨 Variants as separate products", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Also return up to this many variants (sizes, colors…) of each product as their own rows, each with its own price and stock, on top of Max products. Every row already lists its variant ASINs. 0 = none.", "default": 0 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave as is: Apify datacenter proxies work for Amazon. Residential is replaced by datacenter (it costs more per page than a product row earns).", "default": { "useApifyProxy": true } }, "maxSearchPagesPerStartUrl": { "title": "Max search pages per URL", "minimum": 1, "maximum": 9999, "type": "integer", "description": "Kept for saved junglee/Amazon-crawler inputs: searches stop at Max products anyway.", "default": 9999 }, "maxConcurrency": { "title": "Concurrency", "minimum": 1, "maximum": 32, "type": "integer", "description": "Engine setting.", "default": 12 }, "language": { "title": "Language", "type": "string", "description": "Kept for saved junglee/Amazon-crawler inputs: rows are read from Amazon's English pages." }, "scrapeProductVariantPrices": { "title": "Variant prices", "type": "boolean", "description": "Kept for saved junglee/Amazon-crawler inputs: not used (see Variants as separate products)." }, "useCaptchaSolver": { "title": "Captcha solver", "type": "boolean", "description": "Kept for saved junglee/Amazon-crawler inputs: not needed (a refused page is retried on a new IP)." }, "proxyCountry": { "title": "Proxy country", "type": "string", "description": "Kept for saved junglee/Amazon-crawler inputs: not used (see Delivery location)." } } }, "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 } } } } } } } } } }