{
"openapi": "3.0.1",
"info": {
"title": "Amazon Search Scraper",
"description": "This Amazon Search Scraper allows you to scrape the products on Amazon. It extracts data from Amazon search pages in structured formats such as JSON, XML, CSV, or Excel.",
"version": "1.0",
"x-build-id": "R1epedHwHWFP7VnCl"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/amazon-scraper~amazon-search-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-amazon-scraper-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/amazon-scraper~amazon-search-scraper/runs": {
"post": {
"operationId": "runs-sync-amazon-scraper-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/amazon-scraper~amazon-search-scraper/run-sync": {
"post": {
"operationId": "run-sync-amazon-scraper-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": {
"searchUris": {
"title": "Search URIs",
"minItems": 1,
"type": "array",
"description": "Amazon search URIs such as /s?k=shoes or full Amazon search URLs. Full URLs must use one supported marketplace and override Amazon domain for every search in the run, including relative URIs. URLs from multiple marketplaces are rejected. Delivery postcode, locality, country, and page language are checked against the resolved marketplace.
Each entry must include k= (keywords), mltAsin= (More like this ASIN), or a nonempty rh= (refinements). Refinement-only searches do not need keywords. Entries may also include department, collection, or sorting. When mltAsin is present and searchMethod is omitted, searchMethod=MLTSearch is added automatically.
Keywords support Chinese, Japanese, and other Unicode characters.
All searches start at page 1. The page language is set automatically from the marketplace domain. Surrounding whitespace is trimmed and equivalent requests are deduplicated. Invalid entries stop the run before searching.",
"items": {
"type": "string",
"pattern": "^\\s*(?:[hH][tT][tT][pP][sS]?://(?:[wW]{3}\\.)?[aA][mM][aA][zZ][oO][nN]\\.(?:[aA][eE]|[cC][oO][mM]\\.[aA][uU]|[cC][oO][mM]\\.[bB][eE]|[cC][oO][mM]\\.[bB][rR]|[cC][aA]|[dD][eE]|[eE][gG]|[eE][sS]|[fF][rR]|[cC][oO]\\.[uU][kK]|[iI][eE]|[iI][nN]|[iI][tT]|[cC][oO]\\.[jJ][pP]|[cC][oO][mM]\\.[mM][xX]|[nN][lL]|[pP][lL]|[sS][aA]|[sS][eE]|[sS][gG]|[cC][oO][mM]\\.[tT][rR]|[cC][oO][mM]))?/(?:-/[a-z]{2}/)?s(/[^?#]*)?\\?[^#]*(k=|mltAsin=|rh=)"
}
},
"domain": {
"title": "Amazon domain",
"enum": [
"amazon.com.au",
"amazon.ca",
"amazon.de",
"amazon.es",
"amazon.fr",
"amazon.co.uk",
"amazon.in",
"amazon.it",
"amazon.co.jp",
"amazon.com",
"amazon.com.mx",
"amazon.com.br",
"amazon.ae",
"amazon.sa",
"amazon.nl",
"amazon.sg",
"amazon.se",
"amazon.pl",
"amazon.com.tr",
"amazon.com.be",
"amazon.ie",
"amazon.eg"
],
"type": "string",
"description": "Amazon marketplace used when all searchUris entries are relative paths. Values omit www. If any entry is a full Amazon search URL, its marketplace overrides this setting for the entire run. Full URLs must use one marketplace; delivery settings are checked against that marketplace.",
"default": "amazon.com"
},
"device": {
"title": "Device",
"enum": [
"desktop",
"mobile"
],
"type": "string",
"description": "Choose desktop or phone search pages.
More like this URIs use mobile for their own tasks.
Mobile requests Android Chrome phone pages; tablets and iPads are not supported. Available fields may differ.
Custom delivery destinations are supported for both desktop and phone searches.",
"default": "desktop"
},
"maxResultsPerQuery": {
"title": "Max results per search URI",
"minimum": 10,
"maximum": 20000,
"type": "integer",
"description": "Maximum product records to save for each unique search URI in searchUris, from 10 through 20000.
The limit applies separately to each search across all its pages. Results are saved in page order; the last page may be cut short.
Pagination follows Amazon's next-page links without a fixed device page limit. Fewer records may be available if Amazon provides no next page, a page cannot be collected, or the run's budget is reached.",
"default": 100
},
"deliveryZipCode": {
"title": "Delivery postcode",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*(?![\\s\\S])",
"type": "string",
"description": "Enter one complete domestic postcode string for the selected Amazon marketplace and omit deliveryCountryCode.
US, DE, ES, FR, IT, MX, TR: 5 digits (32063, 10115, 08001, 75001, 00118);
IN, SG: 6 digits (110001, 018956);
BR: 01001-000 or 01001000;
SE: 111 22 or 11122;
PL: 00-001 or 00001;
CA: M5V 2T6 or M5V2T6;
GB: complete postcode SW1A 1AA or SW1A1AA;
JP: 100-0001 or 1000001.
Use ASCII characters and preserve leading zeros. CA/GB letters are case-insensitive; CA inserts a space, GB removes it, and JP inserts a hyphen for submission. BR removes the optional hyphen; PL inserts a hyphen after two digits; SE inserts a space after three digits.
Supply one string even if Amazon shows two postcode boxes; do not append a city name to the postcode. US ZIP+4 is not supported.
If deliveryZipCode and deliveryCountryCode are both supplied, this postcode takes priority and deliveryCountryCode is ignored; this is not an international postcode. An invalid postcode is rejected without falling back to the country code.
For Australia, use a four-digit postcode and supply deliveryLocality, such as 2000 and SYDNEY.
Custom postcodes are unavailable on AE, NL, SA, IE, EG, and BE. Use deliveryLocality for domestic city or region selection on AE, SA, and EG. On NL, IE, and BE, omit deliveryZipCode to use Amazon's returned destination.
Custom delivery is available with device=desktop or device=mobile."
},
"deliveryLocality": {
"title": "Delivery city or region",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*(?![\\s\\S])",
"type": "string",
"description": "Enter the domestic city or region name for AU, EG, SA, or AE.
AU: city or suburb with a four-digit deliveryZipCode, such as SYDNEY with 2000.
EG: the Governorate name displayed by Amazon, such as Cairo or Giza.
SA: city name, such as Riyadh or Jeddah.
AE: city name, such as Abu Dhabi or Dubai; no Area is required.
On EG, SA, and AE, omit deliveryZipCode and any foreign deliveryCountryCode. Surrounding whitespace is normalized; AU city names are uppercased. Unsupported or unknown names are rejected.
Omit for other marketplaces and international delivery. Custom delivery is available with device=desktop or device=mobile."
},
"deliveryCountryCode": {
"title": "Delivery country",
"pattern": "^[A-Z]{2}(?![\\s\\S])",
"type": "string",
"description": "Enter exactly two uppercase letters for the delivery country or region, such as SG for Singapore or NZ for New Zealand; see the country/region mapping table in the README.
For international delivery, omit deliveryZipCode and deliveryLocality. The destination must be offered by the selected marketplace; AU offers NZ, NL offers BE, and AE offers BH, KW, OM, QA, and SA. CA, IN, MX, BR, SG, SE, PL, TR, SA, IE, EG, and BE have no configured international destinations. Use deliveryLocality for domestic cities or regions on SA, EG, and AE. IE and BE retain the destination returned by Amazon.
If deliveryZipCode is supplied, it takes priority and this country code is ignored. Omission uses the marketplace country.
Custom destinations are supported for both desktop and mobile searches."
},
"proxyCountry": {
"title": "Proxy country",
"enum": [
"auto",
"AD",
"AE",
"AF",
"AL",
"AM",
"AO",
"AR",
"AT",
"AU",
"AZ",
"BA",
"BD",
"BE",
"BG",
"BH",
"BI",
"BM",
"BN",
"BO",
"BR",
"BS",
"BT",
"BV",
"BY",
"BZ",
"CA",
"CD",
"CG",
"CH",
"CI",
"CL",
"CN",
"CO",
"CR",
"CU",
"CY",
"CZ",
"DE",
"DK",
"DO",
"DZ",
"EC",
"EE",
"EG",
"ES",
"ET",
"FI",
"FR",
"GA",
"GB",
"GE",
"GG",
"GH",
"GL",
"GM",
"GR",
"GT",
"HK",
"HR",
"HT",
"HU",
"ID",
"IE",
"IL",
"IM",
"IN",
"IQ",
"IR",
"IS",
"IT",
"JE",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LI",
"LK",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MK",
"MM",
"MN",
"MO",
"MR",
"MT",
"MU",
"MX",
"MY",
"NG",
"NL",
"NO",
"NP",
"NZ",
"OM",
"PA",
"PE",
"PG",
"PH",
"PK",
"PL",
"PR",
"PS",
"PT",
"PY",
"QA",
"RO",
"RS",
"RU",
"SA",
"SC",
"SE",
"SG",
"SI",
"SK",
"SV",
"SY",
"TD",
"TH",
"TJ",
"TN",
"TR",
"TT",
"TW",
"UA",
"UG",
"US",
"UY",
"UZ",
"VE",
"VI",
"VN",
"XK",
"ZA",
"ZM"
],
"type": "string",
"description": "Auto uses the marketplace country, independently of delivery. Choose a routing country; availability is checked when the run starts.",
"default": "auto"
}
}
},
"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
}
}
}
}
}
}
}
}
}
}