{
"openapi": "3.0.1",
"info": {
"title": "Amazon Product Search & Bestsellers Scraper",
"description": "Scrape Amazon search results, Best Sellers and New Releases by keyword or URL on 7 marketplaces: ASIN, title, price, list price, rating, reviews, badges, sponsored flag, position, Prime and delivery. On amazon.com: ASIN lookups, product details, ZIP pricing. No browser needed, pay per result.",
"version": "0.1",
"x-build-id": "bvzuXwPRAayZVzgbA"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/xmolodtsov~amazon-search-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-xmolodtsov-amazon-search-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/xmolodtsov~amazon-search-scraper/runs": {
"post": {
"operationId": "runs-sync-xmolodtsov-amazon-search-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/xmolodtsov~amazon-search-scraper/run-sync": {
"post": {
"operationId": "run-sync-xmolodtsov-amazon-search-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": "What you would type into the Amazon search box, one per line. Each keyword is searched on the marketplace selected below.",
"items": {
"type": "string"
}
},
"categoryOrProductUrls": {
"title": "Search, category, Best Sellers or product URLs",
"type": "array",
"description": "Amazon URLs to scrape: search result pages (/s?k=…), category pages (/b?node=…, /s?i=…&rh=n:…), Best Sellers (/gp/bestsellers/…, /zgbs/…) and New Releases lists, and product pages (/dp/ASIN, amazon.com). The marketplace is taken from the URL.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"asins": {
"title": "ASINs (product details)",
"type": "array",
"description": "Amazon product IDs to scrape full product pages for, e.g. B078NN17K3. amazon.com only, so keep the marketplace on amazon.com. Each product is charged as one result plus the product details add-on.",
"items": {
"type": "string"
}
},
"marketplace": {
"title": "Marketplace for keywords",
"enum": [
"amazon.com",
"amazon.co.uk",
"amazon.de",
"amazon.fr",
"amazon.it",
"amazon.es",
"amazon.ca"
],
"type": "string",
"description": "Which Amazon site keywords and ASINs are looked up on. URLs always use their own domain.",
"default": "amazon.com"
},
"sort": {
"title": "Sort search results by",
"enum": [
"relevanceblender",
"price-asc-rank",
"price-desc-rank",
"review-rank",
"date-desc-rank",
"exact-aware-popularity-rank"
],
"type": "string",
"description": "Amazon's own sort order for keyword searches (and search URLs that don't already set one).",
"default": "relevanceblender"
},
"zipCode": {
"title": "US delivery ZIP code (amazon.com)",
"pattern": "^(\\d{5})?$",
"type": "string",
"description": "Optional. Amazon shows prices, availability and delivery dates for a delivery location. Set a 5-digit US ZIP code (e.g. 10001) to see amazon.com results as a shopper there would. Left empty, Amazon picks a US location itself."
},
"maxItemsPerStartUrl": {
"title": "Max results per keyword or URL",
"minimum": 1,
"maximum": 10000,
"type": "integer",
"description": "Stop after this many products for each keyword or URL. Best Sellers lists end at rank 100. A plain keyword search ends at about 300 results — Amazon's own limit; add a category URL (/s?k=…&i=…) to go deeper. Free Apify plan: a run returns at most 10 results in total, whatever this value (a limit set by the developer, not by Apify).",
"default": 100
},
"maxSearchPagesPerStartUrl": {
"title": "Max search pages per keyword or URL",
"minimum": 1,
"maximum": 400,
"type": "integer",
"description": "Upper bound on result pages fetched per keyword or URL (16–60 products per page, depending on the layout Amazon serves).",
"default": 400
},
"includeSponsored": {
"title": "Include sponsored results",
"type": "boolean",
"description": "Keep sponsored (ad) cards. They are flagged with isSponsored either way.",
"default": true
},
"scrapeProductDetails": {
"title": "Scrape product details",
"type": "boolean",
"description": "Also open every product's page and add its full details: features, description, all images, seller, Best Sellers ranks, variants, stock and delivery. Charged as the product details add-on for each product enriched. amazon.com only; other marketplaces return listing data.",
"default": false
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Optional. By default the scraper picks the right Apify Proxy exit for each marketplace — you don't need to configure anything."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}