{ "openapi": "3.0.1", "info": { "title": "Airbnb Competitor Watch", "description": "Daily digest: which of your competitors changed price or availability for the same stays, and where your listings stand. Pay only for delivered checks (price or confirmed unavailability); errors are free; no run fee.", "version": "0.1", "x-build-id": "3gbtbQm3z5uYPtFZJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/titan_coder~airbnb-competitor-watch/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-titan_coder-airbnb-competitor-watch", "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/titan_coder~airbnb-competitor-watch/runs": { "post": { "operationId": "runs-sync-titan_coder-airbnb-competitor-watch", "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/titan_coder~airbnb-competitor-watch/run-sync": { "post": { "operationId": "run-sync-titan_coder-airbnb-competitor-watch", "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": [ "myListings", "competitorListings" ], "properties": { "monitorId": { "title": "Monitor ID", "pattern": "^[a-z0-9-]{1,40}$", "type": "string", "description": "Name of this monitoring set (a-z, 0-9, dash; up to 40 chars). Keeps its own history. Required when historyMode=daily." }, "historyMode": { "title": "History mode", "enum": [ "daily", "none" ], "type": "string", "description": "daily — remembers yesterday's prices and reports what changed (needs a stable monitorId across runs); none — one-off snapshot and ranking only, no comparison to previous runs.", "default": "daily" }, "myListings": { "title": "My listings", "minItems": 1, "maxItems": 5, "type": "array", "description": "1–5 Airbnb listing URLs or IDs (https://www.airbnb.com/rooms/12345678). Only the numeric ID is used.", "items": { "type": "string" } }, "competitorListings": { "title": "Competitor listings", "minItems": 1, "maxItems": 30, "type": "array", "description": "1–30 Airbnb listing URLs or IDs of competitors. Duplicates and overlaps with your listings are rejected.", "items": { "type": "string" } }, "stays": { "title": "Stays to check (check-in / check-out)", "type": "array", "description": "Up to 30 pairs {\"checkIn\":\"YYYY-MM-DD\",\"checkOut\":\"YYYY-MM-DD\"}. Leave empty for the next 8 weekends (Fri→Sun, 2 nights). checkIn must be strictly after today in your timezone." }, "timezone": { "title": "Timezone (IANA)", "type": "string", "description": "Used to build default weekends and the 'today' cut-off, e.g. Europe/Lisbon. Default UTC (a warning is logged).", "default": "UTC" }, "guests": { "title": "Guests", "minimum": 1, "maximum": 16, "type": "integer", "description": "Number of guests used for every check, same for your listings and competitors.", "default": 2 }, "currency": { "title": "Currency", "enum": [ "EUR", "USD", "GBP", "CHF", "CAD", "AUD", "PLN", "CZK", "SEK", "NOK", "DKK", "JPY" ], "type": "string", "description": "Currency requested from Airbnb for every check. A different currency returned by Airbnb marks that check unknown_error rather than mixing currencies in the digest.", "default": "EUR" }, "changeFilter": { "title": "Digest filter", "enum": [ "all", "availability_only", "price_only" ], "type": "string", "description": "Filters only the digest/webhook. The dataset always contains every delivered check.", "default": "all" }, "notifyOn": { "title": "Send webhook", "enum": [ "changes", "always", "never" ], "type": "string", "description": "changes — post the webhook only when something changed since yesterday; always — post it every run; never — do not call webhookUrl at all.", "default": "changes" }, "webhookUrl": { "title": "Webhook URL (HTTPS)", "type": "string", "description": "Optional. Receives the daily digest as JSON (POST). HTTPS only; private/loopback addresses are rejected; redirects are not followed. Slack/Telegram need an adapter (Make, Zapier, n8n)." } } }, "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 } } } } } } } } } }