{ "openapi": "3.0.1", "info": { "title": "Amazon Product Scraper", "description": "Scrape Amazon for product details, search results, reviews, prices, ratings, and more. Supports 19 marketplaces worldwide.", "version": "1.0", "x-build-id": "JylJo6rXL8qfkFXef" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/novashieldai~amazon-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-novashieldai-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/novashieldai~amazon-product-scraper/runs": { "post": { "operationId": "runs-sync-novashieldai-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/novashieldai~amazon-product-scraper/run-sync": { "post": { "operationId": "run-sync-novashieldai-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", "properties": { "mode": { "title": "Mode", "enum": [ "search", "product", "reviews" ], "type": "string", "description": "Scraping mode: 'search' for keyword search, 'product' for single ASIN details, 'reviews' for product reviews, 'bestseller' for best-seller lists.", "default": "search" }, "query": { "title": "Search Query", "type": "string", "description": "Search keyword (required for search mode). Example: 'wireless mouse', 'gaming laptop'." }, "asin": { "title": "ASIN or Product URL", "type": "string", "description": "Amazon ASIN product identifier (required for product/reviews mode). Example: 'B0CHX3QBCH'." }, "marketplace": { "title": "Marketplace", "enum": [ "com", "co.uk", "de", "fr", "it", "es", "ca", "co.jp", "in", "com.br", "com.au", "com.mx", "nl", "sg", "ae", "sa", "pl", "se", "com.tr" ], "type": "string", "description": "Amazon marketplace domain. Example: 'amazon.com', 'amazon.co.uk', 'amazon.de'.", "default": "com" }, "limit": { "title": "Max Results", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of results to return (default: 20, max: 100).", "default": 20 }, "page": { "title": "Page", "minimum": 1, "maximum": 20, "type": "integer", "description": "Page number for paginated results (default: 1).", "default": 1 }, "sort": { "title": "Sort", "enum": [ "relevance", "price_asc", "price_desc", "reviews", "newest", "bestsellers" ], "type": "string", "description": "Sort order for search results: 'relevance', 'price_low', 'price_high', 'reviews', 'newest'.", "default": "relevance" }, "includeReviews": { "title": "Include Reviews", "type": "boolean", "description": "Include Reviews", "default": false }, "reviewsLimit": { "title": "Reviews Limit", "minimum": 1, "maximum": 200, "type": "integer", "description": "Reviews Limit", "default": 50 } } }, "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 } } } } } } } } } }