{ "openapi": "3.0.1", "info": { "title": "Amazon Product Data, Reviews & Sellers", "description": "Collect Amazon product details, Best Sellers, reviews, and seller profiles.", "version": "0.2", "x-build-id": "Uqbq1ybnfxkdjubGF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/antonio_cesar~amazon-data-suite/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-antonio_cesar-amazon-data-suite", "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/antonio_cesar~amazon-data-suite/runs": { "post": { "operationId": "runs-sync-antonio_cesar-amazon-data-suite", "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/antonio_cesar~amazon-data-suite/run-sync": { "post": { "operationId": "run-sync-antonio_cesar-amazon-data-suite", "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": "Data operation", "enum": [ "search", "product_details", "best_sellers", "reviews", "seller_info" ], "type": "string", "description": "Select the Amazon data you want to collect.", "default": "search" }, "searchQueries": { "title": "Search keywords", "minItems": 1, "maxItems": 20, "uniqueItems": true, "type": "array", "description": "Enter 1–20 unique product keywords, such as wireless headphones or PS5 accessories.", "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "default": [ "wireless headphones" ] }, "marketplaceUrl": { "title": "Amazon marketplace", "enum": [ "https://www.amazon.com", "https://www.amazon.ca", "https://www.amazon.com.mx", "https://www.amazon.com.br", "https://www.amazon.co.uk", "https://www.amazon.de", "https://www.amazon.fr", "https://www.amazon.it", "https://www.amazon.es", "https://www.amazon.nl", "https://www.amazon.com.be", "https://www.amazon.pl", "https://www.amazon.se", "https://www.amazon.com.tr", "https://www.amazon.ae", "https://www.amazon.sa", "https://www.amazon.eg", "https://www.amazon.in", "https://www.amazon.sg", "https://www.amazon.com.au", "https://www.amazon.co.jp", "https://www.amazon.cn" ], "type": "string", "description": "Marketplace root used by Search. Product Details derives the marketplace from each URL; Reviews, Best Sellers, and Seller Information currently require Amazon.com.", "default": "https://www.amazon.com" }, "pagesToSearch": { "title": "Search result pages per keyword", "minimum": 1, "maximum": 5, "type": "integer", "description": "Inspect 1–5 search pages per keyword. maxResults still limits the combined output from the entire run.", "default": 1 }, "maxResults": { "title": "Maximum total results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of records returned by the entire run. Search supports up to 1,000 and Best Sellers up to 500; the runtime also respects the available billing budget.", "default": 10 }, "startUrls": { "title": "Amazon URLs", "minItems": 1, "maxItems": 500, "uniqueItems": true, "type": "array", "description": "Use product URLs for details/reviews, ranking or category URLs for Best Sellers, or /sp?seller= URLs for sellers. Product/Seller accept up to 500, Reviews up to 100, and Best Sellers up to 20.", "items": { "type": "object", "properties": { "url": { "title": "Amazon URL", "type": "string", "description": "HTTPS Amazon URL appropriate to the selected operation.", "pattern": "^https://([^/]+\\.)?amazon\\." } }, "required": [ "url" ], "additionalProperties": true } }, "zipcode": { "title": "Postal or ZIP code", "maxLength": 20, "type": "string", "description": "Optional postal code used for localized availability, delivery, and price data.", "default": "" }, "language": { "title": "Language", "enum": [ "", "en_US", "en_GB", "es_US", "es_ES", "de_DE", "fr_FR", "fr_CA", "it_IT", "pt_BR", "ja_JP", "nl_NL", "pl_PL", "sv_SE", "tr_TR", "ar_AE", "zh_CN" ], "type": "string", "description": "Language locale for Product Details. Choose Automatic to use the marketplace default.", "default": "" }, "maxReviews": { "title": "Maximum reviews per product", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum reviews returned for each product URL. The limit is applied as an upstream per-input result cap.", "default": 20 }, "variationSpecific": { "title": "Deprecated: variation-specific reviews", "type": "boolean", "description": "Deprecated compatibility field. It is accepted but no longer sent upstream because the current Reviews API does not document this filter.", "default": false }, "reviewsToNotInclude": { "title": "Review IDs to exclude", "maxItems": 1000, "uniqueItems": true, "type": "array", "description": "Optional unique review IDs to omit from incremental collection.", "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "default": [] }, "includeReviewerIdentity": { "title": "Include reviewer identity fields", "type": "boolean", "description": "Include reviewer name, profile URL, and identifiers when available. Disabled by default for privacy; you are responsible for lawful use.", "default": false }, "includeRawData": { "title": "Include raw upstream data", "type": "boolean", "description": "Add rawData to each result. Reviewer identity remains removed unless Include reviewer identity fields is also enabled.", "default": false }, "includeErrors": { "title": "Save item-level errors", "type": "boolean", "description": "Save validation and upstream item errors to the ERRORS key-value record. Errors are never written to the billable results dataset.", "default": true }, "timeoutSeconds": { "title": "Absolute run deadline in seconds", "minimum": 30, "maximum": 3600, "type": "integer", "description": "Maximum elapsed time for trigger, polling, retries, and download. Active external snapshots are cancelled when this deadline expires.", "default": 900 } } }, "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 } } } } } } } } } }