{
"openapi": "3.0.1",
"info": {
"title": "Amazon Search Scraper",
"description": "Amazon search results for any keyword or search link on 20+ marketplaces: organic and sponsored position, ASIN, title, price, list price, rating, reviews, badges (Best Seller, Amazon's Choice), bought in past month, Prime and delivery, coupons, deals. No login, pay per product.",
"version": "1.0",
"x-build-id": "megmEcG0dl1TPsovt"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/steadyscrape~amazon-search-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-steadyscrape-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/steadyscrape~amazon-search-scraper/runs": {
"post": {
"operationId": "runs-sync-steadyscrape-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/steadyscrape~amazon-search-scraper/run-sync": {
"post": {
"operationId": "run-sync-steadyscrape-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",
"required": [
"keywords"
],
"properties": {
"keywords": {
"title": "Keywords or search links",
"type": "array",
"description": "One search per line: a keyword (wireless earbuds) searched on the marketplace below, or a link to any Amazon search results page (https://www.amazon.co.uk/s?k=desk+lamp&rh=p_72%3A419153031) taken as it is, with its own marketplace, department, sort and filters. Any filter Amazon offers (price range, brand, rating, Prime) works: apply it on Amazon and paste the link.",
"items": {
"type": "string"
}
},
"marketplace": {
"title": "Marketplace for keywords",
"enum": [
"com",
"ca",
"com.mx",
"com.br",
"co.uk",
"de",
"fr",
"it",
"es",
"nl",
"com.be",
"ie",
"se",
"pl",
"com.tr",
"co.jp",
"in",
"com.au",
"sg",
"ae",
"sa",
"eg"
],
"type": "string",
"description": "Where keywords are searched (links carry their own). Measured from Apify's cloud on 2026-10-19: amazon.com, .ca, .com.mx, .com.br, .co.jp and .com.au answered through datacenter proxies; .co.uk, .de, .it, .es and .in through residential proxies of their own country; amazon.fr answered a challenge on every route (a free blocked row).",
"default": "com"
},
"department": {
"title": "Department (optional)",
"type": "string",
"description": "Search one department only, by the alias Amazon puts after i= in a search link: on amazon.com electronics, stripbooks (Books), digital-text (Kindle Store), fashion, beauty, garden (Home & Kitchen), hpc (Health & Household), sporting, toys-and-games, tools, pets, automotive, office-products. Empty: all departments. Applies to keywords only."
},
"sort": {
"title": "Sort by (keywords)",
"enum": [
"relevance",
"price-asc",
"price-desc",
"rating",
"newest",
"best-sellers"
],
"type": "string",
"description": "The order of Amazon's own \"Sort by\" menu. Applies to keywords; a link keeps its own.",
"default": "relevance"
},
"maxResultsPerSearch": {
"title": "Max results per search",
"minimum": 1,
"maximum": 5000,
"type": "integer",
"description": "Stop each search after this many product rows (sponsored ones included unless they are turned off below). Amazon shows 16 to 60 cards a page.",
"default": 100
},
"maxPagesPerSearch": {
"title": "Max pages per search",
"minimum": 1,
"maximum": 50,
"type": "integer",
"description": "The most results pages read per search. Amazon usually ends a search at 7 pages of 48 or 20 of 16; within a department it can go further.",
"default": 5
},
"includeSponsored": {
"title": "Include sponsored results",
"type": "boolean",
"description": "Sponsored product cards come back flagged sponsored: true. Off: they are left out (and not charged), while position still counts them so it matches what a shopper sees.",
"default": true
},
"residentialFallback": {
"title": "Fall back to residential proxies",
"type": "boolean",
"description": "When Amazon refuses the run's own IP and the datacenter proxies, retry through residential proxies of the marketplace's country (included in the price: you pay per product, not per proxy byte). Off: those searches come back with status blocked, unpaid.",
"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
}
}
}
}
}
}
}
}
}
}