{
"openapi": "3.0.1",
"info": {
"title": "Amazon Product Scraper - Prices, Ratings & Search",
"description": "Scrape Amazon search results by keyword or URL in 21 marketplaces: ASIN, title, price, rating, reviews, Prime, Best Seller, sponsored, delivery. No login.",
"version": "1.0",
"x-build-id": "9IYS1QmvQTLJNfOTR"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/cheapapi~amazon-product-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-cheapapi-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/cheapapi~amazon-product-scraper/runs": {
"post": {
"operationId": "runs-sync-cheapapi-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/cheapapi~amazon-product-scraper/run-sync": {
"post": {
"operationId": "run-sync-cheapapi-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",
"properties": {
"searches": {
"title": "Search keywords or Amazon search URLs",
"type": "array",
"description": "What to search on Amazon — one keyword per line (e.g. \"wireless earbuds\"), or paste an Amazon search results URL, including category-filtered searches (e.g. https://www.amazon.com/s?k=headphones&rh=n%3A172282). URL filters and the URL's marketplace are kept. Leave empty if you only want product details by ASIN. A search that returns no products costs the $0.004 \"search checked\" fee.",
"items": {
"type": "string"
}
},
"marketplace": {
"title": "Amazon marketplace",
"enum": [
"US",
"GB",
"DE",
"FR",
"IT",
"ES",
"CA",
"MX",
"BR",
"JP",
"IN",
"AU",
"NL",
"BE",
"PL",
"SE",
"TR",
"SA",
"AE",
"SG",
"EG"
],
"type": "string",
"description": "Which Amazon store to search for keywords. Search URLs always use their own marketplace.",
"default": "US"
},
"maxProductsPerSearch": {
"title": "Max products per search",
"minimum": 1,
"maximum": 700,
"type": "integer",
"description": "How many products to collect for each keyword or URL (in page order, up to 700). You pay for products delivered; a search that delivers no products costs the $0.004 \"search checked\" fee, and above 100 each block of up to 100 returned items that the delivered products don't pay for adds one such fee.",
"default": 100
},
"asins": {
"title": "Product ASINs or URLs",
"type": "array",
"description": "One ASIN (e.g. B0CHX3QBCH) or Amazon product URL (e.g. https://www.amazon.de/dp/B0CHX3QBCH) per line. ASINs use the marketplace selected above; product URLs use their own marketplace. Up to 5,000 per run. Empty by default because every product page is a separate paid event (product details plus one $0.01 batch fee per run), so a plain search run never pays for details you did not ask for. An ASIN without a product page in that marketplace costs the $0.0022 \"ASIN checked\" fee.",
"items": {
"type": "string"
}
},
"includeTopReviews": {
"title": "Include top reviews",
"type": "boolean",
"description": "Add the top reviews shown on the product page (usually up to 10: rating, title, text, date, verified purchase) to each product-details row. No extra charge.",
"default": true
},
"sortBy": {
"title": "Sort by",
"enum": [
"relevance",
"featured",
"priceLowToHigh",
"priceHighToLow",
"avgCustomerReview",
"newestArrivals",
"bestSellers"
],
"type": "string",
"description": "Order of the Amazon results. \"Best sellers\" uses Amazon's best-selling order for your keyword (combine it with a department or a category search URL for a category best-seller list). Empty = Amazon's default order."
},
"minPrice": {
"title": "Minimum price",
"minimum": 0,
"type": "integer",
"description": "Only products that cost at least this much (whole number, in the marketplace currency). Empty = no minimum (no price filter)."
},
"maxPrice": {
"title": "Maximum price",
"minimum": 0,
"type": "integer",
"description": "Only products that cost at most this much (whole number, in the marketplace currency). Empty = no maximum (no price filter)."
},
"department": {
"title": "Department",
"enum": [
"Arts & Crafts",
"Automotive",
"Baby",
"Beauty & Personal Care",
"Books",
"Computers",
"Digital Music",
"Electronics",
"Kindle Store",
"Prime Video",
"Women's Fashion",
"Men's Fashion",
"Girls' Fashion",
"Boys' Fashion",
"Deals",
"Health & Household",
"Home & Kitchen",
"Industrial & Scientific",
"Luggage",
"Movies & TV",
"Music, CDs & Vinyl",
"Pet Supplies",
"Software",
"Sports & Outdoors",
"Tools & Home Improvement",
"Toys & Games",
"Video Games"
],
"type": "string",
"description": "Search only within one Amazon department (category). Empty = all departments."
},
"extraUrlParameters": {
"title": "Extra Amazon URL parameters",
"type": "string",
"description": "For experts: any Amazon search URL parameters, e.g. \"&rh=p_72:1248963011\" (4 stars & up) or \"&i=electronics&bbn=172282\". Sort and price settings above are added automatically."
},
"includeSponsored": {
"title": "Include sponsored products",
"type": "boolean",
"description": "Also return products shown as ads (marked with isSponsored). Turn off to get only regular results. If this removes every product of a search, the search still costs the $0.004 \"search checked\" fee (the search was requested).",
"default": true
},
"includeHighlightedSections": {
"title": "Include highlighted sections",
"type": "boolean",
"description": "Also return products from \"Editorial recommendations\" and \"Top rated from our brands\" blocks on the results page. (Searches whose products are all removed by these filters cost the $0.004 \"search checked\" fee.)",
"default": false
},
"language": {
"title": "Language",
"enum": [
"ar_SA",
"ar_AE",
"zh_CN",
"zh_TW",
"cs_CZ",
"nl_NL",
"en_AU",
"en_CA",
"en_IN",
"en_AE",
"en_GB",
"en_US",
"fr_CA",
"fr_FR",
"de_DE",
"he_IL",
"hi_IN",
"it_IT",
"ja_JP",
"ko_KR",
"pl_PL",
"pt_BR",
"es_MX",
"es_ES",
"es_US",
"sv_SE",
"tr_TR"
],
"type": "string",
"description": "Language of the Amazon page. Empty = the marketplace's main language."
},
"deliveryZipCode": {
"title": "Delivery ZIP / postal code",
"type": "string",
"description": "See prices, availability and delivery dates for a shopper at this ZIP / postal code (e.g. 10001 for New York, SW1A for London). Empty = the whole country."
},
"deliveryCoordinates": {
"title": "Delivery GPS coordinates",
"type": "string",
"description": "Alternative to the ZIP code: \"latitude,longitude\" or \"latitude,longitude,radius\" in meters (min 200), e.g. \"40.7128,-74.0060\"."
},
"locationCode": {
"title": "Location code",
"minimum": 1,
"type": "integer",
"description": "For experts: a numeric location code (country or postal-code level). Overrides ZIP code and marketplace country."
},
"amazonDomain": {
"title": "Amazon domain",
"enum": [
"amazon.com",
"amazon.co.uk",
"amazon.de",
"amazon.fr",
"amazon.it",
"amazon.es",
"amazon.ca",
"amazon.com.mx",
"amazon.com.br",
"amazon.co.jp",
"amazon.in",
"amazon.com.au",
"amazon.nl",
"amazon.com.be",
"amazon.pl",
"amazon.se",
"amazon.com.tr",
"amazon.sa",
"amazon.ae",
"amazon.sg",
"amazon.eg"
],
"type": "string",
"description": "For experts: force a specific Amazon domain. Empty = the marketplace's domain."
},
"maxPagesPerSearch": {
"title": "Max result pages per search",
"minimum": 1,
"maximum": 7,
"type": "integer",
"description": "Maximum number of Amazon result pages to open per search (1–7). Empty = as many as needed to reach \"Max products per search\"."
},
"processingSpeed": {
"title": "Processing speed",
"enum": [
"auto",
"fast",
"economy"
],
"type": "string",
"description": "Automatic: fast for small runs, economy for 30+ searches. Fast: results usually within 1–2 minutes. Economy: can take up to ~45 minutes, used only for runs with 30+ searches. Same price. Product details by ASIN always use standard processing (usually a few minutes).",
"default": "auto"
},
"sendUrlsUnchanged": {
"title": "Send search URLs unchanged",
"type": "boolean",
"description": "For experts: open pasted Amazon URLs exactly as they are instead of converting them into keyword + filters. Language and location in the URL should then match the settings above.",
"default": false
},
"trackChanges": {
"title": "Track price and position changes",
"type": "boolean",
"description": "Remembers the last price and search position of every product (per ASIN, search, marketplace and delivery location) and adds previousPrice, priceChange, previousPosition, positionChange (positive = moved up) and isNew to each row. Schedule the same input daily or weekly to monitor prices and rankings. No extra charge.",
"default": false
},
"trackingName": {
"title": "Tracking name",
"maxLength": 100,
"type": "string",
"description": "Each name keeps its own history. Use one name per list you monitor (e.g. earbuds-us-daily) so separate schedules do not affect each other. Max 100 characters.",
"default": "default"
}
}
},
"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
}
}
}
}
}
}
}
}
}
}