{ "openapi": "3.0.1", "info": { "title": "Universal Product Price, Stock & Variant Monitor", "description": "Monitor Amazon and Walmart product prices, inventory, variants, sellers, Buy Box ownership, and delivery changes.", "version": "0.0", "x-build-id": "lrRpUlX3VerBsdnl5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lead.gen.labs~universal-product-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lead.gen.labs-universal-product-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/lead.gen.labs~universal-product-monitor/runs": { "post": { "operationId": "runs-sync-lead.gen.labs-universal-product-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/lead.gen.labs~universal-product-monitor/run-sync": { "post": { "operationId": "run-sync-lead.gen.labs-universal-product-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", "required": [ "products" ], "properties": { "products": { "title": "Product URLs", "minItems": 1, "type": "array", "description": "Add direct product links from Amazon.com or Walmart.com. An optional `externalId` can be included in JSON input to match results with your own catalog.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "deliveryLocation": { "title": "Location settings", "required": [ "postalCode", "country", "language" ], "type": "object", "description": "Choose the customer location used when checking product availability and delivery.", "properties": { "postalCode": { "title": "Delivery ZIP code", "description": "The US ZIP code used to check localized prices, stock, and delivery.", "type": "string", "editor": "textfield", "default": "10001" }, "country": { "title": "Country", "description": "The two-letter country code. Amazon.com and Walmart.com currently support US monitoring.", "type": "string", "editor": "textfield", "default": "US", "pattern": "^[A-Za-z]{2}$" }, "language": { "title": "Store language", "description": "The storefront language and region code.", "type": "string", "editor": "textfield", "default": "en-US" } }, "default": { "country": "US", "postalCode": "10001", "language": "en-US" }, "additionalProperties": false }, "includeSellers": { "title": "Collect seller offers and Buy Box data", "type": "boolean", "description": "When available, collect marketplace sellers, their prices, and the featured Buy Box offer.", "default": true }, "onlyChanges": { "title": "Save only detected changes", "type": "boolean", "description": "Off: save complete product records and any alerts. On: save only alerts, such as price drops and restocks. Keep this off for your first run.", "default": false }, "minimumPriceChangePercent": { "title": "Minimum price change for an alert", "minimum": 0, "maximum": 100, "type": "number", "description": "Ignore smaller price movements. Use 0 to report every price change, or 5 to report changes of 5% or more.", "default": 0 }, "maxProducts": { "title": "Maximum products per run", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop before processing if the submitted URL count exceeds this safety limit.", "default": 100 }, "maxConcurrency": { "title": "Products processed at the same time", "minimum": 1, "maximum": 20, "type": "integer", "description": "Higher values may finish faster but can increase blocking. The production-tested default is 3.", "default": 3 }, "maxRequestRetries": { "title": "Retries for failed requests", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many times to retry a product when a store blocks or fails to load it.", "default": 3 }, "stateStoreName": { "title": "Monitoring history name", "type": "string", "description": "Keep the same name on future runs so the Actor can compare results and detect changes. Use a different name for a separate monitoring list.", "default": "universal-product-monitor-state" } } }, "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 } } } } } } } } } }