{
"openapi": "3.0.1",
"info": {
"title": "Amazon Scraper - Search Results, Prices & Reviews",
"description": "Scrape Amazon search results by keyword (ASIN, title, price, rating, ratings count, sponsored flag, image, link) with sorting, rating filter and paging, or a product's star histogram and reviews by ASIN. Batch many searches or products. No proxies needed.",
"version": "0.0",
"x-build-id": "oUnWr1gmQS3Jihse7"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/scrapercompany~amazon-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-scrapercompany-amazon-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/scrapercompany~amazon-scraper/runs": {
"post": {
"operationId": "runs-sync-scrapercompany-amazon-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/scrapercompany~amazon-scraper/run-sync": {
"post": {
"operationId": "run-sync-scrapercompany-amazon-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": {
"mode": {
"title": "Mode",
"enum": [
"search",
"reviews"
],
"type": "string",
"description": "Search products by keyword, or read ratings and reviews for known ASINs.",
"default": "search"
},
"queries": {
"title": "Search queries",
"type": "array",
"description": "One Amazon search per line, e.g. bathrobe, usb-c charger 65w.",
"default": [
"bathrobe"
],
"items": {
"type": "string"
}
},
"maxPages": {
"title": "Pages per query",
"minimum": 1,
"maximum": 20,
"type": "integer",
"description": "How many result pages to fetch for each query (1-20). Each page is a separate request and is charged separately; paging stops early when a page comes back empty.",
"default": 1
},
"sort": {
"title": "Sort",
"enum": [
"price-asc-rank",
"price-desc-rank",
"review-rank",
"date-desc-rank"
],
"type": "string",
"description": "Amazon sort order. Leave empty for Amazon's Featured order."
},
"min_rating": {
"title": "Minimum rating",
"minimum": 0,
"maximum": 4.5,
"type": "number",
"description": "Amazon customer-rating filter, 0 to 4.5 stars."
},
"page": {
"title": "Start page",
"minimum": 1,
"maximum": 20,
"type": "integer",
"description": "Result page to start from (1-20).",
"default": 1
},
"asins": {
"title": "ASINs (Product reviews)",
"type": "array",
"description": "Amazon product ids (10 characters, e.g. B084PBWBJR), from the product URL /dp/B084PBWBJR or the search results.",
"default": [
"B084PBWBJR"
],
"items": {
"type": "string"
}
},
"customRequests": {
"title": "Custom requests (advanced)",
"type": "array",
"description": "Optional list of JSON objects, one request each, using the API field names shown above. Each object is merged over the options above, so you only need to give what differs. Example: {\"q\":\"espresso machine\",\"sort\":\"review-rank\",\"min_rating\":4}"
},
"includeErrors": {
"title": "Include failed requests in the dataset",
"type": "boolean",
"description": "When on, a request that fails (for example an unknown property id) is saved as a dataset item with an error message so you can see what went wrong. Failed requests are never charged.",
"default": true
},
"maxConcurrency": {
"title": "Parallel requests",
"minimum": 1,
"maximum": 8,
"type": "integer",
"description": "How many API requests run at the same time (1-8). Parallel runs share one limit, so extra requests wait for a free slot instead of failing.",
"default": 3
},
"maxRetries": {
"title": "Retries per request",
"minimum": 0,
"maximum": 5,
"type": "integer",
"description": "Retries for rate limits (HTTP 429), temporary server errors (5xx) and network errors, with exponential backoff. Validation errors are never retried.",
"default": 2
}
}
},
"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
}
}
}
}
}
}
}
}
}
}