{
"openapi": "3.0.1",
"info": {
"title": "Amazon Search Or Category Scrapper",
"description": "Scrape Amazon search results and category pages with ease. Extract product titles, prices, ratings, reviews, ASINs, images, URLs, and other key product details in structured JSON.",
"version": "0.0",
"x-build-id": "jCEnm3hLHqVsGJ4UB"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/sigma-dev~amazon-search-or-category-scrapper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-sigma-dev-amazon-search-or-category-scrapper",
"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/sigma-dev~amazon-search-or-category-scrapper/runs": {
"post": {
"operationId": "runs-sync-sigma-dev-amazon-search-or-category-scrapper",
"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/sigma-dev~amazon-search-or-category-scrapper/run-sync": {
"post": {
"operationId": "run-sync-sigma-dev-amazon-search-or-category-scrapper",
"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": {
"searchKeywords": {
"title": "Search keywords",
"type": "array",
"description": "Keywords to search for on Amazon, e.g. wireless mouse. Each keyword is a separate search on the marketplace selected below.",
"items": {
"type": "string"
}
},
"marketplace": {
"title": "Marketplace for keyword searches",
"enum": [
"amazon.com",
"amazon.co.uk",
"amazon.de",
"amazon.fr",
"amazon.it",
"amazon.es",
"amazon.nl",
"amazon.com.be",
"amazon.ie",
"amazon.se",
"amazon.pl",
"amazon.com.tr",
"amazon.ca",
"amazon.com.mx",
"amazon.com.br",
"amazon.in",
"amazon.co.jp",
"amazon.com.au",
"amazon.sg",
"amazon.ae",
"amazon.sa",
"amazon.eg",
"amazon.co.za"
],
"type": "string",
"description": "Amazon website used for the search keywords. Start URLs always use their own domain.",
"default": "amazon.com"
},
"startUrls": {
"title": "Start URLs",
"type": "array",
"description": "Amazon pages to scrape:- Search results, e.g.
https://www.amazon.com/s?k=laptop - Categories, e.g.
https://www.amazon.com/b?node=172282 or any /s?rh=n:… link - Best Sellers, New Releases, Movers & Shakers, Most Wished For and Gift Ideas lists, e.g.
https://www.amazon.com/gp/bestsellers/electronics
Product detail pages are not supported.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"sortBy": {
"title": "Sort by",
"enum": [
"relevanceblender",
"price-asc-rank",
"price-desc-rank",
"review-rank",
"date-desc-rank",
"exact-aware-popularity-rank"
],
"type": "string",
"description": "Sort order for keyword searches and category listings. Ignored for URLs that already contain a sort order and for Best Sellers lists.",
"default": "relevanceblender"
},
"minPrice": {
"title": "Minimum price",
"minimum": 0,
"type": "integer",
"description": "Only return products priced at or above this amount, in whole units of the marketplace currency (e.g. 20 = $20 on amazon.com). Applies to keyword searches and category listings."
},
"maxPrice": {
"title": "Maximum price",
"minimum": 0,
"type": "integer",
"description": "Only return products priced at or below this amount, in whole units of the marketplace currency."
},
"includeSponsored": {
"title": "Include sponsored products",
"type": "boolean",
"description": "Keep sponsored (advertised) products in the results. They are always marked with isSponsored: true.",
"default": true
},
"language": {
"title": "Language",
"pattern": "^([a-z]{2}_[A-Z]{2})?$",
"type": "string",
"description": "Optional page language in the form xx_XX, e.g. en_GB to get amazon.de in English or es_US for amazon.com in Spanish. Leave empty for the marketplace default."
},
"maxItemsPerSource": {
"title": "Max results per keyword or URL",
"minimum": 0,
"type": "integer",
"description": "Maximum number of products saved for each keyword and each start URL. 0 means no limit.",
"default": 100
},
"maxPagesPerSource": {
"title": "Max pages per keyword or URL",
"minimum": 1,
"maximum": 400,
"type": "integer",
"description": "Maximum number of result pages visited for each keyword and each start URL. Amazon shows up to 20 pages for keyword searches (often only 7) and up to 400 pages for categories. Best Sellers lists have 2 pages of 50 products.",
"default": 20
},
"maxItems": {
"title": "Max results in total",
"minimum": 0,
"type": "integer",
"description": "Stop the whole run after saving this many products across all keywords and URLs. 0 means no limit.",
"default": 0
},
"deduplicateItems": {
"title": "Remove duplicate products",
"type": "boolean",
"description": "Save each product at most once per keyword or URL (Amazon sometimes repeats products on later pages). A sponsored and an organic placement of the same product are both kept.",
"default": true
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Amazon blocks datacenter IPs quickly, so Residential proxies are recommended. If you don't select a country, every marketplace is loaded through proxies from its own country, so prices and delivery information match that marketplace.",
"default": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
]
}
},
"maxConcurrency": {
"title": "Max concurrency",
"minimum": 1,
"maximum": 50,
"type": "integer",
"description": "Maximum number of pages loaded in parallel. Higher values are faster but more likely to be blocked.",
"default": 10
},
"maxRequestRetries": {
"title": "Max request retries",
"minimum": 0,
"maximum": 10,
"type": "integer",
"description": "How many times a page that failed with an error is retried. Pages blocked by Amazon are additionally retried up to 10 times, each time with a new IP address.",
"default": 5
},
"debugSaveHtml": {
"title": "Save HTML of problematic pages",
"type": "boolean",
"description": "Store the HTML of blocked, empty or failed pages in the key-value store (up to 30 pages) to help with debugging.",
"default": false
}
}
},
"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
}
}
}
}
}
}
}
}
}
}