{ "openapi": "3.0.1", "info": { "title": "Propertypal Scraper", "description": "Track PropertyPal sale and rental listings across Northern Ireland with prices, specs, agent details, brochures, broadband, history, floor plans, and listing status. Use a search URL or simple filters to compare areas, monitor markets, and export clean property data.", "version": "1.0", "x-build-id": "DvVRHRDbDBmxG9QES" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~propertypal-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-propertypal-scraper", "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/parseforge~propertypal-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-propertypal-scraper", "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/parseforge~propertypal-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-propertypal-scraper", "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": { "startUrl": { "title": "Start URL", "type": "string", "description": "PropertyPal listing URL to scrape. Use this OR the search filters below, not both." }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of properties to collect in this run. Free users are limited to 100 items." }, "includeDetails": { "title": "Include Full Details", "type": "boolean", "description": "Open each property page to collect richer fields like coordinates, history, brochures, broadband, and agent data." }, "saleType": { "title": "Listing Type", "enum": [ "property-for-sale", "property-to-rent", "new-homes", "commercial-property-for-sale", "commercial-property-to-rent", "agricultural-for-sale", "land-for-sale", "residential-land-for-sale" ], "type": "string", "description": "Used only when Start URL is empty." }, "location": { "title": "Location", "type": "string", "description": "Location slug such as northern-ireland, belfast, or coleraine." }, "sortOrder": { "title": "Sort Order", "enum": [ "hot", "dateHigh", "updatedHigh", "priceLow", "priceHigh", "bedroomsLow", "bedroomsHigh" ], "type": "string", "description": "Sort order for listing results." }, "minPrice": { "title": "Min Price (£)", "minimum": 0, "type": "integer", "description": "Minimum property price." }, "maxPrice": { "title": "Max Price (£)", "minimum": 0, "type": "integer", "description": "Maximum property price." }, "minBeds": { "title": "Min Bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum bedroom count." }, "maxBeds": { "title": "Max Bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Maximum bedroom count." }, "radius": { "title": "Radius", "minimum": 0, "type": "number", "description": "Radius filter used for location based searches." }, "minInternalArea": { "title": "Min Internal Area", "minimum": 0, "type": "integer", "description": "Minimum internal area filter." }, "includeSaleAgreed": { "title": "Include Sale Agreed", "type": "boolean", "description": "Include sale agreed properties in search results." }, "excludePriceOnApplication": { "title": "Exclude Price On Application", "type": "boolean", "description": "Remove listings where the price is hidden or on application." }, "excludeBuildingSites": { "title": "Exclude Building Sites", "type": "boolean", "description": "Remove building site listings from results." }, "excludeNewHomes": { "title": "Exclude New Homes", "type": "boolean", "description": "Remove new home listings from results." }, "garage": { "title": "Garage", "type": "boolean", "description": "Keep listings that mention a garage filter." }, "largeGarage": { "title": "Large Garage", "type": "boolean", "description": "Keep listings that mention a large garage filter." }, "coOwnership": { "title": "Co Ownership Eligible", "type": "boolean", "description": "Keep listings that are eligible for co ownership." }, "coOwnershipOnly": { "title": "Co Ownership Only", "type": "boolean", "description": "Keep only co ownership only listings." }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Residential proxies are recommended for stable runs." } } }, "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 } } } } } } } } } }