{ "openapi": "3.0.1", "info": { "title": "Property Listing Signal Monitor — US Authorized Feeds", "description": "Monitor U.S. property prices and listing text from your authorized JSON/CSV feed. Literal keyword evidence and successful-run history. No site scraping.", "version": "1.0", "x-build-id": "vnileSE1nNFgCsixN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/afkdigital~property-listing-signal-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-afkdigital-property-listing-signal-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/afkdigital~property-listing-signal-monitor/runs": { "post": { "operationId": "runs-sync-afkdigital-property-listing-signal-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/afkdigital~property-listing-signal-monitor/run-sync": { "post": { "operationId": "run-sync-afkdigital-property-listing-signal-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": [ "sourceId", "authorizationConfirmed" ], "properties": { "country": { "title": "Country", "enum": [ "US" ], "type": "string", "description": "Version 1 processes only records explicitly marked US.", "default": "US" }, "sourceId": { "title": "Stable source ID", "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "type": "string", "description": "Stable ID for this authorized inventory. Different query-selected inventories must have different source IDs. Keep it unchanged for comparisons." }, "monitorId": { "title": "Monitor ID", "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "type": "string", "description": "Keep the same value across runs. A new value intentionally starts fresh history.", "default": "default" }, "authorizationConfirmed": { "title": "I have permission to process this feed", "type": "boolean", "description": "Required: I own the feed or have permission for automated retrieval, processing and my intended data reuse. This declaration does not create or independently verify legal rights. Bundled fictional examples may be used for testing. The prefilled confirmation applies only to the included demonstration input. If you replace the sample, check your own rights and confirm deliberately.", "default": false }, "feedUrl": { "title": "Authorized feed URL (secret)", "type": "string", "description": "Direct HTTPS JSON or CSV feed. Use exactly one of feedUrl or listings. Remove the inline example when using a URL. No redirects, HTML, proxies or login flows. Up to 5 MiB / 5,000 records." }, "bearerToken": { "title": "Feed bearer token (optional, secret)", "type": "string", "description": "Optional token supplied by the feed owner, used only in the Authorization header for that feed. Do not include the word Bearer." }, "feedFormat": { "title": "Feed format", "enum": [ "json", "csv" ], "type": "string", "description": "Canonical JSON array or {listings:[...],complete:true}; UTF-8 CSV with the documented headers. No pagination or arbitrary field mapping.", "default": "json" }, "listings": { "title": "Inline listings (alternative to feed URL)", "type": "array", "description": "Paste a JSON array using the canonical fields. Demonstration rows are fictional. Delete this field when specifying feedUrl." }, "region": { "title": "Region filter", "type": "string", "description": "Case-insensitive literal substring in location or region; empty means all supplied regions.", "default": "" }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Optional inclusive minimum. Listings without a supplied price are excluded when any price bound is used." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Optional inclusive maximum in the selected currency. No exchange-rate conversion." }, "currency": { "title": "Currency filter", "type": "string", "description": "An ISO currency code, usually USD for U.S. feeds. Records must explicitly supply this currency to match; no currency is inferred.", "default": "USD" }, "keywords": { "title": "Literal keywords", "type": "array", "description": "Up to 20 phrases, 60 characters each. Case-insensitive Unicode-normalized substring OR matching in title/description. Empty array returns all otherwise matching records. These words do not imply value or returns.", "default": [ "urgent", "reduced" ], "items": { "type": "string" } }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum billed listing rows. All valid source rows still inform history, including rows outside filters or this limit.", "default": 100 } } }, "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 } } } } } } } } } }