{
"openapi": "3.0.1",
"info": {
"title": "Amazon Product Scraper",
"description": "Scrape Amazon by ASIN, product link, search or category link, or keyword, across 11 marketplaces. ASIN, title, price, list price and discount, rating, reviews and badges; lookups add stock, bullets and Best Sellers Rank. Local-currency prices. No seller names, ever.",
"version": "0.1",
"x-build-id": "PmunFwA552cSQIFQH"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/lowlanddata~amazon-product-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-lowlanddata-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/lowlanddata~amazon-product-scraper/runs": {
"post": {
"operationId": "runs-sync-lowlanddata-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/lowlanddata~amazon-product-scraper/run-sync": {
"post": {
"operationId": "run-sync-lowlanddata-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": {
"keywords": {
"title": "Search keywords",
"type": "string",
"description": "What to search for, exactly as you would type it into Amazon's search box. Ignored when you fill in Amazon links or ASINs below."
},
"moreKeywords": {
"title": "More search keywords",
"type": "array",
"description": "More searches in the same run, one per line, with the same marketplace and filters. A product found by two searches comes back once. Up to 50.",
"items": {
"type": "string"
}
},
"startUrls": {
"title": "Amazon links",
"type": "array",
"description": "Paste links copied from Amazon. Product links (they contain /dp/) open that product. Search or category results links scrape that results page with every filter you set on Amazon. The Amazon site is taken from each link, so links from different countries can share a run. Best-seller lists are not supported. Up to 500.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"asins": {
"title": "ASINs",
"type": "array",
"description": "Look up products by ASIN, the 10-character product code in every Amazon product link (for example B07QPS7L6Y), on the marketplace chosen below. Each ASIN opens its product page, so it costs a row plus a product page. Up to 500.",
"items": {
"type": "string"
}
},
"listingIds": {
"title": "Specific product IDs",
"type": "array",
"description": "The same as ASINs, under the name the other scrapers of this family use for re-checking known items: one ASIN per line, looked up on the marketplace chosen below. Use whichever of the two fields your workflow already fills in; both lists are read.",
"items": {
"type": "string"
}
},
"marketplace": {
"title": "Marketplace",
"enum": [
"de",
"uk",
"fr",
"it",
"es",
"nl",
"se",
"pl",
"be",
"us",
"ca"
],
"type": "string",
"description": "Which Amazon site to use for keywords and ASINs. Links always use their own site. Prices and availability differ per marketplace.",
"default": "de"
},
"minPrice": {
"title": "Minimum price",
"minimum": 0,
"type": "integer",
"description": "Keyword searches only: products at or above this price, in the marketplace's currency."
},
"maxPrice": {
"title": "Maximum price",
"minimum": 0,
"type": "integer",
"description": "Keyword searches only: products at or below this price, in the marketplace's currency."
},
"primeOnly": {
"title": "Prime only",
"type": "boolean",
"description": "Keyword searches only: products available with Prime delivery.",
"default": false
},
"sortBy": {
"title": "Sort by",
"enum": [
"relevance",
"price-asc",
"price-desc",
"newest",
"reviews"
],
"type": "string",
"description": "Keyword searches only: how Amazon should order the results. A pasted results link keeps its own order."
},
"skipSponsored": {
"title": "Skip sponsored placements",
"type": "boolean",
"description": "Searches and results links: leave out paid placements and keep only organic results.",
"default": false
},
"scrapeDetails": {
"title": "Fetch full product details for search results",
"type": "boolean",
"description": "Searches and results links: also open each product page for stock, feature bullets, category and Best Sellers Rank. A product page is about 25x the traffic of a search result, so it is charged as its own event and is off by default. Products from links or ASINs always come with these details. The product page also carries every photo, delivered as imageUrls.",
"default": false
},
"maxItems": {
"title": "Maximum products",
"minimum": 1,
"maximum": 100000,
"type": "integer",
"description": "Stop after this many products in the whole run. Lookups come first; searches share what is left equally.",
"default": 200
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Amazon quotes prices in the currency of the country the request comes from, so the run pins a residential session to each marketplace's own country - amazon.de from Germany, amazon.co.uk from the UK. Leave this as it is: a custom proxy without that country targeting can return prices converted into another currency.",
"default": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
]
}
}
}
},
"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
}
}
}
}
}
}
}
}
}
}