{ "openapi": "3.0.1", "info": { "title": "AU Address Enrichment — planning, flood, NBN, schools, SEIFA", "description": "Enrich Australian addresses with public government data: planning zone + overlays, flood, bushfire, contaminated land, NBN tech & upgrade, mobile towers, nearest public transport, school zones, ABS SA1 + SEIFA. All states + ACT; tri-state output — never a blank that reads as \"no risk\".", "version": "0.6", "x-build-id": "1HRWOJyvHl8kZXGNA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/davidar~au-address-enrichment/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-davidar-au-address-enrichment", "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/davidar~au-address-enrichment/runs": { "post": { "operationId": "runs-sync-davidar-au-address-enrichment", "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/davidar~au-address-enrichment/run-sync": { "post": { "operationId": "run-sync-davidar-au-address-enrichment", "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": { "addresses": { "title": "Addresses", "uniqueItems": true, "type": "array", "description": "Australian street addresses, one per line. Include suburb and state or postcode (e.g. `10 Glenferrie Rd, Malvern VIC 3144`). Unit addresses in `1/79 Ormond Rd` form are supported. Up to 5000 per run.", "items": { "type": "string" } }, "records": { "title": "Records (advanced)", "type": "array", "description": "Alternative to `addresses`: objects with `id`, `address`, and optionally `lat`/`lng` (skips geocoding; the address text must still name the state). Useful for round-tripping your own IDs." }, "blocks": { "title": "Data blocks", "type": "array", "description": "Which enrichment blocks to run. Fewer blocks = faster; price per address is unchanged.", "items": { "type": "string", "enum": [ "planning", "flood", "contaminatedLand", "connectivity", "transport", "schools", "demographics", "electorates" ], "enumTitles": [ "Planning zone, overlays, bushfire-prone", "Flood (modelled 1% AEP, observed, parcel detail)", "Contaminated land / EPA", "Connectivity (NBN tech + upgrade eligibility, mobile-tower proximity)", "Public transport (nearest station / tram / bus)", "School zones (primary, year 7, year 12)", "Demographics (ABS SA1 + SEIFA 2021)", "Electorates (federal division, state district + upper-house region, council ward)" ] }, "default": [ "planning", "flood", "contaminatedLand", "connectivity", "transport", "schools", "demographics", "electorates" ] }, "nbn": { "title": "Query nbn address lookup", "type": "boolean", "description": "The NBN technology lookup uses nbn co's public address-check endpoint, which is not a documented API. Turn off if it becomes unavailable; the `connectivity.nbn` block is then reported as `unknown`.", "default": true }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Addresses processed in parallel. Government endpoints are shared infrastructure — keep this modest.", "default": 8 } } }, "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 } } } } } } } } } }