{ "openapi": "3.0.1", "info": { "title": "Amazon Scraper: Product Search & Sales Volume", "description": "Scrape Amazon search results in 10 marketplaces: price, list price, rating, reviews, \"bought in past month\" sales volume, Best Seller and Amazon's Choice badges, Prime and delivery. Filter by price or exclude sponsored. Export JSON, CSV, Excel.", "version": "0.1", "x-build-id": "x5XBu8C7jc8fyDgd1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation-lab~amazon-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation-lab-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/automation-lab~amazon-scraper/runs": { "post": { "operationId": "runs-sync-automation-lab-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/automation-lab~amazon-scraper/run-sync": { "post": { "operationId": "run-sync-automation-lab-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": { "searchQueries": { "title": "Search Keywords", "type": "array", "description": "Search Amazon for these keywords. Each keyword runs a separate search. Example: laptop stand, wireless earbuds, coffee grinder.", "items": { "type": "string" } }, "marketplace": { "title": "Amazon Marketplace", "enum": [ "US", "UK", "DE", "FR", "IT", "ES", "CA", "JP", "IN", "AU" ], "type": "string", "description": "Which Amazon marketplace to scrape. Proxy country is set automatically.", "default": "US" }, "maxProductsPerSearch": { "title": "Max products per search (items)", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of product records to return per search keyword.", "default": 100 }, "maxSearchPages": { "title": "Max search pages per keyword (pages)", "minimum": 1, "maximum": 20, "type": "integer", "description": "Safety cap on result pages per keyword. The Actor keeps loading pages until it reaches \"Max products per search\" or Amazon has no more results, so you normally don't need to change this. Amazon shows about 16-60 products per page.", "default": 20 }, "sort": { "title": "Sort Order", "enum": [ "relevance", "price_low", "price_high", "avg_rating", "newest" ], "type": "string", "description": "Sort order for Amazon search results.", "default": "relevance" }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Only return products priced at or above this amount, in the marketplace currency. Amazon applies the range itself; products without a shown price are skipped when a price filter is set." }, "maxPrice": { "title": "Maximum price", "minimum": 0.01, "type": "number", "description": "Only return products priced at or below this amount, in the marketplace currency. Must be greater than 0; leave empty for no maximum." }, "excludeSponsored": { "title": "Exclude sponsored results", "type": "boolean", "description": "Skip sponsored (ad) placements and return organic results only.", "default": false }, "maxRequestRetries": { "title": "Max request retries (attempts)", "minimum": 1, "maximum": 12, "type": "integer", "description": "Maximum request attempts for transient failures. Healthy residential sessions are reused across searches; each retry rotates identity and alternates an equivalent Amazon search route.", "default": 10 } } }, "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 } } } } } } } } } }