Schemas
VerifyV1_emailValidateRequest
emailEmail address to check. Surrounding whitespace is trimmed and the domain lowercased. The local part is preserved. Values within the request length limit can still fail syntax validation.
VerifyV1_emailValidateResponse
attributionData attribution notice.
requestTimeStampUnix timestamp in seconds for the response.
requestDateTimeUTC date and time for the request.
The request body echoed exactly as supplied.
validTrue only when syntax.valid and domain.has_mx are both true. Does not confirm mailbox existence. Category flags do not change this verdict.
Result of the syntax check, and the tidied form of the address that was validated. Always present.
Checks performed, credit cost, request ID, and processing time. Always present.
Domain lookup and category results. Omitted when syntax validation fails and no DNS lookup runs.
VerifyV1_syntaxResult
validTrue when the normalised address passes the supported syntax checks. See Interpreting Results for rejected input forms.
local_partEverything before the last @. The whole input when there is no @, and empty when the input begins with @.
domainEverything after the last @, lowercased. Empty when the input has no @.
normalizedAddress checked after trimming surrounding whitespace and lowercasing the domain. The local part is preserved.
VerifyV1_domainResult
existsTrue when the domain resolves in DNS. False only when the name does not exist at all (NXDOMAIN).
has_mxTrue when the domain publishes at least one usable MX record. False for no MX records or a null MX declaring that no email is accepted.
consumer_email_providerTrue when the domain is a known consumer email provider.
disposableTrue when the domain is known to provide disposable email.
The MX records found, lowest priority value first. Empty whenever has_mx is false.
VerifyV1_mxRecord
hostThe mail exchanger hostname, with the DNS root label stripped.
priorityMX preference value. Lower values are preferred. Multiple records can share a priority.
VerifyV1_emailResponseMeta
checks_performedThe checks that actually ran, in order. dns is absent when the syntax check failed and no lookup was attempted.
billable_unitsCredits charged for this call. Always matches the x-attr-basicTransaction response header. Charged on every well formed request, including one rejected on syntax alone.
request_id^req_[0-9a-f]{6}$ · requiredCorrelation id for this request, logged server side alongside the outcome. Quote it when raising a support ticket.
processing_msElapsed validation time in milliseconds. Varies by request, including syntax-only checks.
VerifyV1_phoneValidateRequest
phonePhone number to check. Digits, spaces, brackets, dashes, dots, plus signs, a national trunk prefix, an explicit country code, and international dialling prefixes are accepted. Numbers without a country code are interpreted as Australian numbers.
VerifyV1_phoneValidateResponse
attributionData attribution notice.
requestTimeStampUnix timestamp in seconds for the response.
requestDateTimeUTC date and time for the request.
The request body echoed exactly as supplied.
validTrue when the parsed number matches a valid numbering range. Mirrors number_details.valid; does not confirm ownership or connection.
Number formats. Always present. Fields are omitted when unavailable, and the object is empty when parsing fails.
What the number itself tells us. Always present. Unavailable values are omitted.
Checks performed, credit cost, request ID, and processing time. Always present.
VerifyV1_phoneFormat
e164Canonical E.164 form for storage and comparison. Starts with + followed by digits, without spaces.
internationalHow the number would be dialled from outside its own country, spaced for reading.
nationalHow the number would be dialled inside its own country, including the national trunk prefix.
rfc3966RFC 3966 tel: URI, ready to drop into a click to call link.
VerifyV1_numberDetails
timezonesIANA timezone names associated with the numbering range. Can contain several zones. Empty when no zone is known.
typeNumber type derived from its numbering range. See Interpreting Results for value definitions.
possibleTrue when the number has a plausible length for its country and type. A possible number can still be invalid.
validTrue when the parsed number matches a valid numbering range. Does not confirm that the number is connected.
country_codeThe country calling code. Present whenever the input parsed, even for a number that turned out to be invalid. Omitted when nothing parsed.
region_codeISO 3166-1 alpha-2 region associated with the number. Omitted when a region cannot be determined.
country_nameEnglish name of that region. Omitted whenever region_code is omitted.
locationGeographic area associated with the number prefix, when available. Omitted for Australian mobiles and non-geographic numbers. Does not report the phone's live location.
VerifyV1_phoneResponseMeta
checks_performedChecks that ran, in order. Only parse is listed when parsing fails. Otherwise parse, validate, format, and location are listed.
billable_unitsCredits charged for this call. Always matches the x-attr-basicTransaction response header. One credit per call, charged on every well formed request including one where the input was not a number.
request_id^req_[0-9a-f]{6}$ · requiredRequest correlation ID. Quote it when contacting support.
processing_msElapsed check time in milliseconds. Varies by request.
VerifyV1_addressValidateAURequest
queryThe address string to check.
VerifyV1_addressAutocompleteAURequest
queryPartial address to search for. Leading and trailing whitespace is removed before checking the 3–200 character length.
typeType of suggestion to return. Only address is supported.
maxResultsThe maximum number of results per search.
VerifyV1_addressGeocodeAURequest
queryThe address string to search for.
maxResultsThe maximum number of results per search.
VerifyV1_addressReverseGeocodeAURequest
latitudeLatitude in decimal degrees. Both bounds are inclusive for Australian coverage.
longitudeLongitude in decimal degrees. Both bounds are inclusive for Australian coverage.
maxResultsThe maximum number of results per search.
VerifyV1_addressInfoAURequest
id^[A-Za-z0-9_-]+$ · requiredAddress identifier. Letters, digits, underscores and hyphens are accepted.
VerifyV1_mailpointValidateAURequest
queryThe address string to search for.
VerifyV1_verifyResponseMetadata
attributionData attribution notice.
requestTimeStampUnix timestamp in seconds for the response.
requestDateTimeUTC date and time for the request.
VerifyV1_addressAutocompleteAUResponse
attributionData attribution notice.
requestTimeStampUnix timestamp in seconds for the response.
requestDateTimeUTC date and time for the request.
VerifyV1_addressValidateAUResponse
attributionData attribution notice.
requestTimeStampUnix timestamp in seconds for the response.
requestDateTimeUTC date and time for the request.
nextActionRecommended action based on the first candidate. Exact returns ACCEPT, Confident returns ACCEPT_WITH_CHANGES, and other quality levels or no candidate return DENY. A denied candidate can still have id and formatted values.
idMatched address identifier. Omitted when no identifier is available.
formattedMatched formatted address. Omitted when no match is available.
VerifyV1_addressGeometry
typeGeometry type returned with the point coordinates.
coordinatesPoint coordinates in [longitude, latitude] order, in decimal degrees using GDA94 (EPSG:4283).
VerifyV1_addressFeaturePropertiesAU
rankResult rank starting at 1.
formattedFormatted address label. Omitted when unavailable.
VerifyV1_addressGeocodeFeatureAU
typeidAddress identifier, when present on the matched feature.
VerifyV1_addressReverseGeocodeFeatureAU
typeidAddress identifier, when present on the matched feature.
matchDistanceDistance from the supplied query point to the returned address point, in metres. Omitted when unavailable.
VerifyV1_addressGeocodeAUResponse
attributionData attribution notice.
requestTimeStampUnix timestamp in seconds for the response.
requestDateTimeUTC date and time for the request.
typecrsCoordinate reference system of the returned geometry (GDA94).
VerifyV1_addressReverseGeocodeAUResponse
attributionData attribution notice.
requestTimeStampUnix timestamp in seconds for the response.
requestDateTimeUTC date and time for the request.
typecrsCoordinate reference system of the returned geometry (GDA94).
VerifyV1_addressInfoAUResponse
attributionData attribution notice.
requestTimeStampUnix timestamp in seconds for the response.
requestDateTimeUTC date and time for the request.
typecrsCoordinate reference system of the returned geometry (GDA94).
Address attributes. The formatted address label is named formatted. Empty when the ID has no match.
VerifyV1_mailpointPropertiesAU
dpidAustralia Post Delivery Point Identifier. Keep as a string. 00000000 indicates no match.
barcodeAustralia Post 4-State barcode encoded as bar-state digits 0–3, rather than an image. Omitted when unavailable or no match is found.
formattedMatched postal address label. Omitted when no match is found.
streetNameStreet name.
streetTypeStreet type abbreviation.
streetTypeDescriptionFull street type description.
localityNamePostal locality name.
stateTerritoryState or territory abbreviation.
postcodePostal code. Keep as a string.
streetNumber1First street number.
complexUnitTypeUnit type code.
complexUnitTypeDescriptionFull unit type description.
complexUnitNumberUnit number, when returned.
complexUnitIdentifierUnit identifier, including any prefix or suffix.
streetNumber2Second street number in an address range.
complexLevelTypeLevel type code.
complexLevelTypeDescriptionFull level type description.
complexLevelNumberLevel number.
lotIdentifierLot identifier.
siteNameSite or building name.
streetSuffixStreet suffix.
postalDeliveryTypeCodePostal delivery type code, such as PO BOX.
postalDeliveryIdentifierIdentifier for the postal delivery service, such as its box number.
VerifyV1_mailpointValidateAUResponse
attributionData attribution notice.
requestTimeStampUnix timestamp in seconds for the response.
requestDateTimeUTC date and time for the request.
typecrsCoordinate reference system of the returned geometry (GDA94).
pafVersionVersion of the Australia Post Postal Address File (PAF) used for matching.
pafExpiryExpiry date of the PAF release, in DD-MM-YYYY format.
matchScorePostal match score from 0 to 100. It is not a probability. Zero indicates no match.
matchTypePostal match level, when available: address, street, or locality. A broader match does not confirm a specific delivery address.
VerifyV1_verifyError
typeError category. See Verify errors for definitions and recovery guidance.
descriptionDescription of the failure. Use type and field for application handling rather than matching this text.
fieldRequest field associated with the error, when identifiable. Omitted for errors without a field, including malformed JSON. Nested field paths use dot notation.
VerifyV1_verifyErrorResponse
error_countNumber of entries in the errors array.
Errors that prevented the request from completing.
inputSubmitted request body echoed in a Verify error. Can include rejected fields or values. Malformed JSON is echoed as a raw string.
attributionData attribution notice.
timestampUnix timestamp in seconds for the error response. Successful responses use requestTimeStamp instead.
requestDateTimeUTC date and time of the error response.
AddressesV2_Error.v2
messagesHuman-readable diagnostic messages. Wording may vary. Do not use it as a stable error code.
requestTimeStampRequest time in seconds since the Unix epoch (1970-01-01T00:00:00Z), including fractional seconds.
requestDateTimeRequest time in UTC in ISO 8601 form. The timezone suffix may be omitted.
AddressesV2_AsgsMain.v2
The JSON model of the ASGS Main Object
censusYearmbIdmbCategoryCodembDwellingCountNumber of dwellings in the mesh block for censusYear, returned as a numeric string. Not available for ASGS 2026.
mbPopCountPopulation count for the mesh block for censusYear, returned as a numeric string. Not available for ASGS 2026.
mbAreaSqmMesh-block area in square metres (m²), rounded to a whole square metre and returned as a numeric string.
sa1Idsa2Idsa2Namesa3Idsa3Namesa4Idsa4NamegccsaIdgccsaNameAddressesV2_AsgsRemoteness.v2
The JSON model of the ASGS Remoteness Object
censusYearcategoryNamecategoryCodecodepolygonPiddateCreatedpidstatePidareaSqmArea of the remoteness-region polygon in square metres (m²), rounded to a whole square metre and returned as a numeric string. Available for the 2021 layer.
AddressesV2_CommonwealthElectorate.v2
commElectoralNamecommElectoralPidAddressesV2_Geocoder.v2
typequeryAddress components parsed from the input, including tokens that may not belong to an official address. Parsing does not confirm that the address exists.
Matched candidates, or an empty array when no match is found.
messagesSupplementary information about the request or result. A message can accompany a successful 200 response.
requestTimeStampRequest time in seconds since the Unix epoch (1970-01-01T00:00:00Z), including fractional seconds.
requestDateTimeRequest time in UTC in ISO 8601 form. The timezone suffix may be omitted.
attributionAddressesV2_GetAddress.v2
typeBase attributes for an address, street, or locality. Optional fields depend on the matched record. Requested additional properties appear here when available.
requestTimeStampRequest time in seconds since the Unix epoch (1970-01-01T00:00:00Z), including fractional seconds.
requestDateTimeRequest time in UTC in ISO 8601 form. The timezone suffix may be omitted.
attributionRights notice for the data returned
messagesSupplementary information about the request or result. A message can accompany a successful 200 response.
AddressesV2_FindByParcelId.v2
typemessagesSupplementary information about the request or result. A message can accompany a successful 200 response.
requestTimeStampRequest time in seconds since the Unix epoch (1970-01-01T00:00:00Z), including fractional seconds.
requestDateTimeRequest time in UTC in ISO 8601 form. The timezone suffix may be omitted.
attributionqueryPagination counts and URLs. next and prev are omitted when unavailable.
AddressesV2_FindByPropertyId.v2
typemessagesSupplementary information about the request or result. A message can accompany a successful 200 response.
requestTimeStampRequest time in seconds since the Unix epoch (1970-01-01T00:00:00Z), including fractional seconds.
requestDateTimeRequest time in UTC in ISO 8601 form. The timezone suffix may be omitted.
attributionqueryPagination counts and URLs. next and prev are omitted when unavailable.
AddressesV2_LocalGovernmentArea.v2
lgaNamelgaPidlgaShortNameAddressesV2_MailPoint.v2
typequerypafVersionPAF release used for matching.
pafExpiryExpiry date of the PAF release.
matchScorePostal diagnostic score from 0 to 100. The value is assigned from the match diagnostic group, not a probability or percentage. No match returns 0. Review matchDiagnostic and matchDiagnosticMessage before accepting the result.
Address components parsed from the input, including tokens that may not belong to an official address. Parsing does not confirm that the address exists.
messagesSupplementary information about the request or result. A message can accompany a successful 200 response.
requestTimeStampRequest time in seconds since the Unix epoch (1970-01-01T00:00:00Z), including fractional seconds.
requestDateTimeRequest time in UTC in ISO 8601 form. The timezone suffix may be omitted.
attributionMatched postal address and DPID. Omitted by default when no match is found.
matchDiagnosticDiagnostic code for the postal match.
matchDiagnosticMessageHuman-readable explanation of the diagnostic code.
matchTypeLevel of the matched DPID: address, street, or locality. Omitted when no match is found.
AddressesV2_matchCode
siteNamecomplexUnitIdentifiercomplexLevelNumberstreetNumber1streetNumber2streetNamestreetTypelocalityNamestateTerritorypostcodecomplexUnitTypeDescriptioncomplexLevelTypeDescriptionlotIdentifierstreetSuffixcadastralIdentifierAddressesV2_ParcelBundle.v2
cadastrePidcadastrePolygonPidIdentifier of the parcel polygon.
dateCreatedstatesourceparcelTypeareaArea of the parcel polygon in square metres (m²).
contributorIddateModifiedlotplansectionSection identifier supplied by the jurisdiction, where available.
parcelIdcontributorStatustitleStatusbaseParcelstrataTypetotalStrataCountTotal number of strata associated with a base parcel. May be supplied without separate horizontal and vertical counts when the types cannot be distinguished.
horizontalStrataCountNumber of horizontal strata associated with the base parcel.
verticalStrataCountNumber of vertical strata associated with the base parcel.
AddressesV2_ParsedAddress
complexLevelNumbercomplexLevelTypecomplexStreetNamecomplexUnitIdentifiercomplexUnitTypestreetNumberDenoterblockDenoterblockNumberDenotersectionDenotersectionNumberDenoterstreetNumber1streetNumber2streetSuffixstreetNamestreetTypelocalityNamestateTerritorypostcodedeliveryPointIdentifierpostalDeliveryIdentifierpostalDeliveryTypeCodesiteNamelotIdentifiercadastralIdentifiercountryAddressesV2_Properties.v2
formattedAddressFormatted address label for the matched record.
localityNameLocality or suburb name.
stateTerritoryState or territory abbreviation, for example ACT, NSW, or VIC.
localityNeighbourNames of neighbouring localities.
localityAliasAlternative names for the locality.
datasetComma-separated source dataset names, such as gnaf,continuousAddress.
addressIdIdentifier for use with the address-by-ID endpoint.
jurisdictionIdAddress identifier assigned by the contributing jurisdiction.
addressRecordTypePRIMARY identifies a primary address. SECONDARY identifies a sub-address, such as a unit.
aliasPrincipalPRINCIPAL identifies the principal record. ALIAS identifies an alternative address for the same location.
geoFeatureType of geocode used for the point. See geocode point guidance.
cadastralIdentifierJurisdictional parcel identifier for findByParcel. JSON escapes each backslash as \\. Decode the string before URL-encoding it. See JSON string escaping.
postcodeFour-digit postcode. Keep leading zeros.
streetNameStreet name without its type or suffix.
streetNumber1First street number, including any prefix or suffix.
streetNumber2Last street number in a range, including any prefix or suffix.
complexUnitNumberDeprecated unit number. Use complexUnitIdentifier.
complexUnitIdentifierUnit identifier, including any prefix or suffix.
complexUnitTypeUnit type, for example UNIT or FLAT.
complexUnitTypeDescriptionFull description of the unit type code.
siteNameBuilding or site name.
streetTypeStreet type or abbreviation, for example AV, RD, or ST.
streetTypeDescriptionFull description of the street type code.
lotIdentifierLot identifier, including any prefix or suffix.
streetSuffixStreet direction or suffix, for example WEST in Smith St West.
streetPrefixPrefix preceding the street name, where present.
complexLevelIdentifierDeprecated level identifier. Use complexLevelNumber.
complexLevelTypeLevel type, for example LEVEL or FLOOR.
complexLevelTypeDescriptionFull description of the level type code.
The JSON model of the ASGS Main Object
The JSON model of the ASGS Remoteness Object
The JSON model of the Commonwealth Electorate Object
The JSON model of Local Government Area Object
relatedBuildingIdsAn array of related building ID strings
The JSON model of the State Electorate object.
ID information for the current effective "State Electorate" object. For all retired, effective and gazetted State Electorate objects use stateElectorateBundle additionalProperty. For full details, including geometry, see Geoscape Administrative Boundaries API product.
For stateElectoralClassCode definitions, please see: STATE_ELECTORAL_CLASS_AUT in "Geoscape Electoral Boundaries" product. See documentations: https://geoscape.com.au/documentation/
The JSON model of the Solar Panel Bundle object
SEIFA records by census year, ordered newest first. Identifiers differ between census releases.
localityIdIdentifier of the matched locality.
streetLocalityIdIdentifier of the street within its locality.
streetAliasAlternative names for the street.
contributorPropertyIdJurisdictional property identifier for use with findByProperty.
postalDeliveryNumberPostal delivery number, where supplied by the address record.
postalDeliveryTypePostal delivery type, where supplied by the address record.
complexLevelNumberLevel identifier, including any prefix or suffix.
AddressesV2_PropertyBundle.v2
propertyPidpropertyPolygonPidcontributorIddateCreatedstatesourcebasePropertyareaArea of the property polygon in square metres (m²).
dateModifiedcadastrePidsA list of cadastral PIDs
parcelIdsAddressesV2_ReverseGeocoder.v2
typequeryMatched candidates, or an empty array when no match is found.
messagesSupplementary information about the request or result. A message can accompany a successful 200 response.
requestTimeStampRequest time in seconds since the Unix epoch (1970-01-01T00:00:00Z), including fractional seconds.
requestDateTimeRequest time in UTC in ISO 8601 form. The timezone suffix may be omitted.
attributionRights notice for the data returned
AddressesV2_Seifa2011.v2
seifa2011PiddateCreatedsa12011PidpopulationPopulation count for the Statistical Area Level 1 (SA1) for censusYear, returned as a numeric string. This is an area-level count, not a count at the address.
censusYeardateRetiredirsadScoreUnitless Index of Relative Socio-economic Advantage and Disadvantage (IRSAD) score for the SA1, returned as a numeric string. Scores are standardised to a national SA1 mean of 1,000 and standard deviation of 100. Higher values indicate greater relative advantage and less disadvantage. Scores are not percentages or quantities of advantage.
irsadAusRankIRSAD rank of the SA1 within Australia, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
irsadAusDecileIRSAD decile group within Australia, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
irsadAusPercentIRSAD percentile group within Australia, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
irsadStRankIRSAD rank of the SA1 within the same state or territory, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
irsadStDecileIRSAD decile group within the same state or territory, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
irsadStPercentIRSAD percentile group within the same state or territory, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
irsdScoreUnitless Index of Relative Socio-economic Disadvantage (IRSD) score for the SA1, returned as a numeric string. Scores are standardised to a national SA1 mean of 1,000 and standard deviation of 100. Higher values indicate less relative disadvantage. Scores are not percentages or quantities of advantage.
irsdAusRankIRSD rank of the SA1 within Australia, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
irsdAusDecileIRSD decile group within Australia, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
irsdAusPercentIRSD percentile group within Australia, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
irsdStRankIRSD rank of the SA1 within the same state or territory, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
irsdStDecileIRSD decile group within the same state or territory, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
irsdStPercentIRSD percentile group within the same state or territory, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
ierScoreUnitless Index of Economic Resources (IER) score for the SA1, returned as a numeric string. Scores are standardised to a national SA1 mean of 1,000 and standard deviation of 100. Higher values indicate greater access to economic resources. Scores are not percentages or quantities of advantage.
ierAusRankIER rank of the SA1 within Australia, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
ierAusDecileIER decile group within Australia, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
ierAusPercentIER percentile group within Australia, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
ierStRankIER rank of the SA1 within the same state or territory, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
ierStDecileIER decile group within the same state or territory, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
ierStPercentIER percentile group within the same state or territory, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
ieoScoreUnitless Index of Education and Occupation (IEO) score for the SA1, returned as a numeric string. Scores are standardised to a national SA1 mean of 1,000 and standard deviation of 100. Higher values indicate higher educational attainment and occupational skill. Scores are not percentages or quantities of advantage.
ieoAusRankIEO rank of the SA1 within Australia, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
ieoAusDecileIEO decile group within Australia, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
ieoAusPercentIEO percentile group within Australia, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
ieoStRankIEO rank of the SA1 within the same state or territory, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
ieoStDecileIEO decile group within the same state or territory, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
ieoStPercentIEO percentile group within the same state or territory, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
AddressesV2_Seifa2016.v2
seifa2016PiddateCreatedsa12016PidpopulationPopulation count for the Statistical Area Level 1 (SA1) for censusYear, returned as a numeric string. This is an area-level count, not a count at the address.
censusYeardateRetiredirsadScoreUnitless Index of Relative Socio-economic Advantage and Disadvantage (IRSAD) score for the SA1, returned as a numeric string. Scores are standardised to a national SA1 mean of 1,000 and standard deviation of 100. Higher values indicate greater relative advantage and less disadvantage. Scores are not percentages or quantities of advantage.
irsadAusRankIRSAD rank of the SA1 within Australia, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
irsadAusDecileIRSAD decile group within Australia, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
irsadAusPercentIRSAD percentile group within Australia, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
irsadStRankIRSAD rank of the SA1 within the same state or territory, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
irsadStDecileIRSAD decile group within the same state or territory, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
irsadStPercentIRSAD percentile group within the same state or territory, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
irsdScoreUnitless Index of Relative Socio-economic Disadvantage (IRSD) score for the SA1, returned as a numeric string. Scores are standardised to a national SA1 mean of 1,000 and standard deviation of 100. Higher values indicate less relative disadvantage. Scores are not percentages or quantities of advantage.
irsdAusRankIRSD rank of the SA1 within Australia, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
irsdAusDecileIRSD decile group within Australia, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
irsdAusPercentIRSD percentile group within Australia, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
irsdStRankIRSD rank of the SA1 within the same state or territory, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
irsdStDecileIRSD decile group within the same state or territory, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
irsdStPercentIRSD percentile group within the same state or territory, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
ierScoreUnitless Index of Economic Resources (IER) score for the SA1, returned as a numeric string. Scores are standardised to a national SA1 mean of 1,000 and standard deviation of 100. Higher values indicate greater access to economic resources. Scores are not percentages or quantities of advantage.
ierAusRankIER rank of the SA1 within Australia, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
ierAusDecileIER decile group within Australia, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
ierAusPercentIER percentile group within Australia, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
ierStRankIER rank of the SA1 within the same state or territory, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
ierStDecileIER decile group within the same state or territory, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
ierStPercentIER percentile group within the same state or territory, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
ieoScoreUnitless Index of Education and Occupation (IEO) score for the SA1, returned as a numeric string. Scores are standardised to a national SA1 mean of 1,000 and standard deviation of 100. Higher values indicate higher educational attainment and occupational skill. Scores are not percentages or quantities of advantage.
ieoAusRankIEO rank of the SA1 within Australia, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
ieoAusDecileIEO decile group within Australia, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
ieoAusPercentIEO percentile group within Australia, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
ieoStRankIEO rank of the SA1 within the same state or territory, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
ieoStDecileIEO decile group within the same state or territory, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
ieoStPercentIEO percentile group within the same state or territory, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
AddressesV2_Seifa.v2
censusYearseifa2021PiddateCreatedsa12021PidpopulationPopulation count for the Statistical Area Level 1 (SA1) for censusYear, returned as a numeric string. This is an area-level count, not a count at the address.
irsadScoreUnitless Index of Relative Socio-economic Advantage and Disadvantage (IRSAD) score for the SA1, returned as a numeric string. Scores are standardised to a national SA1 mean of 1,000 and standard deviation of 100. Higher values indicate greater relative advantage and less disadvantage. Scores are not percentages or quantities of advantage.
irsadAusRankIRSAD rank of the SA1 within Australia, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
irsadAusDecileIRSAD decile group within Australia, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
irsadAusPercentIRSAD percentile group within Australia, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
irsadStRankIRSAD rank of the SA1 within the same state or territory, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
irsadStDecileIRSAD decile group within the same state or territory, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
irsadStPercentIRSAD percentile group within the same state or territory, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
irsdScoreUnitless Index of Relative Socio-economic Disadvantage (IRSD) score for the SA1, returned as a numeric string. Scores are standardised to a national SA1 mean of 1,000 and standard deviation of 100. Higher values indicate less relative disadvantage. Scores are not percentages or quantities of advantage.
irsdAusRankIRSD rank of the SA1 within Australia, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
irsdAusDecileIRSD decile group within Australia, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
irsdAusPercentIRSD percentile group within Australia, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
irsdStRankIRSD rank of the SA1 within the same state or territory, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
irsdStDecileIRSD decile group within the same state or territory, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
irsdStPercentIRSD percentile group within the same state or territory, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
ierScoreUnitless Index of Economic Resources (IER) score for the SA1, returned as a numeric string. Scores are standardised to a national SA1 mean of 1,000 and standard deviation of 100. Higher values indicate greater access to economic resources. Scores are not percentages or quantities of advantage.
ierAusRankIER rank of the SA1 within Australia, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
ierAusDecileIER decile group within Australia, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
ierAusPercentIER percentile group within Australia, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
ierStDecileIER decile group within the same state or territory, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
ierStPercentIER percentile group within the same state or territory, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
ieoScoreUnitless Index of Education and Occupation (IEO) score for the SA1, returned as a numeric string. Scores are standardised to a national SA1 mean of 1,000 and standard deviation of 100. Higher values indicate higher educational attainment and occupational skill. Scores are not percentages or quantities of advantage.
ieoAusRankIEO rank of the SA1 within Australia, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
ieoAusDecileIEO decile group within Australia, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
ieoAusPercentIEO percentile group within Australia, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
ieoStRankIEO rank of the SA1 within the same state or territory, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
ieoStDecileIEO decile group within the same state or territory, returned as a numeric string from 1 to 10. Group 1 contains the lowest-scoring 10% of areas and group 10 the highest-scoring 10%.
ieoStPercentIEO percentile group within the same state or territory, returned as a numeric string from 1 to 100. Group 1 contains the lowest-scoring 1% of areas and group 100 the highest-scoring 1%. This is not a percentage value.
ierStRankIER rank of the SA1 within the same state or territory, ordered from lowest to highest score. Rank 1 has the lowest score. Returned as a numeric string.
AddressesV2_SolarPanelBundle.v2
solarAddressPiddateCreatedcaptureSourcedateModifiedplanningZoneisResidentialsolarReviewDatesolarFlagsolarAreaPhotovoltaic solar panel area in square metres (m²), when supplied.
solarEstimatedPowerEstimated daily solar energy output in kilowatt-hours (kWh), when supplied.
AddressesV2_StateElectorate.v2
stateElectoralPidstateElectoralNamestateElectoralClassCodestateElectoralTypeAddressesV2_StateElectorateBundle.v2
statusstateElectoralPidstateElectoralNamestateElectoralClassCodestateElectoralTypedateCreateddateRetireddateGazetteddateEffectiveStartdateEffectiveEndAddressesV1_geo
geoDatumCodegeoFeatureAddressesV1_addressDetails
cadastralIdentifierformattedAddresslocalityNamepostcodestateTerritorystreetNamestreetNumber1streetNumber2complexUnitIdentifiercomplexUnitTypesiteNamestreetTypelotIdentifierstreetSuffixstreetPrefixcomplexLevelIdentifiercomplexLevelTypeAddressesV1_addressLinks
addressDetailsasgsMainasgsRemotenesscommonwealthElectorategeostateElectoratelocalGovernmentAreaAddressesV1_commonwealthElectorate
commElectoralNamecommElectoralPidAddressesV1_localGovernmentArea
lgaNamelgaPidAddressesV1_messages
Single or multiple information messages about the response returned. Used as needed.
AddressesV1_pagination
countThe total number of results across all pages
currentpath to current pagination page
firstpath to first page of paginated list
lastpath to last page of paginated list
nextpath to next page of paginated list
prevpath to previous page of paginated list
AddressesV1_stateElectorate
The JSON model of the State Electorate object
stateElectoralNamestateElectoralTypeAddressesV1_messages.v1
Single or multiple information messages about the response returned. Used as needed.
AddressesV1_pagination.v1
countThe total number of results across all pages
currentpath to current pagination page
firstpath to first page of paginated list
lastpath to last page of paginated list
nextpath to next page of paginated list
prevpath to previous page of paginated list
AddressesV1_address.v1
addressIdaddressRecordTypebuildingsRolloutStatusThe JSON model of the Address Links Object
relatedBuildingIdsThe JSON model of the Address Details Object
The JSON model of the ASGS Main Object
The JSON model of the ASGS Remoteness Object
The JSON model of the Commonwealth Electorate Object
The JSON model of Geometry Object
The JSON model of Local Government Area Object
The JSON model of the State Electorate object
AddressesV1_stateElectorate.v1
The JSON model of the State Electorate object
stateElectoralNamestateElectoralTypeAddressesV1_geo.v1
geoDatumCodegeoFeatureAddressesV1_commonwealthElectorate.v1
commElectoralNamecommElectoralPidAddressesV1_addressLinks.v1
addressDetailsasgsMainasgsRemotenesscommonwealthElectorategeostateElectoratelocalGovernmentAreaAddressesV1_addressDetails.v1
cadastralIdentifierformattedAddresslocalityNamepostcodestateTerritorystreetNamestreetNumber1streetNumber2complexUnitIdentifiercomplexUnitTypesiteNamestreetTypelotIdentifierstreetSuffixstreetPrefixcomplexLevelIdentifiercomplexLevelTypeAddressesV1_localGovernmentArea.v1
lgaNamelgaPidAddressesV1_dataMessages.v1
codedescriptionmessageseverityAddressesV1_error.v1
messagesrequestTimeStamprequestDateTimeAddressesV1_geocodeFeature.v1
addressIdaddressStringformattedAddressmatchConfidenceBuildingsV21_Feature-Collection
typetotalAreaSum of building areas in this response page, in square metres. This is not the area of every matched building across all pages.
Buildings returned in this page. A page can be empty when the offset is beyond existing matches.
messagesSupplementary request information, including pagination warnings. May accompany a successful response.
requestTimeStampRequest time in seconds since the Unix epoch, including fractional seconds.
requestDateTimeRequest time in UTC in ISO 8601 form. The timezone suffix may be omitted.
attributionPagination counts and relative URLs for search endpoints. Absent from get-by-ID responses. Follow next against https://api.psma.com.au while present.
BuildingsV21_Feature
Building roof outline as a GeoJSON MultiPolygon. Coordinates use [longitude, latitude, z] order in geographic CRSs. Read Content-Crs for the response CRS.
typeBase building attributes and requested additional-property objects. Optional fields without values are omitted.
BuildingsV21_Heights-and-Roofs
roofHeightThe height of the tallest point on a building’s roof in metres.
eaveHeightThe average height of the part of a building's roof that meets or overhangs the walls (eave) in metres.
primaryRoofMaterialThe material that the roof is primarily made from.
roofShapeThe shape of the aerial building’s roof (e.g. ‘Hipped’, ‘Gabled’, ‘Flat’ etc.) in line with the CityGML standard.
roofTypeLegacy roof-complexity classification derived from roofShape and roofSlope. This is not an alias of roofShape.
roofColourThe measured Red/Green/Blue (RGB) colour value in hexadecimal format (#rrggbb) for the primary_roof_material of the building.
roofSlopeMaximum angle of slope of the building roof structure, in degrees.
BuildingsV21_Height
dateCreatedThe date of record creation for the building_height record.
roofHeightThe height of the tallest point on a building’s roof in metres.
eaveHeightThe average height of the part of a building's roof that meets or overhangs the walls (eave) in metres.
buildingVolumeThe volume of the building in cubic metres.
estimatedFloorsThe estimated number of floors for the building.
stateThe abbreviated name of the State or Territory that the building is primarily within.
dateModifiedThe most recent date that an attribute has been modified for the building_height record.
BuildingsV21_Roof
dateCreatedThe date of record creation for the building_roof record.
stateThe abbreviated name of the State or Territory that the building is primarily within.
dateModifiedThe most recent date that an attribute has been modified for the building_roof record.
roofColourThe measured Red/Green/Blue (RGB) colour value in hexadecimal format (#rrggbb) for the primary_roof_material of the building.
roofShapeThe shape of the aerial building’s roof (e.g. ‘Hipped’, ‘Gabled’, ‘Flat’ etc.) in line with the CityGML standard.
primaryRoofMaterialThe material that the roof is primarily made from.
roofSlopeMaximum angle of slope of the building roof structure, in degrees.
treeOverhangProvides an attribute that describes whether an identified tree overhangs the aerial building geometry. A ‘Yes’ value is used where a tree overhangs the building and a ‘No’ value is used where there is no tree overhanging the building.
BuildingsV21_Solar-Indicator
dateSolarPanelReviewedLegacy solar review date, populated from the solar record’s dateLastCaptured.
solarPanelLegacy solar-panel indicator. Prefer solar.solarFlag or solar.solarPanel.
BuildingsV21_Solar
dateCreatedThe date of record creation for the building_solar record.
dateLastCapturedThe date of the image used for the most recent update of the solar_flag field.
captureResolutionResolution in centimeters of the imagery source used to capture the solar information.
captureMethodType of imagery source used to capture the solar information (e.g. Aerial, Satellite, etc.).
solarFlagDescribes whether a visible photovoltaic solar panel is identified for the building (Yes/No).
stateThe abbreviated name of the State or Territory that the building is primarily within.
dateModifiedThe most recent date that an attribute has been modified for the building_solar record.
solarAreaTotal area of the building’s solar arrays in square metres.
dailyEstimatedPowerEstimated energy generated by the building’s solar arrays on an average day, in kilowatt hours (kWh).
solarPanelBoolean representation of solarFlag: true for Yes, false for No. Omitted for other values.
BuildingsV21_Pool-Indicator
swimmingPoolAdjacentDescribes whether a visible swimming pool is identified for the building.
dateSwimmingPoolReviewedMost recent review date for the swimming-pool indicator.
BuildingsV21_buildings-address
buildingPidThe persistent identifier of the building related to an address record.
addressPidThe address pid that is related to the building feature. The persistent identifier is unique to the address feature this record relates to.
addressDetailPidThe unique persistent identifier for each address_detail record associated with the address record.
dateCreatedThe date of record creation for the building_address relationship.
dateModifiedThe most recent date that an attribute has been modified for the building_address relationship.
addressThe address string from the related address record.
relationshipConfidenceConfidence in the building’s relationship to the related record, expressed as a percentage.
BuildingsV21_buildings-cad
buildingPidThe persistent identifier of the building related to a cadastral record.
cadastrePidThe unique persistent identifier for each cadastre record associated with the building record by spatial intersection.
dateCreatedThe date of record creation for the building_cadastre relationship.
dateModifiedThe most recent date that an attribute has been modified for the building_cadastre relationship.
relationshipConfidenceConfidence in the building’s relationship to the related record, expressed as a percentage.
BuildingsV21_buildings-property
buildingPidThe persistent identifier of the building related to a property record.
propertyPidThe unique persistent identifier for each property record associated with the building record by spatial intersection.
dateCreatedThe date of record creation for the building_property relationship.
dateModifiedThe most recent date that an attribute has been modified for the building_property relationship.
relationshipConfidenceConfidence in the building’s relationship to the related record, expressed as a percentage.
BuildingsV21_PageLinks
numberMatchedTotal number of features that match the query.
numberReturnedNumber of features returned in this feature collection.
selfRelative URL for this page.
nextRelative URL for the next page. Omitted when no next page is available within the pagination window.
prevRelative URL for the previous page. Omitted on the first page.
BuildingsV21_Error
messagesDiagnostic messages. Can be empty for a no-match 404.
requestTimeStampRequest time in seconds since the Unix epoch.
requestDateTimeUTC request time in ISO 8601 form. The timezone suffix may be omitted.
BuildingsV1_countByCoverageType
ruralBalanceurbanremoteCommunitiesBuildingsV1_linksBuilding
areacentroidelevationfootprint2dfootprint3doverhangingTreesolarPanelswimmingPoolzoningsaverageEaveHeightestimatedLevelsmaximumRoofHeightroofComplexityroofMaterialroofShapeBuildingsV1_roofMaterial
The roofMaterial attribute is the name of the primary roof material found across the building surface.
Roof material is classified from image pixels that intersect the building. The image signature of the intersecting pixels is matched to a spectral library of known material compositions to determine the best matching material for each pixel.
- Flat Concrete
- Fiberglass/Plastic
- Metal
- Tile
This object will not be returned if we cannot decide on the roof material.
BuildingsV1_roofShape
The roofShape attribute describes the shape of the building's roof in line with CityGML values.
Where a building is made of multiple discrete polygons, the largest area polygon will be used to classify the roof shape.
- Flat
- Hipped
- Gabled
- Shed
- Mansard
- Mixed
- Other
This object will not return if we have not assessed the roof shape for that building.
BuildingsV1_overhangingTree
overhangingTreeBuildingsV1_footprint2d
typecoordinatesBuildingsV1_footprint3d
coordinatestypeBuildingsV1_estimatedLevels
The estimated number of levels for the building. New logic as of March 2022 has improved accuracy.
BuildingsV1_pagination
countThe total number of results across all pages
currentfirstlastnextprevBuildingsV1_dataMessages
codedescriptionmessageseverityBuildingsV1_error
messagesrequestTimeStamprequestDateTimeAdministrativeBoundariesV1_Locality
typeThe geometry of the polygon.
AdministrativeBoundariesV1_Electoral-Boundary-Commonwealth
typeThe geometry of the polygon.
AdministrativeBoundariesV1_Electoral-Boundary-State
typeThe geometry of the polygon.
AdministrativeBoundariesV1_Local-Government-Area
typeThe geometry of the polygon.
AdministrativeBoundariesV1_Mesh-Block-2016
typeThe geometry of the polygon.
AdministrativeBoundariesV1_Mesh-Block-2011
typeThe geometry of the polygon.
AdministrativeBoundariesV1_Remoteness-2016
typeThe geometry of the polygon.
AdministrativeBoundariesV1_Remoteness-2021
typeThe geometry of the polygon.
AdministrativeBoundariesV1_Mesh-Block-2021
typeThe geometry of the polygon.
AdministrativeBoundariesV1_Mesh-Block-2026
typeThe geometry of the polygon.
AdministrativeBoundariesV1_Seifa-2021
typeAdministrativeBoundariesV1_Error.v1
messagesrequestTimeStampResponse time as Unix seconds.
requestDateTimeUTC response time.
AdministrativeBoundariesV1_Seifa-2011
typeAdministrativeBoundariesV1_Seifa-2016
typeLandParcelsV1_Cadastre
typeLandParcelsV1_Property
typeLandParcelsV1_Planning
dateCreatedThe date that the planning-cadastre relationship has been created.
stateThe abbreviated name of the State or Territory related to the Planning Zone data.
zoneCodeThe detailed planning zone code provided by the jurisdiction or council that is related to the cadastral polygon.
primaryZoneDescriptionDescriptive information about the planning zone or planning zone use that is related to the cadastral polygon.
sourceThe State or local Government source of the planning data.
urlThe web address location of the planning instrument or scheme relating to the associated planning zone information.
secondaryZoneDescriptionAncillary descriptive information about the planning zone or planning zone use that is related to the cadastral polygon.
psmaDescriptionThe generalised planning zone description used by Geoscape Australia for the assigned planning zone.
parcelIdsJurisdiction parcel identifiers associated with this planning record, when supplied.
LandParcelsV1_CoordinateArray
Nested polygon coordinates. Pairs use longitude,latitude order in the default CRS.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = number | |
| type = array |
LandParcelsV1_Error.v1
messagesrequestTimeStampResponse time as Unix seconds.
requestDateTimeUTC response time.
LandParcelsV1_PageLinks
numberMatchedTotal matching features.
numberReturnedFeatures returned on this page.
selfThis page’s URL.
nextNext page’s URL, when available.
prevPrevious page’s URL, when available.
PredictiveV1_Messages.v1
Single or multiple information messages about the response returned. Used as needed.
PredictiveV1_Predictive_AddressValidation.v1
PredictiveV1_Predictive_Suggestion.v1
Suggestions in ranked order. Empty when nothing matches.
messagesPredictiveV1_Predictive_Locality.v1
Suggestions in ranked order. Empty when nothing matches.
queryThe query the user provided to produce the results
requestTimeStamprequestDateTimeattributionmessagesPredictiveV1_Error.v1
messagesrequestTimeStampResponse time as Unix seconds.
requestDateTimeUTC response time.
BatchesV1_BatchDeletionResponse.v1
BatchesV1_BatchDeletionFailure.v1
codePer-job failure code: 400 for an unsupported job state, 403 for denied access, or 404 for a missing or previously deleted job. These codes do not change the HTTP 200 status.
messageFailure reason. The current 400 message lists Quoted, Completed, and Failed, although Cancelled jobs can also be deleted.
countNumber of IDs in this failure group.
idsJob IDs that failed for this reason.
BatchesV1_BatchAddressGeocoder.v1
matchTypeRequired match type. Use Locality, StreetLocality, or Address. The service normalises these published values before calling Addresses v2.
datasetDatasets to search. Send a JSON array, for example ["gnaf", "continuousAddress"].
additionalPropertiesRelated address attributes to retrieve. Send a JSON array. See Files and Mappings for meanings and access requirements.
stateFilterState or territory abbreviations to search. Send a JSON array.
minGeoFeatureLevelMinimum acceptable location detail for returned matches.
BatchesV1_BatchAddressGeocoderInputFormat.v1
nameInput CSV column header. Must match a header in the file.
apiParameterParameter that receives this column value for each row.
BatchesV1_BatchInput.v1
fileReadable HTTP, HTTPS, or FTP URL for a UTF-8 CSV with headers.
CSV column mappings for the selected job type.
usernameOptional username for the file server.
passwordOptional password for the file server. Returned passwords are masked.
BatchesV1_BatchMailPointInputFormat.v1
apiParameterParameter that receives this column value for each row.
nameInput CSV column header. Must match a header in the file.
BatchesV1_BatchOutput.v1
fileOptional writable FTP destination. Omit to use a download link. HTTP and HTTPS output destinations are not supported.
usernameOptional username for the file server.
passwordOptional password for the file server. Returned passwords are masked.
excludeInputColumnsInput column headers to omit from the output CSV. All names must exist in the input file. Other input columns are retained.
BatchesV1_BatchOutputFormat.v1
nameOutput CSV column header. Must be unique and must not collide with an input header.
sourceJSONPath expression applied to the Addresses API row response. No match produces an empty value. Objects and multiple matches are serialised as JSON. See Files and Mappings.
BatchesV1_BatchRequest.v1
typeJob type. Determines the Addresses v2 endpoint called for each CSV row.
Input file and column mappings.
Output destination and JSONPath column mappings.
Job-wide settings. Geocoder and reverse-geocoder jobs require matchType. MailPoint parameters can be omitted.
autoStartQueue the job after quoting when true and sufficient credits are available. Defaults to false.
returnDownloadLinkInclude batchInfo.downloadPath after completion. Forced to true when output.file is omitted. With an output destination, defaults to false.
BatchesV1_BatchResponse.v1
typeJob type. Determines the Addresses v2 endpoint called for each CSV row.
Informational job fields returned by the service. Do not supply these as request settings.
Job-wide settings. Geocoder and reverse-geocoder jobs require matchType. MailPoint parameters can be omitted.
Input file and column mappings.
Output destination and JSONPath column mappings.
statusCurrent processing state. See Managing Jobs.
displayNameJob display name assigned by the service when one is not supplied.
messagesJob information, including download access restrictions, when supplied.
autoStartQueue the job after quoting when true and sufficient credits are available. Defaults to false.
returnDownloadLinkInclude batchInfo.downloadPath after completion. Forced to true when output.file is omitted. With an output destination, defaults to false.
BatchesV1_BatchReverseGeocoder.v1
matchTypeRequired match type. Use Locality, StreetLocality, or Address. The service normalises these published values before calling Addresses v2.
datasetDatasets to search. Send a JSON array, for example ["gnaf", "continuousAddress"].
additionalPropertiesRelated address attributes to retrieve. Send a JSON array. See Files and Mappings for meanings and access requirements.
minGeoFeatureLevelMinimum acceptable location detail for returned matches.
BatchesV1_BatchReverseGeocoderInputFormat.v1
nameInput CSV column header. Must match a header in the file.
apiParameterParameter that receives this column value for each row.
BatchesV1_Messages.v1
Single or multiple information messages about the response returned. Used as needed.
BatchesV1_BatchResponseSummary.v1
Informational job fields returned by the service. Do not supply these as request settings.
statustypedisplayNameBatchesV1_BatchResponseSummaryList.v1
Job summaries for the current page.
BatchesV1_BatchPaginationLinks.v1
numberMatchednumberReturnedselfnextNext page URL, when available.
prevPrevious page URL, when available.
BatchesV1_BatchInfo.v1
executionRateService-assigned execution rate in requests per second.
batchIdJob identifier for status, update, start, and stop requests.
downloadPathDownload URL supplied after completion when requested and permitted by product access.
estimatedCreditCostEstimated job cost in credits.
estimatedRunTimeEstimated duration, such as 0:05:00.
totalRowsNumber of CSV rows counted for processing.
progressDescriptive progress text. This is not a numeric percentage.
createdAtUTC time the job was created.
modifiedAtUTC time the job was last modified.
completedAtUTC time processing completed, when available.
actualCreditCostActual job cost in credits, when available.
actualRunTimeActual processing duration, when available.
BatchesV1_Error.v1
messagesrequestTimeStampResponse time as Unix seconds.
requestDateTimeUTC response time.
DatasetsV11_dataset.yaml
nameDataset display name.
descriptionDataset description.
productProduct code.
regionRegion covered by this dataset file.
formatDataset file format.
releaseDataset release month, as YYYY-MM.
datumpublishDateThe date the dataset was published
versionLegacy numeric dataset version. Use versionString for the displayed version.
versionStringVersion text. Can use zero-padded groups such as 004-000-001, or the legacy version rendered as text.
classificationDataset classification.
idThe unique ID of the dataset
parentProductParent product code, when the dataset is a child product. Omitted otherwise.
sizeDownload file size in bytes, when supplied.
statusPublication status, when supplied. Public listings contain published datasets.
licencedWhether this dataset is covered by the caller’s agreement. Supplied on standard listings.
checksumSha256SHA-256 checksum of the download file, when supplied.
checksumMd5MD5 checksum of the download file, when supplied.
displayFormatFile-format label, when supplied.
displayPublishDateFormatted publication-date label, when supplied.
DatasetsV11_datasetWithDownload.yaml
nameDataset display name.
descriptionDataset description.
productProduct code.
regionRegion covered by this dataset file.
formatDataset file format.
releaseDataset release month, as YYYY-MM.
datumpublishDateThe date the dataset was published
versionLegacy numeric dataset version. Use versionString for the displayed version.
versionStringVersion text. Can use zero-padded groups such as 004-000-001, or the legacy version rendered as text.
classificationDataset classification.
idThe unique ID of the dataset
downloadLinkSigned file-download URL. Expires after 15 minutes. Request a fresh link rather than storing it as a permanent URL.
parentProductParent product code, when the dataset is a child product. Omitted otherwise.
sizeDownload file size in bytes, when supplied.
statusPublication status, when supplied. Public listings contain published datasets.
checksumSha256SHA-256 checksum of the download file, when supplied.
checksumMd5MD5 checksum of the download file, when supplied.
displayFormatFile-format label, when supplied.
displayPublishDateFormatted publication-date label, when supplied.
DatasetsV11_attribution.yaml
Mandatory legal text asserting copyright and directing the user to the specific Terms and Conditions governing the use of the data.
DatasetsV11_customDataset.yaml
nameCustom dataset name.
releaseRelease label supplied for this custom dataset.
publishDatePublication date.
formatFile-format label supplied for this custom dataset.
datumCoordinate-system label supplied for this custom dataset.
regionDataset coverage label.
idOpaque custom dataset ID. Use it with the custom download endpoint.
versionCustom dataset version as text.
sizeDownload file size in bytes, when supplied.
downloadLinkSigned download URL, supplied by a custom download lookup. Expires after 15 minutes.
descriptionCustom dataset description, when supplied.
DatasetsV11_links.yaml
numberMatchedTotal matching dataset files.
numberReturnedDataset files on this page.
selfURL for the current page.
nextNext page URL, when available.
prevPrevious page URL, when available.
DatasetsV11_Error.v1
messagesrequestTimeStampResponse time as Unix seconds.
requestDateTimeUTC response time.
MapsV1_Error.v1
messagesrequestTimeStampResponse time as Unix seconds.
requestDateTimeUTC response time.
MapsV1_TileJSON
tilejsonTileJSON specification version.
tilesTile URL templates. Authenticate each tile request.
Vector layers available within this tileset.
attributionAttribution to display with the map.
boundsWest,south,east,north bounds in longitude and latitude degrees.
centerSuggested map center as longitude,latitude,zoom.
descriptionTileset description.