{ "openapi": "3.0.1", "info": { "title": "Prisync Alternative — Competitor Price & Stock Monitor", "description": "Monitor competitor prices and stock across Shopify stores and product pages. Track price and availability changes with SKU matching, change-only runs, datasets, schedules, webhooks, and pay-per-event pricing.", "version": "1.0", "x-build-id": "ankoDkEmIMbZl7DTa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/solutionssmart~solutionssmart-competitor-price-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-solutionssmart-solutionssmart-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/solutionssmart~solutionssmart-competitor-price-monitor/runs": { "post": { "operationId": "runs-sync-solutionssmart-solutionssmart-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/solutionssmart~solutionssmart-competitor-price-monitor/run-sync": { "post": { "operationId": "run-sync-solutionssmart-solutionssmart-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", "properties": { "startUrls": { "title": "Product page URLs", "type": "array", "description": "Competitor product pages to monitor. One URL = one product check per run. Required unless catalogMode is set.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "catalogMode": { "title": "Catalog mode (Shopify store domain)", "type": "string", "description": "Shopify store domain (e.g. gymshark.com). Discovers the product catalog via /products.json (sitemap fallback), capped by maxItems, then checks each product page." }, "matchKey": { "title": "Match key", "enum": [ "AUTO", "SKU", "MPN", "EAN", "TITLE_FUZZY" ], "type": "string", "description": "What anchors stable product identity across runs: AUTO (best identifier found), SKU, MPN, EAN, or TITLE_FUZZY (URL anchor + title similarity confidence).", "default": "AUTO" }, "emitMode": { "title": "Emit mode", "enum": [ "ALL", "CHANGES_ONLY" ], "type": "string", "description": "ALL: emit a row for every product check. CHANGES_ONLY: emit only changed/new/failed rows (+ a NO_CHANGES_SUMMARY row when nothing changed) so scheduled runs never look empty.", "default": "CHANGES_ONLY" }, "currencyPreferred": { "title": "Preferred currency (fallback)", "type": "string", "description": "ISO code used only when the page does not declare its own currency (e.g. EUR, USD)." }, "priceDropPct": { "title": "Price drop alert threshold (%)", "type": "number", "description": "Minimum price decrease (percent) to report a PRICE_DROP. Leave empty to alert on any decrease." }, "priceRisePct": { "title": "Price rise alert threshold (%)", "type": "number", "description": "Minimum price increase (percent) to report a PRICE_RISE. Leave empty to alert on any increase." }, "alertOnOos": { "title": "Alert on out-of-stock", "type": "boolean", "description": "Report OOS as a change when a product goes out of stock.", "default": true }, "alertOnBackInStock": { "title": "Alert on back-in-stock", "type": "boolean", "description": "Report BACK_IN_STOCK as a change when an out-of-stock product becomes available again.", "default": true }, "maxItems": { "title": "Max product checks", "type": "integer", "description": "Cap on product pages checked this run (also caps catalogMode discovery).", "default": 1000 }, "maxConcurrency": { "title": "Max concurrency", "type": "integer", "description": "Parallel browser pages while checking. Keep single digits on strict storefronts.", "default": 3 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "type": "integer", "description": "Per-page navigation + extraction timeout.", "default": 45 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxy recommended. Defaults to Apify Proxy RESIDENTIAL with no fixed country. For stable cross-run comparisons, set apifyProxyCountry (e.g. US) — without it, runs may land in different storefront markets with different currencies/prices." }, "unblockerFallback": { "title": "Retry blocked pages with Unblocker", "type": "boolean", "description": "Optional paid fallback after blocked pages or exhausted navigation retries. Requires Apify Proxy with a fixed country. Missing pages and login walls are not retried. Unblocker charges separately, including browser subrequests.", "default": false }, "useJev": { "title": "Use Jev for ambiguous pages", "type": "boolean", "description": "Optional paid recovery. When deterministic extraction cannot identify a product, Jev classifies whether the page is blocked, login-gated, unavailable, empty, or uncertain. Charged once per Jev request; requires the Actor owner to configure TYPESAFE_API_KEY.", "default": false }, "maxUnblockerRequests": { "title": "Maximum fallback product URLs", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum product URLs sent to the fallback per run. This is not a billing cap: browser subrequests may also consume Unblocker units.", "default": 10 }, "webhookUrl": { "title": "Webhook URL (change events)", "type": "string", "description": "Optional. A JSON batch of changed rows is POSTed once per run when at least one change is detected." }, "persistState": { "title": "Persist state (compare to last run)", "type": "boolean", "description": "Store the last snapshot per product in the KV store, namespaced by Actor task id. Disable to always treat products as NEW.", "default": true }, "debug": { "title": "Debug", "type": "boolean", "description": "Verbose logging.", "default": 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 } } }, "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 } } } } } } } } } }