{ "openapi": "3.0.1", "info": { "title": "Propertyware rental monitor: inventory changes and leads", "description": "Collect anonymous public Propertyware rentals with source-aware rent, bedroom, bathroom, amenity, contact, and availability filters. Export factual listing records, public lead paths, rent signals, and new or changed inventory for recurring workflows at $0.00088 per result.", "version": "0.0", "x-build-id": "cgu057X4NgU2lSNgX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/getascraper~propertyware-rentals-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-getascraper-propertyware-rentals-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/getascraper~propertyware-rentals-monitor/runs": { "post": { "operationId": "runs-sync-getascraper-propertyware-rentals-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/getascraper~propertyware-rentals-monitor/run-sync": { "post": { "operationId": "run-sync-getascraper-propertyware-rentals-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": [ "startUrls" ], "properties": { "startUrls": { "title": "Public Propertyware rental pages", "type": "array", "description": "Public *.propertyware.com listing or detail URLs. Unsupported hosts are rejected before requests.", "default": [ { "url": "https://rentalmaintenance.propertyware.com/rentals.html" } ], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "addressQuery": { "title": "Address search", "type": "string", "description": "Narrows results with the source's public address search.", "default": "" }, "minMonthlyRent": { "title": "Minimum monthly rent", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Requests listings at or above this public monthly rent.", "default": 0 }, "maxMonthlyRent": { "title": "Maximum monthly rent", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Requests listings at or below this public monthly rent. Zero means no upper bound.", "default": 0 }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 50, "type": "number", "description": "Requests listings with at least this many public bedrooms.", "default": 0 }, "minBathrooms": { "title": "Minimum bathrooms", "minimum": 0, "maximum": 50, "type": "number", "description": "Requests listings with at least this many public bathrooms.", "default": 0 }, "propertyType": { "title": "Property type", "type": "string", "description": "Matches an exact property type exposed by each source.", "default": "" }, "amenities": { "title": "Amenities", "type": "array", "description": "Sends each selected amenity as a native filter. Unsupported options produce a warning and no rows for that source.", "items": { "type": "string" }, "default": [] }, "leasingContacts": { "title": "Leasing contacts", "type": "array", "description": "Matches public leasing-contact names and resolves them to each source's public ID.", "items": { "type": "string" }, "default": [] }, "sortBy": { "title": "Sort results", "enum": [ "rentDescending", "rentAscending", "availableSooner", "availableLater", "areaDescending", "areaAscending", "rentPerSquareFootDescending", "rentPerSquareFootAscending", "bedroomsDescending", "bedroomsAscending", "bathroomsDescending", "bathroomsAscending" ], "type": "string", "description": "Chooses the public Propertyware ordering for retrieved listings.", "default": "rentDescending" }, "availableOnOrBefore": { "title": "Available on or before", "type": "string", "description": "Keeps normalized listings available by this calendar date. Leave empty to disable this local filter.", "default": "" }, "requirePublicContact": { "title": "Require a public phone or email", "type": "boolean", "description": "Keeps only listings with a real public phone or email.", "default": false }, "requireApplyOrShowingUrl": { "title": "Require an application or showing link", "type": "boolean", "description": "Keeps only listings with a real public application or showing path.", "default": false }, "outputMode": { "title": "Output mode", "enum": [ "snapshotAndChanges" ], "type": "string", "description": "Always emits current listings and factual change metadata across complete runs.", "default": "snapshotAndChanges" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional connection settings. No proxy is used by default, and residential proxy use remains opt-in.", "default": { "useApifyProxy": false } }, "includeDetails": { "title": "Include public listing details", "type": "boolean", "description": "Fetches related public detail fields such as descriptions, links, and contacts.", "default": false }, "includeFullImages": { "title": "Include full public image URLs", "type": "boolean", "description": "Retains all public image URLs found on related detail records.", "default": false }, "includeAmenities": { "title": "Include public amenities", "type": "boolean", "description": "Retains public amenity values found on related detail records.", "default": false }, "maxItems": { "title": "Maximum listings", "minimum": 1, "maximum": 500, "type": "integer", "description": "Limits current listings emitted per run. Removed records are not counted.", "default": 20 } } }, "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 } } } } } } } } } }