{ "openapi": "3.0.1", "info": { "title": "Website Change Detector & Diff API", "description": "Detect page changes and deterministic diffs. Price: $0.01 per successful comparison.", "version": "0.1", "x-build-id": "602JiLi8zB5RPgDlY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/industrial_platform~web-change-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-industrial_platform-web-change-intelligence", "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/industrial_platform~web-change-intelligence/runs": { "post": { "operationId": "runs-sync-industrial_platform-web-change-intelligence", "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/industrial_platform~web-change-intelligence/run-sync": { "post": { "operationId": "run-sync-industrial_platform-web-change-intelligence", "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": [ "url" ], "properties": { "url": { "title": "URL", "maxLength": 2048, "type": "string", "description": "Public http:// or https:// URL to inspect." }, "previous_text": { "title": "Previous normalized text", "maxLength": 250000, "type": "string", "description": "Optional current_text returned by a previous run. When provided, the Actor returns deterministic added/removed excerpts and change metrics." }, "previous_hash": { "title": "Previous SHA-256 hash", "pattern": "^[A-Fa-f0-9]{64}$", "type": "string", "description": "Optional current_hash from a previous run. Use this for compact changed/unchanged checks when a detailed diff is not required." }, "selector": { "title": "CSS selector", "maxLength": 500, "type": "string", "description": "Optional CSS selector that restricts monitoring to a specific part of an HTML page, such as main, #pricing, or .inventory." }, "ignore_selectors": { "title": "Ignore CSS selectors", "maxItems": 20, "type": "array", "description": "Optional HTML selectors to remove before comparison, useful for clocks, rotating banners, ads, or other volatile regions.", "items": { "type": "string", "maxLength": 500 }, "default": [] }, "include_current_text": { "title": "Include normalized current text", "type": "boolean", "description": "Return current_text so a later run can perform a detailed text comparison.", "default": true }, "max_text_chars": { "title": "Maximum normalized text characters", "minimum": 1000, "maximum": 250000, "type": "integer", "description": "Maximum characters retained before hashing and comparison. Keep this value consistent across repeated checks.", "default": 100000 }, "max_diff_chars": { "title": "Maximum characters per diff excerpt", "minimum": 1000, "maximum": 50000, "type": "integer", "description": "Maximum length returned for each added/removed excerpt.", "default": 12000 }, "timeout_seconds": { "title": "Fetch timeout", "minimum": 5, "maximum": 60, "type": "integer", "description": "Maximum time allowed for the target request.", "default": 30 } } }, "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 } } } } } } } } } }