{ "openapi": "3.0.1", "info": { "title": "Amazon Products & Reviews", "description": "Extract product listings, prices, details, and available reviews from Amazon.", "version": "3.3", "x-build-id": "qYvefXpP674saJ4a8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/canadesk~amazon-products-reviews/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-canadesk-amazon-products-reviews", "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/canadesk~amazon-products-reviews/runs": { "post": { "operationId": "runs-sync-canadesk-amazon-products-reviews", "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/canadesk~amazon-products-reviews/run-sync": { "post": { "operationId": "run-sync-canadesk-amazon-products-reviews", "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": [ "process" ], "properties": { "process": { "title": "Process", "enum": [ "gp", "gr", "gq", "ga", "lc" ], "type": "string", "description": "Select the process to run.", "default": "ga" }, "keywords": { "title": "Search several keywords", "type": "array", "description": "Optional list of up to 100 inputs in one run. Replaces the single input and selects its corresponding operation. Use only one batch list.", "items": { "type": "string" } }, "keyword": { "title": "Keyword", "type": "string", "description": "Type a keyword (Search Products)." }, "asin": { "title": "ASIN codes", "type": "array", "description": "Product ASINs for detail, review and question operations. Scalar strings are also accepted through the API.", "items": { "type": "string" } }, "country": { "title": "Default country", "enum": [ "US", "CA", "AE", "AU", "BR", "CN", "DE", "EG", "ES", "FR", "GB", "IN", "IT", "JP", "MX", "NL", "SG", "TR" ], "type": "string", "description": "Default country to look for.", "default": "US" }, "category": { "title": "Search category", "type": "string", "description": "Optional Amazon search alias returned by List All Categories." }, "maxResults": { "title": "Maximum results override", "minimum": 1, "type": "integer", "description": "Maximum real records across the entire run, shared by all inputs." }, "maximum": { "title": "Maximum results", "minimum": 1, "type": "integer", "description": "Maximum number of records returned (impact on performance).", "default": 15 }, "maxResultsPerInput": { "title": "Maximum results per input", "minimum": 1, "type": "integer", "description": "Optional limit per batch input, within the run-wide Maximum results limit. Inputs are processed in order." }, "ratingmin": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Keep search products and reviews with a known rating at or above this value.", "default": 1 }, "ratingmax": { "title": "Maximum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Keep search products and reviews with a known rating at or below this value.", "default": 5 }, "sorting": { "title": "Sort each search page by review score", "type": "boolean", "description": "Order products on each collected page by rating multiplied by review count.", "default": false }, "discount": { "title": "Discount-only", "type": "boolean", "description": "Only return discounted products (Search Products).", "default": false }, "seller": { "title": "Seller ID", "type": "string", "description": "Optional seller filter for product searches." }, "verifiedPurchaseOnly": { "title": "Verified purchases only", "type": "boolean", "description": "Ask Amazon for verified-purchase reviews only.", "default": false }, "filterByStar": { "title": "Review star filter", "enum": [ "all_stars", "one_star", "two_star", "three_star", "four_star", "five_star", "positive", "critical" ], "type": "string", "description": "Optional source-side review rating filter." }, "reviewSort": { "title": "Review order", "enum": [ "recent", "helpful" ], "type": "string", "description": "Source ordering for full-review pages.", "default": "recent" }, "reviewSource": { "title": "Review source", "enum": [ "amazon", "woot" ], "type": "string", "description": "For Get Reviews only. Woot is an optional public source for US written reviews; coverage may be partial. Select United States when using Woot.", "default": "amazon" }, "throttling": { "title": "Request delay", "minimum": 1, "maximum": 30, "type": "integer", "description": "Waiting time between requests.", "default": 5 }, "cookie": { "title": "Your Amazon session (optional)", "type": "string", "description": "Session cookie from your own authorized Amazon account, if needed. Anonymous reviews and questions can require sign-in." }, "maxPages": { "title": "Maximum pages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum search, review or question pages. When omitted, derived from the requested result count." }, "page": { "title": "Starting page", "minimum": 1, "maximum": 100, "type": "integer", "description": "First search, review or question page to request.", "default": 1 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Optional proxy for source requests. No proxy is selected automatically." } } }, "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 } } } } } } } } } }