{ "openapi": "3.0.1", "info": { "title": "Australian Address API - G-NAF, Parcels, Buildings", "description": "Australian address verification and property data: autocomplete and geocode against the national address file with a match score, reverse geocode a coordinate, then read the cadastre parcel, property, building footprint, height, roof, solar and pool, plus the areas around it.", "version": "0.1", "x-build-id": "ntaHNXSqVnKl2hRex" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~australian-address-data-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-australian-address-data-api", "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/nabeelbaghoor~australian-address-data-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-australian-address-data-api", "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/nabeelbaghoor~australian-address-data-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-australian-address-data-api", "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": { "mode": { "title": "What to do", "enum": [ "suggestAddresses", "suggestLocalities", "predictiveAddress", "geocode", "reverseGeocode", "addressAttributes", "mailPoint", "addressesByParcel", "addressesByProperty", "buildingById", "buildingRelations", "buildingsByPoint", "buildingsByBoundingBox", "buildingsByIdentifier", "cadastreById", "cadastresByParcel", "cadastresByPoint", "cadastresByBoundingBox", "cadastresByIdentifier", "propertyById", "propertiesByPoint", "propertiesByBoundingBox", "propertiesByIdentifier", "boundariesByPoint", "boundariesByIdentifier", "listDatasets" ], "type": "string", "description": "Suggest autocompletes a partial address or locality. Geocode matches a full or partial address and says how well it matched. Reverse geocode does the same from a coordinate. Address attributes reads everything known about one address ID. Mail point returns the delivery point identifier and barcode. The building, cadastre and property modes find features by identifier, point or bounding box, and boundaries says which administrative areas cover a point.", "default": "geocode" }, "queries": { "title": "Addresses or localities", "type": "array", "description": "One address, suburb or postcode per line, for the suggest, geocode and mail point modes. Address suggestions need at least four characters.", "items": { "type": "string" } }, "points": { "title": "Points", "type": "array", "description": "One \"latitude,longitude\" pair per line, in that order. Several of the provider's own paths take longitude first, so the order is fixed for you here: a swapped pair returns a real place somewhere else rather than an error.", "items": { "type": "string" } }, "boundingBoxes": { "title": "Bounding boxes", "type": "array", "description": "One box per line as four comma separated numbers: bottom left longitude, bottom left latitude, top right longitude, top right latitude, to five decimal places or fewer.", "items": { "type": "string" } }, "identifiers": { "title": "Identifiers", "type": "array", "description": "One identifier per line: an address ID, suggestion ID, land registry parcel ID, cadastre PID, property PID, building PID or boundary identifier, depending on the mode.", "items": { "type": "string" } }, "identifierType": { "title": "Identifier type", "enum": [ "", "addressId", "propertyPid", "cadastrePid", "parcelId", "contributorId" ], "type": "string", "description": "Which identifier the find-by-identifier modes are given. These endpoints accept several and require none, so the wrong one returns an empty answer rather than an error. Leave empty to use the sensible default for the mode.", "default": "" }, "crs": { "title": "Coordinate reference system", "enum": [ "gda94", "gda2020", "wgs84" ], "type": "string", "description": "Which datum coordinates come back in. The provider defaults to GDA94, which is about 1.8 metres from WGS84 in Australia and looks identical to the eye, so the choice is recorded on every row. Pick GDA2020 for current Australian survey data, or WGS84 to plot on a web map.", "default": "gda94" }, "includeGeometry": { "title": "Include full geometry", "type": "boolean", "description": "Write the complete GeoJSON geometry onto each row. Off by default: a cadastre or building footprint is a full coordinate ring, and every row already carries a centroid and the geometry type.", "default": false }, "resultsPerAddress": { "title": "Results per subject", "type": "integer", "description": "How many matches to ask for per address or point. Suggestions are capped at 20 by the provider and clamped here.", "default": 5 }, "stateFilter": { "title": "States and territories", "type": "array", "description": "Restrict results to these states and territories. Leave empty for all of Australia.", "items": { "type": "string", "enum": [ "ACT", "NSW", "NT", "QLD", "SA", "TAS", "VIC", "WA", "OT" ], "enumTitles": [ "Australian Capital Territory", "New South Wales", "Northern Territory", "Queensland", "South Australia", "Tasmania", "Victoria", "Western Australia", "Other territories" ] } }, "matchTypes": { "title": "Accepted match types", "type": "array", "description": "What the geocoder is allowed to match at. Leave empty to accept the provider default, which falls back from address to street to locality.", "items": { "type": "string", "enum": [ "address", "streetLocality", "locality", "street", "primaryAddress", "secondaryAddress" ], "enumTitles": [ "Address", "Street and locality", "Locality", "Street", "Primary address", "Secondary address" ] } }, "minGeoFeatureLevel": { "title": "Minimum feature level", "enum": [ "", "address", "approximate", "streetLocality", "locality" ], "type": "string", "description": "The coarsest geocoded feature this run will accept. Set it to address if a suburb centroid is not an answer you can use.", "default": "" }, "addressDataset": { "title": "Address dataset", "enum": [ "", "gnaf", "continuousAddress" ], "type": "string", "description": "Which address dataset the geocoder searches: the national address file, or the continuous address dataset that also covers addresses the national file has not adopted yet.", "default": "" }, "predictiveDataset": { "title": "Suggestion dataset", "enum": [ "", "gnaf", "gnaflive", "mailAddress", "all", "gnaf,gnaflive", "gnaf,mailAddress", "mailAddress,gnaflive" ], "type": "string", "description": "Which dataset address suggestions come from: the national address file, the live file, mail addresses, or a combination.", "default": "" }, "addressType": { "title": "Address type", "enum": [ "", "physical", "mailing", "all" ], "type": "string", "description": "Restrict suggestions to physical addresses, mailing addresses, or both.", "default": "" }, "addressBundles": { "title": "Address bundles", "type": "array", "description": "Extra data to attach to each address: statistical areas, remoteness, buildings, electorates, local government area, the parcel and property behind it, socioeconomic indexes and solar panel data. Each bundle adds columns and may be entitled separately.", "items": { "type": "string", "enum": [ "asgsMain", "asgsRemoteness", "buildings", "commonwealthElectorate", "localGovernmentArea", "parcelBundle", "propertyBundle", "seifa", "stateElectorate", "stateElectorateBundle", "solarPanelBundle" ], "enumTitles": [ "ABS main structure", "ABS remoteness", "Buildings", "Commonwealth electorate", "Local government area", "Parcel bundle", "Property bundle", "SEIFA indexes", "State electorate", "State electorate bundle", "Solar panel bundle" ] } }, "excludeAliases": { "title": "Exclude alias addresses", "type": "boolean", "description": "Leave out alias addresses, which are alternative forms of an address that resolve to the same place.", "default": false }, "excludePrimaryWithSecondary": { "title": "Exclude primary with secondary", "type": "boolean", "description": "Leave out a primary address when it has related secondary addresses, so a block of units suggests its units rather than the block.", "default": false }, "buildingAttributes": { "title": "Building attributes", "type": "array", "description": "Extra building attributes to return: swimming pool indicator, height, roof material and shape, and solar panels. Each may be entitled separately.", "items": { "type": "string", "enum": [ "poolIndicator", "height", "roof", "solar" ], "enumTitles": [ "Pool indicator", "Height", "Roof", "Solar" ] } }, "includePlanning": { "title": "Include planning bundle", "type": "boolean", "description": "Attach the planning bundle to cadastre parcels, where your plan includes it.", "default": false }, "radiusMetres": { "title": "Search radius in metres", "type": "integer", "description": "Search this far around a point, from 1 to 500 metres. Leave empty to return only what the point falls inside." }, "baseParcelsOnly": { "title": "Base parcels only", "type": "boolean", "description": "Return only base cadastre parcels, leaving out the strata and subdivision parcels stacked on top of them.", "default": false }, "basePropertiesOnly": { "title": "Base properties only", "type": "boolean", "description": "Return only base properties, leaving out the derived ones above them.", "default": false }, "buildingRelation": { "title": "Building relation", "enum": [ "addresses", "cadastre", "properties" ], "type": "string", "description": "Which relation of a building to read in the building relations mode.", "default": "addresses" }, "boundaryLayers": { "title": "Boundary layers", "type": "array", "description": "Which administrative layers to return at a point: localities, ABS mesh blocks and remoteness and socioeconomic areas by census year, state and commonwealth electorates, and local government areas. Leave empty for the provider default.", "items": { "type": "string", "enum": [ "localities", "absBoundariesMeshBlock2011", "absBoundariesMeshBlock2016", "absBoundariesMeshBlock2021", "absBoundariesRemoteness2016", "absBoundariesRemoteness2021", "absBoundariesSeifa2021", "electoralBoundariesState", "electoralBoundariesCommonwealth", "localGovernmentAreas" ], "enumTitles": [ "Localities", "ABS mesh blocks 2011", "ABS mesh blocks 2016", "ABS mesh blocks 2021", "ABS remoteness 2016", "ABS remoteness 2021", "ABS SEIFA 2021", "State electorates", "Commonwealth electorates", "Local government areas" ] } }, "mailMatchType": { "title": "Mail point match type", "enum": [ "", "address", "street", "locality" ], "type": "string", "description": "What the mail point service is allowed to match at. Mail point is a Pro or Enterprise feature on this API.", "default": "" }, "barcodeFormat": { "title": "Barcode format", "enum": [ "", "37Bar", "52Bar", "67Bar" ], "type": "string", "description": "Which barcode length the mail point service returns.", "default": "" }, "postalDeliveryIdentifier": { "title": "Postal delivery identifier", "type": "string", "description": "The box or bag number for a postal delivery address, used by mail point." }, "postalDeliveryTypeCode": { "title": "Postal delivery type", "type": "string", "description": "The postal delivery type for a postal address, for example PO BOX or RMB, used by mail point." }, "complexUnitType": { "title": "Unit type", "type": "string", "description": "Unit type for a structured address search, for example Unit or Flat." }, "complexUnitIdentifier": { "title": "Unit identifier", "type": "string", "description": "Unit identifier for a structured address search, including any prefix or suffix." }, "complexLevelType": { "title": "Level type", "type": "string", "description": "Level type for a structured address search, for example Level or Floor." }, "complexLevelNumber": { "title": "Level number", "type": "string", "description": "Level identifier for a structured address search, including any prefix or suffix." }, "streetNumber1": { "title": "Street number", "type": "string", "description": "First street number for a structured address search, including any prefix or suffix." }, "streetNumber2": { "title": "Street number to", "type": "string", "description": "Second street number for a structured address search, for a range such as 12-14." }, "streetName": { "title": "Street name", "type": "string", "description": "Street name for a structured address search, without the street type." }, "streetType": { "title": "Street type", "type": "string", "description": "Street type for a structured address search, for example AV, RD or ST." }, "streetSuffix": { "title": "Street suffix", "type": "string", "description": "Street suffix for a structured address search, for example West in Smith St West." }, "siteName": { "title": "Site or building name", "type": "string", "description": "Site or building name for a structured address search." }, "lotIdentifier": { "title": "Lot identifier", "type": "string", "description": "Lot identifier for a structured address search, used where a property has no street number yet." }, "localityName": { "title": "Locality", "type": "string", "description": "Suburb or locality name for a structured address search." }, "stateTerritory": { "title": "State or territory", "type": "string", "description": "State or territory for a structured address search, for example NSW." }, "postcode": { "title": "Postcode", "type": "string", "description": "Postcode for a structured address search." }, "datasetProduct": { "title": "Dataset product", "enum": [ "", "ABS BOUNDARIES", "ABS-ASGS-2026-MAIN-STRUCTURE", "ADMINISTRATIVE BOUNDARIES", "ELECTORAL BOUNDARIES", "G-NAF CORE", "G-NAF", "GEOSCAPE AIRPORTS", "GEOSCAPE BUILDINGS", "GEOSCAPE CADASTRE", "GEOSCAPE GREENSPACE", "GEOSCAPE HYDROLOGY", "GEOSCAPE LOCAL GOVERNMENT AREAS", "GEOSCAPE LOCALITIES", "GEOSCAPE PLANNING", "GEOSCAPE PROPERTY", "GEOSCAPE RAIL", "GEOSCAPE ROADS", "GEOSCAPE SOLAR", "GEOSCAPE SURFACE COVER", "GEOSCAPE TREES", "GEOSCAPE WARDS", "POSTCODE BOUNDARIES", "STATE BOUNDARIES", "TOWN POINTS", "BUILDINGS", "BUILDING-HEIGHT", "BUILDING-ROOF", "BUILDING-SOLAR", "ADDRESS-POOL" ], "type": "string", "description": "Filter the dataset catalogue to one product.", "default": "" }, "datasetRegion": { "title": "Dataset region", "enum": [ "", "AUSTRALIA", "ALL STATES", "ACTNSW", "ACT", "NSW", "NT", "QLD", "SA", "TAS", "VIC", "WA", "OT" ], "type": "string", "description": "Filter the dataset catalogue to one region or state.", "default": "" }, "datasetFormat": { "title": "Dataset format", "enum": [ "", "GDB", "GEOJSON", "SHP", "TAB", "LYNX", "PUMP", "GEOTIFF", "PSV" ], "type": "string", "description": "Filter the dataset catalogue to one delivery format.", "default": "" }, "datasetRelease": { "title": "Dataset release", "type": "string", "description": "Filter the dataset catalogue by release, as YYYY-MM, a comma separated start and end, or the word latest." }, "datasetQuery": { "title": "Dataset search text", "type": "string", "description": "Free text search across the dataset catalogue." }, "licencedDatasetsOnly": { "title": "Licensed datasets only", "type": "boolean", "description": "List only the datasets this account is licensed to download.", "default": false }, "pageSize": { "title": "Features per request", "type": "integer", "description": "How many features to ask for per request on the paged modes. A run never asks for more rows than it is allowed to keep.", "default": 100 }, "maxResults": { "title": "Maximum rows", "type": "integer", "description": "Stop after this many rows. Counts every row: suggestions, addresses, features, boundaries and catalogue entries alike.", "default": 100 }, "requestsPerMinute": { "title": "Requests per minute", "type": "integer", "description": "How fast to call the provider. The default of 120 is two a second, which is the free plan ceiling; raise it to 600 on a Team plan, 1200 on Professional.", "default": 120 }, "apiKey": { "title": "API key", "type": "string", "description": "Your own account key, created in your provider account. Sent in an Authorization header with no scheme word in front of it, which is what this API expects. Stored encrypted and never written into the dataset. Can also be supplied as the DATA_API_KEY environment secret." }, "baseUrl": { "title": "API host", "type": "string", "description": "Overrides the host the API is called on. Leave empty unless the provider has given you a different one." } } }, "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 } } } } } } } } } }