{
"openapi": "3.0.1",
"info": {
"title": "Amazon Search Scraper & Keyword Rank Tracker - Organic Rank",
"description": "Amazon search scraper and keyword rank tracker for sellers: organic rank and page position of every ASIN for any keyword, plus price, list price, discount, rating, ratings count, bought in past month, badges and sponsored flag. 21 marketplaces in local currency. Schedule it for daily rank checks.",
"version": "0.1",
"x-build-id": "eJSFW25YPJXIbiDDz"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/lergassy~amazon-search-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-lergassy-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/lergassy~amazon-search-scraper/runs": {
"post": {
"operationId": "runs-sync-lergassy-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/lergassy~amazon-search-scraper/run-sync": {
"post": {
"operationId": "run-sync-lergassy-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 search per line — yoga mat, wireless earbuds. Each search returns up to 'Products per search' rows.",
"items": {
"type": "string"
}
},
"marketplace": {
"title": "🌍 Amazon marketplace",
"enum": [
"US",
"UK",
"DE",
"FR",
"IT",
"ES",
"NL",
"BE",
"SE",
"PL",
"TR",
"CA",
"MX",
"BR",
"AU",
"JP",
"IN",
"SG",
"AE",
"SA",
"EG"
],
"type": "string",
"description": "Which Amazon site to search. Prices come in that site's own currency.",
"default": "US"
},
"maxItemsPerQuery": {
"title": "📦 Products per search",
"minimum": 1,
"maximum": 10000,
"type": "integer",
"description": "Amazon shows 16–60 products per page; the Actor walks the pages until it has this many or Amazon runs out (usually 7–20 pages).",
"default": 48
},
"sortBy": {
"title": "↕️ Sort",
"enum": [
"featured",
"price_asc",
"price_desc",
"reviews",
"newest",
"bestsellers"
],
"type": "string",
"description": "Applied to keyword searches. Search URLs keep their own sort.",
"default": "featured"
},
"minPrice": {
"title": "💲 Minimum price",
"type": "number",
"description": "Whole units of the marketplace currency. Leave empty for no floor. If it is above the maximum, the two are swapped."
},
"maxPrice": {
"title": "💲 Maximum price",
"type": "number",
"description": "Whole units of the marketplace currency. Leave empty for no ceiling."
},
"includeSponsored": {
"title": "📣 Include sponsored products",
"type": "boolean",
"description": "Sponsored placements are skipped by default and never charged. Turn on to keep them — rows carry isSponsored = true and their page position, which is what an ad-share study needs.",
"default": false
},
"startUrls": {
"title": "🔗 Amazon search URLs",
"type": "array",
"description": "Paste search or category result URLs (amazon.com/s?k=… with any filters) instead of keywords. The marketplace is taken from the URL.",
"default": [],
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Off by default and included in the price. amazon.com answers a direct request; other marketplaces start on a residential address in their own country, so prices and delivery are the ones a local shopper sees. A page that comes back as a robot check is retried on other addresses automatically, with a web unblocker as the last step.",
"default": {
"useApifyProxy": 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
}
}
}
}
}
}
}
}
}
}