{ "openapi": "3.0.1", "info": { "title": "Amazon Product Scraper", "description": "Scrape Amazon product listings and extract structured product data including titles, prices, ratings, reviews, availability, product URLs, images, and other product details. Search by keyword and collect product data for price monitoring, product research, market analysis, and e-commerce automation.", "version": "1.0", "x-build-id": "mlOiOcjV0TxEmRH3i" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mrdoe~amazon-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mrdoe-amazon-product-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/mrdoe~amazon-product-scraper/runs": { "post": { "operationId": "runs-sync-mrdoe-amazon-product-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/mrdoe~amazon-product-scraper/run-sync": { "post": { "operationId": "run-sync-mrdoe-amazon-product-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": [ "operation" ], "properties": { "operation": { "title": "Operation", "enum": [ "search", "productDetails" ], "type": "string", "description": "Which Amazon data to scrape. One operation per run.", "default": "search" }, "query": { "title": "Search query (optional)", "type": "string", "description": "Keyword to search Amazon, e.g. \"coffee maker\". Used by the search operation. Defaults to a demo query if left blank.", "default": "coffee maker" }, "queries": { "title": "Search queries - batch (optional)", "type": "array", "description": "Many keywords in one run. Wins over \"query\" when filled. Duplicates and blanks are dropped.", "items": { "type": "string" } }, "categoryId": { "title": "Category (browse node) ID (optional)", "type": "string", "description": "An Amazon browse-node ID to narrow a search to one category, e.g. \"172282\". Must be combined with \"query\" - a category ID alone (no keyword) does not return results. Find a node ID from an Amazon category page's URL (the number after \"node=\")." }, "categoryIds": { "title": "Category IDs - batch (optional)", "type": "array", "description": "Many browse-node IDs in one run. Wins over \"categoryId\" when filled.", "items": { "type": "string" } }, "asin": { "title": "ASIN or product URL (optional)", "type": "string", "description": "An Amazon ASIN (e.g. \"B098CHH298\") or a full product URL. Used by the productDetails operation. Defaults to a demo product if left blank.", "default": "B01GJOMWVA" }, "asins": { "title": "ASINs or product URLs - batch (optional)", "type": "array", "description": "Many ASINs or product URLs in one run. Wins over \"asin\" when filled.", "items": { "type": "string" } }, "domain": { "title": "Marketplace", "enum": [ "amazon.com" ], "type": "string", "description": "Which Amazon marketplace to query.", "default": "amazon.com" }, "sortBy": { "title": "Sort by (optional)", "enum": [ "relevance", "price-asc-rank", "price-desc-rank", "review-rank", "date-desc-rank" ], "type": "string", "description": "Applies to search." }, "minPrice": { "title": "Min price (optional)", "minimum": 0, "type": "integer", "description": "Applies to search." }, "maxPrice": { "title": "Max price (optional)", "minimum": 0, "type": "integer", "description": "Applies to search." }, "zipCode": { "title": "Delivery ZIP code", "type": "string", "description": "Amazon shows a degraded page with no real prices (\"See options\" only) until a delivery location is set. The Actor sets this automatically before crawling - change it if you need pricing/availability for a specific US region.", "default": "10001" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "A residential proxy is strongly recommended for sustained volume - Amazon rate-limits repeated traffic from one IP.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } }, "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 } } } } } } } } } }