{ "openapi": "3.0.1", "info": { "title": "🛒 Amazon Product Scraper — Prices, Reviews & Rankings", "description": "Scrape Amazon product listings, prices, reviews, seller data, BSR rankings, and buy box info. Track competitors, monitor price changes, and build product databases at scale.", "version": "0.0", "x-build-id": "LGxgHFkelnxgH3EQf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexgendata~amazon-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexgendata-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/nexgendata~amazon-product-scraper/runs": { "post": { "operationId": "runs-sync-nexgendata-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/nexgendata~amazon-product-scraper/run-sync": { "post": { "operationId": "run-sync-nexgendata-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": [ "accessKey", "secretKey", "partnerTag" ], "properties": { "accessKey": { "title": "PA-API Access Key", "type": "string", "description": "Your Amazon Product Advertising API Access Key (from your Amazon Associates account → Manage Your Credentials). Free — sign up at https://affiliate-program.amazon.com" }, "secretKey": { "title": "PA-API Secret Key", "type": "string", "description": "Your Amazon Product Advertising API Secret Key. Stored encrypted. Generated alongside the Access Key in your Amazon Associates 'Manage Your Credentials' page." }, "partnerTag": { "title": "Amazon Associates Partner Tag", "type": "string", "description": "Your Amazon Associates Tracking ID (e.g. 'yourname-20' for US, 'yourname-21' for UK). Tied to the specific marketplace you're querying." }, "searchQuery": { "title": "Search Query (optional)", "type": "string", "description": "Keyword search on Amazon (e.g. 'wireless headphones'). Provide this OR asins/productUrls." }, "asins": { "title": "ASINs", "description": "Amazon ASIN product IDs (10-char). Accepts a list, a single ASIN string, or a comma/newline-separated list. Also accepts alternative field names: asinList, productIds, ids, asin, productId. Pass either ASINs or productUrls — both are auto-extracted." }, "productUrls": { "title": "Product URLs", "description": "Direct Amazon product page URLs. ASINs are auto-extracted from /dp/ or /gp/product/ paths. Also accepts these alternative field names: urls, startUrls, productLinks, productUrl, url." }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum results to return (1-100). Applies to keyword search; ASIN lookups are bounded by the ASINs you provide.", "default": 20 }, "marketplace": { "title": "Marketplace", "type": "string", "description": "Amazon marketplace. Accepts 2-letter codes (US, UK, DE, FR, IT, ES, JP, CA, IN, AU, BR, MX) or full domains (www.amazon.com, www.amazon.co.uk, …). Your PartnerTag must match this marketplace.", "default": "www.amazon.com" }, "urls": { "title": "urls (alias for productUrls)", "description": "Alternative name for productUrls." }, "startUrls": { "title": "startUrls (alias for productUrls)", "description": "Alternative name for productUrls." }, "productLinks": { "title": "productLinks (alias for productUrls)", "description": "Alternative name for productUrls." }, "productUrl": { "title": "productUrl (single-value alias for productUrls)", "type": "string", "description": "Alternative — a single value when you only need one. Comma-separated values are auto-split." }, "url": { "title": "url (single-value alias for productUrls)", "type": "string", "description": "Alternative — a single value when you only need one." }, "asinList": { "title": "asinList (alias for asins)", "description": "Alternative name for asins." }, "productIds": { "title": "productIds (alias for asins)", "description": "Alternative name for asins." }, "ids": { "title": "ids (alias for asins)", "description": "Alternative name for asins." }, "asin": { "title": "asin (single-value alias for asins)", "type": "string", "description": "Alternative — a single ASIN when you only need one." }, "productId": { "title": "productId (single-value alias for asins)", "type": "string", "description": "Alternative — a single ASIN when you only need one." } } }, "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 } } } } } } } } } }