{ "openapi": "3.0.1", "info": { "title": "Amazon Price & Rank Monitor", "description": "Amazon price and visible rank monitor for ASINs and product URLs with snapshot comparison, change detection, and automation-ready output.", "version": "1.0", "x-build-id": "1h9Y91XSZ2rlopgPT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/solutionssmart~amazon-price-rank-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-solutionssmart-amazon-price-rank-monitor", "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/solutionssmart~amazon-price-rank-monitor/runs": { "post": { "operationId": "runs-sync-solutionssmart-amazon-price-rank-monitor", "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/solutionssmart~amazon-price-rank-monitor/run-sync": { "post": { "operationId": "run-sync-solutionssmart-amazon-price-rank-monitor", "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": { "asins": { "title": "πŸ”’ ASIN list", "minItems": 1, "type": "array", "description": "List of Amazon ASINs to monitor in the default marketplace.", "items": { "type": "string" } }, "products": { "title": "πŸ”— Mixed product inputs", "type": "array", "description": "Optional mixed array with ASIN, URL, and per-item marketplace overrides.", "items": { "type": "object", "additionalProperties": false, "properties": { "asin": { "title": "πŸ”  ASIN", "type": "string", "description": "Amazon ASIN. 10 alphanumeric characters." }, "url": { "title": "🌐 Product URL", "type": "string", "description": "Amazon product URL. If provided, the actor extracts the ASIN first." }, "marketplace": { "title": "πŸͺ Marketplace", "type": "string", "description": "Optional marketplace override for this item.", "editor": "select", "enumSuggestedValues": [ "amazon.com", "amazon.co.uk", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.ca", "amazon.com.mx", "amazon.co.jp", "amazon.com.au", "amazon.in" ] } } } }, "fileImport": { "title": "πŸ“„ Optional CSV / XLSX import", "type": "object", "description": "Optional remote file import for large batch monitoring. Keep it simple: one ASIN column or mapped ASIN / marketplace / URL columns.", "properties": { "inputSource": { "title": "🧾 File type", "type": "string", "description": "Choose whether the optional file import uses CSV or XLSX format.", "editor": "select", "enum": [ "csv", "xlsx" ] }, "fileUrl": { "title": "πŸ”— File URL", "type": "string", "description": "Public CSV or XLSX file URL.", "editor": "textfield" }, "sheetName": { "title": "πŸ“‘ Excel sheet name", "type": "string", "description": "Optional worksheet name for XLSX imports.", "editor": "textfield" }, "asinColumnName": { "title": "πŸ”€ Simple ASIN column name", "type": "string", "description": "Use this for a simple one-column ASIN import.", "editor": "textfield" }, "asinColumn": { "title": "#️⃣ Simple ASIN column index", "type": "integer", "minimum": 0, "description": "Alternative zero-based ASIN column index for simple import." }, "columnMapping": { "title": "πŸ—ΊοΈ Advanced column mapping", "type": "object", "description": "Optional mapped columns for ASIN, marketplace, and URL.", "properties": { "asinColumnName": { "type": "string", "title": "πŸ”€ ASIN column name", "description": "Column name containing ASIN values." }, "asinColumn": { "type": "integer", "title": "#️⃣ ASIN column index", "description": "Zero-based ASIN column index.", "minimum": 0 }, "marketplaceColumnName": { "type": "string", "title": "πŸͺ Marketplace column name", "description": "Column name containing marketplace values." }, "marketplaceColumn": { "type": "integer", "title": "#️⃣ Marketplace column index", "description": "Zero-based marketplace column index.", "minimum": 0 }, "urlColumnName": { "type": "string", "title": "🌐 URL column name", "description": "Column name containing Amazon product URLs." }, "urlColumn": { "type": "integer", "title": "#️⃣ URL column index", "description": "Zero-based URL column index.", "minimum": 0 } } }, "batchSize": { "title": "πŸ“¦ Batch size", "type": "integer", "description": "Preparation batch size hint for large file imports.", "default": 1000, "minimum": 1, "maximum": 10000 } } }, "marketplace": { "title": "πŸͺ Default marketplace", "type": "string", "description": "Default Amazon marketplace for ASIN-only entries.", "default": "amazon.com" }, "deduplicate": { "title": "🧹 Deduplicate before crawl", "type": "boolean", "description": "Deduplicate inputs by marketplace + normalized ASIN before browser work.", "default": true }, "onlyChanges": { "title": "🚨 Write only changed items", "type": "boolean", "description": "If enabled, only items with price or rank changes are written to the dataset. Summary counters are still produced for the full run.", "default": false }, "maxConcurrency": { "title": "βš™οΈ Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of Amazon pages processed at the same time.", "default": 3 }, "maxRequestRetries": { "title": "πŸ” Max request retries", "minimum": 0, "maximum": 20, "type": "integer", "description": "Retry count for transient page failures.", "default": 6 }, "requestTimeoutSecs": { "title": "⏱️ Request timeout (seconds)", "minimum": 15, "maximum": 180, "type": "integer", "description": "Navigation and extraction timeout per product page.", "default": 60 }, "proxyConfiguration": { "title": "πŸ›‘οΈ Proxy configuration", "type": "object", "description": "Strongly recommended for Amazon monitoring runs at scale." } } }, "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 } } } } } } } } } }