{ "openapi": "3.0.1", "info": { "title": "NSW Development Application Lead API", "description": "Find and score NSW development application lead signals from the NSW Planning Portal for trades, consultants, and property-service suppliers.", "version": "0.1", "x-build-id": "bKz66qjMdeQF7YUjh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s1syphus9~nsw-development-application-leads/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s1syphus9-nsw-development-application-leads", "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/s1syphus9~nsw-development-application-leads/runs": { "post": { "operationId": "runs-sync-s1syphus9-nsw-development-application-leads", "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/s1syphus9~nsw-development-application-leads/run-sync": { "post": { "operationId": "run-sync-s1syphus9-nsw-development-application-leads", "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": { "daysBack": { "title": "Days back", "minimum": 1, "maximum": 365, "type": "integer", "description": "Relative date window used when explicit lodgement dates are not provided.", "default": 14 }, "lodgementDateFrom": { "title": "Lodgement date from", "type": "string", "description": "Optional YYYY-MM-DD lower bound for lodged applications. Overrides daysBack." }, "lodgementDateTo": { "title": "Lodgement date to", "type": "string", "description": "Optional YYYY-MM-DD upper bound for lodged applications. Defaults to today." }, "applicationStatus": { "title": "Source application status", "type": "string", "description": "Status sent to the NSW Planning Portal API. Use ALL for broad source retrieval, then filter with statuses.", "default": "ALL" }, "statuses": { "title": "Returned statuses", "type": "array", "description": "Statuses to keep after retrieval.", "items": { "type": "string" }, "default": [ "Under Assessment", "On Exhibition", "Approved" ] }, "councils": { "title": "Councils", "type": "array", "description": "Optional council name filters such as Northern Beaches Council or Lake Macquarie City Council.", "items": { "type": "string" }, "default": [] }, "suburbs": { "title": "Suburbs", "type": "array", "description": "Optional suburb filters inferred from the returned address.", "items": { "type": "string" }, "default": [] }, "postcodes": { "title": "Postcodes", "type": "array", "description": "Optional NSW postcode filters inferred from the returned address.", "items": { "type": "string" }, "default": [] }, "keywords": { "title": "Keywords", "type": "array", "description": "Opportunity words to match across development type, application type, status, council, and address.", "items": { "type": "string" }, "default": [ "dwelling", "alterations", "additions", "new structure", "multi-dwelling", "commercial", "industrial", "roof" ] }, "leadProfile": { "title": "Lead profile", "type": "object", "description": "Supplier/trade profile used for lead scoring.", "default": { "trade": "solar-installers", "capabilities": [ "solar", "battery", "roof", "residential", "commercial", "industrial" ], "targetCouncils": [] } }, "maxResults": { "title": "Maximum returned leads", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of matched development application leads returned after filtering and scoring.", "default": 20 }, "minLeadScore": { "title": "Minimum lead score", "minimum": 0, "maximum": 100, "type": "integer", "description": "Only return development application leads with this score or higher.", "default": 55 }, "pageSize": { "title": "Page size", "minimum": 1, "maximum": 4000, "type": "integer", "description": "Records requested per NSW Planning Portal API page. The live default uses one large page for recent applications.", "default": 4000 }, "maxPages": { "title": "Maximum pages", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum API pages to fetch from the source.", "default": 1 } } }, "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 } } } } } } } } } }