{ "openapi": "3.0.1", "info": { "title": "Competitor Price Monitor", "description": "Track competitor prices and stock on any online store on a schedule. Detects price drops and stock changes, keeps price history, compares retailers, and sends alerts to Slack, Teams, Zapier or any webhook.", "version": "1.0", "x-build-id": "bAAbhGSpmoHHR8ovO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/codepal~competitor-price-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-codepal-competitor-price-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/codepal~competitor-price-monitor/runs": { "post": { "operationId": "runs-sync-codepal-competitor-price-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/codepal~competitor-price-monitor/run-sync": { "post": { "operationId": "run-sync-codepal-competitor-price-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": "Products to monitor", "type": "array", "description": "Product page URLs from any retailer. Optional per-product settings go in each row's user data: {\"group\":\"iPhone 15 128GB\",\"retailer\":\"Jumia\",\"target_price\":95000,\"my_price\":99000,\"sku\":\"…\",\"price_selector\":\".price\",\"stock_selector\":\"#stock\"}. Rows with the same group are compared across retailers. Shopify ?variant= URLs track that exact variant.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Each name keeps its own price history. Use one name per saved task/schedule (e.g. \"blenders-ke\").", "default": "default" }, "outputMode": { "title": "Output", "enum": [ "all", "changes-only" ], "type": "string", "description": "All products every run, or only products whose price/stock changed or that raised an alert (first run always outputs all).", "default": "all" }, "alertOn": { "title": "Alert on", "type": "array", "description": "Which events count as alerts (in the dataset and the webhook).", "items": { "type": "string", "enum": [ "price_drop", "price_increase", "back_in_stock", "out_of_stock", "below_target", "lowest_price_ever" ], "enumTitles": [ "Price drop", "Price increase", "Back in stock", "Out of stock", "Price at or below my target", "Lowest price ever seen" ] }, "default": [ "price_drop", "price_increase", "back_in_stock", "out_of_stock", "below_target" ] }, "minChangePercent": { "title": "Ignore changes smaller than (%)", "minimum": 0, "type": "number", "description": "e.g. 1 to ignore rounding noise. 0 = any change.", "default": 0 }, "webhookUrl": { "title": "Alert webhook URL", "type": "string", "description": "POSTs alerts after each run. Works with Slack, Microsoft Teams/Power Automate, Zapier, Make and n8n incoming webhooks.", "default": "" }, "defaultCurrency": { "title": "Default currency", "type": "string", "description": "ISO code used only when a page shows no currency, e.g. KES.", "default": "" }, "usePlatformApis": { "title": "Use Shopify / WooCommerce product APIs", "type": "boolean", "description": "Exact prices and per-variant stock from the store's public product JSON.", "default": true }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Skip product pages the store's robots.txt disallows (reported as errors, not charged).", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Pages fetched in parallel.", "default": 10 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Use Apify Proxy (residential for strict retailers) if checks fail with 403/429.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }