{ "openapi": "3.0.1", "info": { "title": "NZ Building Consents Monitor - New Consent Lead Alerts", "description": "Monitor NEW New Zealand building consents from official council open-data services. Filter by keyword (new dwelling, re-roof, solar, pool) and minimum job value in NZD, with coordinates on every consent. Emits only consents it has never seen - schedule it and feed your construction lead pipeline.", "version": "0.1", "x-build-id": "G5fUwd2tTKy5ZqXcY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datadeltas~nz-building-consents/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datadeltas-nz-building-consents", "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/datadeltas~nz-building-consents/runs": { "post": { "operationId": "runs-sync-datadeltas-nz-building-consents", "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/datadeltas~nz-building-consents/run-sync": { "post": { "operationId": "run-sync-datadeltas-nz-building-consents", "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": { "councils": { "title": "Councils", "type": "array", "description": "Which council open-data services to check. Default: all of them.", "items": { "type": "string", "enum": [ "queenstown_lakes", "far_north", "timaru" ], "enumTitles": [ "Queenstown Lakes District Council", "Far North District Council", "Timaru District Council" ] }, "default": [ "queenstown_lakes", "far_north", "timaru" ] }, "keywords": { "title": "Keywords", "type": "array", "description": "Only emit consents whose description, consent type or address contains one of these (case-insensitive substring match, so 'roof' also matches 're-roofing'). Leave empty for all consents.", "items": { "type": "string" } }, "minValueNZD": { "title": "Minimum job value (NZD)", "minimum": 0, "type": "integer", "description": "Only emit consents with a stated job value of at least this many NZD. IMPORTANT: only Queenstown Lakes and Timaru publish a job value - setting this excludes every Far North consent.", "default": 0 }, "sinceDays": { "title": "Backfill window (days)", "minimum": 1, "maximum": 365, "type": "integer", "description": "How many days of consents to scan. On the first run this is your backfill; later runs emit only consents never seen before. Timaru publishes 2-3 weeks in arrears, so its own lookback is always widened to at least 45 days.", "default": 30 }, "maxItems": { "title": "Max new consents per run", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Cap on new consents emitted in a single run (cost control). The cap is split fairly across the councils that returned data, and anything over it is picked up on the next run.", "default": 200 }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Named key-value store holding the consent numbers already delivered. Change it to reset the monitor and re-emit the backfill.", "default": "nz-building-consents-state" } } }, "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 } } } } } } } } } }