{
"openapi": "3.0.1",
"info": {
"title": "Amazon Search Results Scraper - Product Search & Keyword Rank",
"description": "Amazon search results as flat rows from keywords or search links: rank and organic rank, price, list price, rating, reviews, bought in past month, Prime, Best Seller, Amazon's Choice and sponsored flags. amazon.com. $1 per 1,000 results + $0.001/run, usage included.",
"version": "0.1",
"x-build-id": "dIeYSx0MSQTWbA1an"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/tagadanar~amazon-search-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-tagadanar-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/tagadanar~amazon-search-scraper/runs": {
"post": {
"operationId": "runs-sync-tagadanar-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/tagadanar~amazon-search-scraper/run-sync": {
"post": {
"operationId": "run-sync-tagadanar-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": "One keyword per line, exactly what you would type into Amazon's search box, e.g. wireless mouse. Each keyword is its own search, and every row says which keyword found it and at what rank.",
"items": {
"type": "string"
}
},
"searchUrls": {
"title": "Amazon search links",
"type": "array",
"description": "Search result pages copied from your browser, e.g. https://www.amazon.com/s?k=usb+c+hub&rh=n%3A172282. The link keeps every filter, department and sort you picked on Amazon, and its own Amazon site. Product pages (/dp/…) are not search pages and are skipped.",
"items": {
"type": "string"
}
},
"marketplace": {
"title": "Amazon site",
"enum": [
"com"
],
"type": "string",
"description": "Which Amazon site the keywords are searched on. Search links keep their own site.",
"default": "com"
},
"sort": {
"title": "Sort by",
"enum": [
"relevance",
"price-asc",
"price-desc",
"avg-review",
"newest",
"best-sellers"
],
"type": "string",
"description": "Amazon's own sort order for keyword searches. Search links keep the sort they carry.",
"default": "relevance"
},
"maxResultsPerSearch": {
"title": "Max results per search",
"minimum": 1,
"maximum": 1000,
"type": "integer",
"description": "Stop each keyword or link after this many results. You pay per result delivered, never per page read.",
"default": 50
},
"maxPagesPerSearch": {
"title": "Max result pages per search",
"minimum": 1,
"maximum": 20,
"type": "integer",
"description": "How deep to page through each search. Amazon itself stops at page 20 however many results it advertises, so 20 is the maximum, and the run stops at the last page Amazon actually offers.",
"default": 20
},
"minPrice": {
"title": "Minimum price",
"minimum": 0,
"type": "integer",
"description": "Only keep results priced at or above this, in US dollars. Sent to Amazon as its own price filter and checked again on every row; results with no price on the card are left out when a price range is set."
},
"maxPrice": {
"title": "Maximum price",
"minimum": 0,
"type": "integer",
"description": "Only keep results priced at or below this, in US dollars. Leave empty for no limit."
},
"minRating": {
"title": "Minimum star rating",
"enum": [
"4.5",
"4",
"3",
"2",
"1"
],
"type": "string",
"description": "Only keep results rated at least this many stars. Unrated results are left out when this is set."
},
"primeOnly": {
"title": "Prime only",
"type": "boolean",
"description": "Only keep results that show the Prime badge.",
"default": false
},
"includeSponsored": {
"title": "Include sponsored results",
"type": "boolean",
"description": "Sponsored (ad) slots are delivered and flagged sponsored: true. Turn this off to keep organic results only. Either way each row carries its organic rank.",
"default": true
}
}
},
"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
}
}
}
}
}
}
}
}
}
}