Addresses v2 · Address Search

A grouping of operations that search for an address.

Before calling these endpoints, use a Geoscape Hub application with access to this API product. Authenticate with your Consumer Key in the Authorization header. See Authentication, Error Handling, Rate Limiting, and Attribution for shared integration guidance.

Required response fields must be present when their containing object is returned. Supply the documented request parameters when calling the endpoint.

Geocode

GET

https://api.psma.com.au

/v2/addresses/geocoder

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Match a single-line address or structured components to an address, street, or locality.

Supply at least one of address, streetName, or localityName. Structured components override the corresponding parsed values.
Use matchType to restrict result types. By default, matching falls back from an address to a street, then a locality.
Use maxResults to return up to 20 candidates. A search with no matches returns 200 with an empty features array.
Inspect matchType, matchQuality, and matchCode before accepting a result. matchScore ranks candidates for the same query and is not a percentage. See Assessing Address Matches.
Use additionalProperties for related attributes. Some require paid-plan access and incur additional charges. See Additional Properties.

Code
curl --fail-with-body --get "https://api.psma.com.au/v2/addresses/geocoder" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/geo+json" \
  --data-urlencode "address=113 Canberra Ave Griffith ACT 2603" \
  --data-urlencode "matchType=address" \
  --data-urlencode "additionalProperties=buildings,localGovernmentArea"

Geocode › query Parameters

address

string

Single-line address to match. Supply this or at least one of streetName and localityName. Structured components override the corresponding parsed values.

complexUnitType

string

Unit type, for example UNIT or FLAT.

complexUnitIdentifier

string

Unit identifier, including any prefix or suffix.

complexLevelType

string

Level type, for example LEVEL or FLOOR.

complexLevelNumber

string

Level identifier, including any prefix or suffix.

streetNumber1

string

First street number, including any prefix or suffix.

streetNumber2

string

Last street number in a range, including any prefix or suffix.

streetName

string

Street name without its type or suffix.

streetType

string

Street type or abbreviation, for example AV, RD, or ST.

streetSuffix

string

Street direction or suffix, for example WEST in Smith St West.

siteName

string

Building or site name.

lotIdentifier

string

Lot identifier, including any prefix or suffix.

localityName

string

Locality or suburb name.

stateTerritory

string

State or territory abbreviation, for example ACT, NSW, or VIC.

postcode

string

Four-digit postcode. Keep leading zeros.

matchType

string[] · style: form

Allowed result categories. Send one comma-separated query value, for example matchType=street,locality.

Value	Meaning
`address`	Primary or secondary address
`primaryAddress`	Primary address
`secondaryAddress`	Secondary address, such as a unit
`street`	Street within a locality
`streetLocality`	Alias for `street`
`locality`	Locality or suburb

Omit for the default address → street → locality fallback. For reverse geocoding, requesting all supported types also uses the default strategy. Other explicit lists select the address category first if any address type is included, otherwise street, otherwise locality. They do not combine categories.

Enum values:

address

streetLocality

locality

street

primaryAddress

secondaryAddress

maxResults

integer · min: 1 · max: 20

Maximum number of search results to return

Default: 1

stateFilter

string[] · style: form

States and territories to search. Send one comma-separated query value, for example stateFilter=NSW,ACT. Omit to search all jurisdictions.

Value	State or territory
`ACT`	Australian Capital Territory
`NSW`	New South Wales
`NT`	Northern Territory
`QLD`	Queensland
`SA`	South Australia
`TAS`	Tasmania
`VIC`	Victoria
`WA`	Western Australia
`OT`	Other Territories

Enum values:

ACT

NSW

QLD

TAS

VIC

dataset

string[] · style: form

Source datasets to search. Send one comma-separated query value, for example dataset=gnaf,continuousAddress. Omit to search both.

Value	Meaning
`gnaf`	Geocoded National Address File (G-NAF)
`continuousAddress`	Continuously maintained address data

Enum values:

gnaf

continuousAddress

additionalProperties

string[] · style: form

Optional related attributes. Send one comma-separated query value, for example additionalProperties=buildings,localGovernmentArea. Omit to return base attributes only. Names are case-sensitive.

Unavailable attributes may be omitted or reported in the feature’s messages array without failing the request. See Additional Properties for supported values, response fields, and access requirements.

Enum values:

asgsMain

asgsRemoteness

buildings

commonwealthElectorate

localGovernmentArea

parcelBundle

propertyBundle

seifa

excludeAliases

boolean

Return principal addresses only, excluding aliases. If specifying matchType, use the single value address, primaryAddress, or secondaryAddress.

Default: false

minGeoFeatureLevel

string · enum

Minimum geocode detail to accept. Choose one value. Broader levels also allow all more detailed levels.

Value	Accepts
`address`	Address-level geocodes
`approximate`	Approximate and address-level geocodes
`streetLocality`	Street, approximate, and address-level geocodes
`locality`	Locality and all more detailed geocodes
`none`	No geocode-detail filter (also the default when omitted)

This filters geocode detail, independently of matchType. See geocode point guidance.

Enum values:

address

approximate

streetLocality

locality

none

Geocode › Headers

Accept-Crs

string

Response coordinate reference system. Send angle-bracketed CRS URIs, separated by commas. Optional ;q= values set preference. Defaults to GDA94 (EPSG:4283).

Supported EPSG codes: 4283 (GDA94), 7844 (GDA2020), 4326 (WGS84), 4202 (AGD66), 3857 (Web Mercator), and 4167 (NZGD2000). See CRS selection and preferences.

Default: <https://www.opengis.net/def/crs/EPSG/0/4283>

Accept

string

Preferred response media type. Use application/geo+json for address search and lookup responses. MailPoint returns application/json.

Geocode › Responses

GeoJSON collection of matched addresses, streets, or localities. features is empty when no candidates match.

A GeoJSON FeatureCollection of Addresses

AddressesV2_Geocoder.v2

type

string · enum · minLength: 1 · required

Enum values:

FeatureCollection

Default: FeatureCollection

query

string · required

AddressesV2_ParsedAddress · required

Address components parsed from the input, including tokens that may not belong to an official address. Parsing does not confirm that the address exists.

object[] · minItems: 0 · unique · required

Matched candidates, or an empty array when no match is found.

messages

string[] · required

Supplementary information about the request or result. A message can accompany a successful 200 response.

requestTimeStamp

number · required

Request time in seconds since the Unix epoch (1970-01-01T00:00:00Z), including fractional seconds.

requestDateTime

string · required

Request time in UTC in ISO 8601 form. The timezone suffix may be omitted.

attribution

string · required

GET/v2/addresses/geocoder

curl --fail-with-body --get "https://api.psma.com.au/v2/addresses/geocoder" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/geo+json" \
  --data-urlencode "address=113 Canberra Ave Griffith ACT 2603" \
  --data-urlencode "matchType=address" \
  --data-urlencode "additionalProperties=buildings,localGovernmentArea"

Example Responses

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          149.14668176,
          -35.32202098
        ]
      },
      "properties": {
        "addressId": "GAACT717940975",
        "jurisdictionId": "3704312514F5ED2F9F",
        "formattedAddress": "113 CANBERRA AV, GRIFFITH ACT 2603",
        "addressRecordType": "PRIMARY",
        "aliasPrincipal": "PRINCIPAL",
        "geoFeature": "FRONTAGE CENTRE SETBACK",
        "streetName": "CANBERRA",
        "localityName": "GRIFFITH",
        "localityAlias": [
          "CANBERRA CENTRAL",
          "KINGSTON",
          "MANUKA"
        ],
        "localityNeighbour": [
          "BARTON",
          "FORREST",
          "FYSHWICK",
          "KINGSTON",
          "NARRABUNDAH",
          "RED HILL"
        ],
        "stateTerritory": "ACT",
        "postcode": "2603",
        "cadastralIdentifier": "CANB/GRIF/25/14/",
        "streetNumber1": "113",
        "streetType": "AV",
        "streetTypeDescription": "AVENUE",
        "localityId": "ACT220",
        "streetLocalityId": "ACT1507",
        "streetAlias": [],
        "dataset": "gnaf,mailAddress,continuousAddress"
      },
      "messages": [],
      "matchType": "Primary Address",
      "matchQuality": "Exact",
      "matchScore": 100
    }
  ],
  "query": "113 CANBERRA AV GRIFFITH ACT 2603",
  "parsedQuery": {
    "streetNumber1": "113",
    "streetName": "CANBERRA",
    "streetType": "AV",
    "localityName": "GRIFFITH",
    "stateTerritory": "ACT",
    "postcode": "2603"
  },
  "messages": [],
  "requestTimeStamp": 1661282561.241786,
  "requestDateTime": "2022-08-24T05:22:41.241977",
  "attribution": "NOTICE All rights reserved. Use of this data is subject to the Geoscape Developer Terms and Conditions (https://developer.geoscape.com.au/legal). Data is subject to copyright (https://geoscape.com.au/legal/data-copyright-and-disclaimer/)"
}

json

application/geo+json

MailPoint

GET

https://api.psma.com.au

/v2/addresses/mailPoint

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Match a postal address against the Australia Post Postal Address File (PAF) and return a Delivery Point Identifier (DPID) and barcode.

Supply address, addressLine1, or structured address components.
Check matchType, matchDiagnostic, and matchDiagnosticMessage to assess the match.
Handle no-match results: 200, matchScore: 0, and the message No address could be matched. Matched properties and geometry are omitted by default.
Check for geometry before using it. Geometry is returned only when a physical address can be linked, so postal-only addresses may have none.
Use a paid plan for MailPoint access. Optional premium additional properties may incur additional charges. See Additional Properties.

See the MailPoint guide for workflow and result interpretation.

Code
curl --fail-with-body --get "https://api.psma.com.au/v2/addresses/mailPoint" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json" \
  --data-urlencode "address=113 Canberra Ave Griffith ACT 2603"

MailPoint › query Parameters

address

string

Single-line postal address. Supply this, addressLine1, or structured address components.

matchType

string · enum

Maximum match level to accept: address accepts address matches. street also accepts address matches. locality accepts all three levels. Omit to accept any level. Choose one value.

Enum values:

address

street

locality

complexUnitType

string

Unit type, for example UNIT or FLAT.

complexUnitIdentifier

string

Unit identifier, including any prefix or suffix.

complexLevelType

string

Level type, for example LEVEL or FLOOR.

complexLevelNumber

string

Level identifier, including any prefix or suffix.

streetNumber1

string

First street number, including any prefix or suffix.

streetNumber2

string

Last street number in a range, including any prefix or suffix.

streetName

string

Street name without its type or suffix.

streetType

string

Street type or abbreviation, for example AV, RD, or ST.

streetSuffix

string

Street direction or suffix, for example WEST in Smith St West.

siteName

string

Building or site name.

lotIdentifier

string

Lot identifier, including any prefix or suffix.

localityName

string

Locality or suburb name.

stateTerritory

string

State or territory abbreviation, for example ACT, NSW, or VIC.

postcode

string

Four-digit postcode. Keep leading zeros.

postalDeliveryIdentifier

string

Postal delivery number, including any letters, for example 123 in PO BOX 123.

postalDeliveryTypeCode

string

Postal delivery type, for example PO BOX or RMB.

barcodeFormat

string · enum

Barcode length: 37Bar contains the DPID only. 52Bar adds up to 5 customer characters. 67Bar adds up to 10. Defaults to 67Bar.

Enum values:

37Bar

52Bar

67Bar

Default: 67Bar

barcodeData

string · maxLength: 21

Customer data for the barcode. Up to 5 characters are encoded for 52Bar, or 10 for 67Bar. Excess characters are truncated. Ignored for 37Bar. Input is limited to 21 characters.

addressLine1

string · minLength: 1

Line 1 of a postal address. Use addressLine1 for multi-line input.

addressLine2

string · minLength: 1

Line 2 of a postal address. Use addressLine1 for multi-line input.

addressLine3

string · minLength: 1

Line 3 of a postal address. Use addressLine1 for multi-line input.

additionalProperties

string[] · style: form

Optional related attributes. Send one comma-separated query value, for example additionalProperties=buildings,localGovernmentArea. Omit to return base attributes only. Names are case-sensitive.

Enum values:

asgsMain

asgsRemoteness

buildings

commonwealthElectorate

localGovernmentArea

parcelBundle

propertyBundle

seifa

MailPoint › Headers

Accept-Crs

string

Response coordinate reference system. Send angle-bracketed CRS URIs, separated by commas. Optional ;q= values set preference. Defaults to GDA94 (EPSG:4283).

Supported EPSG codes: 4283 (GDA94), 7844 (GDA2020), 4326 (WGS84), 4202 (AGD66), 3857 (Web Mercator), and 4167 (NZGD2000). See CRS selection and preferences.

Default: <https://www.opengis.net/def/crs/EPSG/0/4283>

MailPoint › Responses

Postal match result as JSON. No match returns matchScore: 0 and a message. Matched properties and geometry may be omitted.

GeoJSON model for mailPoint endpoint

AddressesV2_MailPoint.v2

type

string · required

query

string · required

pafVersion

number · required

PAF release used for matching.

pafExpiry

string · required

Expiry date of the PAF release.

matchScore

number · required

Postal 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.

AddressesV2_ParsedAddress · required

Address components parsed from the input, including tokens that may not belong to an official address. Parsing does not confirm that the address exists.

messages

string[] · required

Supplementary information about the request or result. A message can accompany a successful 200 response.

requestTimeStamp

number · required

Request time in seconds since the Unix epoch (1970-01-01T00:00:00Z), including fractional seconds.

requestDateTime

string · required

Request time in UTC in ISO 8601 form. The timezone suffix may be omitted.

attribution

string · required

object

Matched postal address and DPID. Omitted by default when no match is found.

matchDiagnostic

string

Diagnostic code for the postal match.

matchDiagnosticMessage

string

Human-readable explanation of the diagnostic code.

matchType

string · enum

Level of the matched DPID: address, street, or locality. Omitted when no match is found.

Enum values:

address

street

locality

GET/v2/addresses/mailPoint

curl --fail-with-body --get "https://api.psma.com.au/v2/addresses/mailPoint" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json" \
  --data-urlencode "address=113 Canberra Ave Griffith ACT 2603"

Example Responses

{
  "type": "Feature",
  "properties": {
    "dpid": "62539888",
    "barcode": "1320022002121030222222300301302310311312003003003003303232033320313",
    "formattedAddress": "113 CANBERRA AV, GRIFFITH ACT 2603",
    "streetName": "CANBERRA",
    "streetType": "AV",
    "streetTypeDescription": "AVENUE",
    "localityName": "GRIFFITH",
    "stateTerritory": "ACT",
    "postcode": "2603",
    "streetNumber1": "113"
  },
  "geometry": {
    "type": "Point",
    "coordinates": [
      149.14668176,
      -35.32202098
    ]
  },
  "messages": [],
  "pafVersion": 22.1,
  "pafExpiry": "01-04-2022",
  "matchScore": 94,
  "query": "113 CANBERRA AV, GRIFFITH ACT 2603",
  "parsedQuery": {
    "streetNumber1": "113",
    "streetName": "CANBERRA",
    "streetType": "AV",
    "localityName": "GRIFFITH",
    "stateTerritory": "ACT",
    "postcode": "2603"
  },
  "requestTimeStamp": 1661282561,
  "requestDateTime": "2022-08-24T05:22:41.241977",
  "attribution": "NOTICE All rights reserved. Use of this data is subject to the Geoscape Developer Terms and Conditions (https://developer.geoscape.com.au/legal). Data is subject to copyright (https://geoscape.com.au/legal/data-copyright-and-disclaimer/)"
}

json

application/json

Reverse Geocode

GET

https://api.psma.com.au

/v2/addresses/reverseGeocoder

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Find addresses, streets, or localities from a latitude and longitude. Supply both coordinates.

Use Content-Crs to identify the input CRS and Accept-Crs to select the response CRS. Both default to GDA94.
Omit matchType for the default search: a containing property, nearby addresses, nearby streets, then a locality. Specifying matchType selects a search category and may expand the search radius.
Check matchDistance (metres) and matchMethod before accepting a result.
Handle no-match results as 200 with an empty features array.
Use additionalProperties for related attributes. Some require paid-plan access and incur additional charges. See Additional Properties.

See the Reverse Geocoding guide for workflow and result interpretation.

Code
curl --fail-with-body --get "https://api.psma.com.au/v2/addresses/reverseGeocoder" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/geo+json" \
  --data-urlencode "latitude=-35.32202098" \
  --data-urlencode "longitude=149.14668176" \
  --data-urlencode "matchType=address"

Reverse Geocode › query Parameters

longitude

number · required

Longitude of the search point in the input CRS. In GDA94, valid values are 96 to 168 (inclusive).

latitude

number · required

Latitude of the search point in the input CRS. In GDA94, valid values are −45 to −8 (inclusive).

maxResults

integer · min: 1 · max: 20

Maximum number of search results to return

Default: 1

dataset

string[] · style: form

Source datasets to search. Send one comma-separated query value, for example dataset=gnaf,continuousAddress. Omit to search both.

Value	Meaning
`gnaf`	Geocoded National Address File (G-NAF)
`continuousAddress`	Continuously maintained address data

Enum values:

gnaf

continuousAddress

additionalProperties

string[] · style: form

Optional related attributes. Send one comma-separated query value, for example additionalProperties=buildings,localGovernmentArea. Omit to return base attributes only. Names are case-sensitive.

Enum values:

asgsMain

asgsRemoteness

buildings

commonwealthElectorate

localGovernmentArea

parcelBundle

propertyBundle

seifa

excludeAliases

boolean

Return principal addresses only, excluding aliases.

Default: false

matchType

string[] · style: form

Allowed result categories. Send one comma-separated query value, for example matchType=street,locality.

Value	Meaning
`address`	Primary or secondary address
`primaryAddress`	Primary address
`secondaryAddress`	Secondary address, such as a unit
`street`	Street within a locality
`streetLocality`	Alias for `street`
`locality`	Locality or suburb

Enum values:

address

streetLocality

locality

street

primaryAddress

secondaryAddress

minGeoFeatureLevel

string · enum

Minimum geocode detail to accept. Choose one value. Broader levels also allow all more detailed levels.

Value	Accepts
`address`	Address-level geocodes
`approximate`	Approximate and address-level geocodes
`streetLocality`	Street, approximate, and address-level geocodes
`locality`	Locality and all more detailed geocodes
`none`	No geocode-detail filter (also the default when omitted)

This filters geocode detail, independently of matchType. See geocode point guidance.

Enum values:

address

approximate

streetLocality

locality

none

Reverse Geocode › Headers

Content-Crs

string

CRS of the input latitude and longitude. Defaults to GDA94 (EPSG:4283). Use an angle-bracketed CRS URI from the supported Accept-Crs values.

Default: <https://www.opengis.net/def/crs/EPSG/0/4283>

Accept-Crs

string

Response coordinate reference system. Send angle-bracketed CRS URIs, separated by commas. Optional ;q= values set preference. Defaults to GDA94 (EPSG:4283).

Supported EPSG codes: 4283 (GDA94), 7844 (GDA2020), 4326 (WGS84), 4202 (AGD66), 3857 (Web Mercator), and 4167 (NZGD2000). See CRS selection and preferences.

Default: <https://www.opengis.net/def/crs/EPSG/0/4283>

Reverse Geocode › Responses

GeoJSON collection of matched features. features is empty when no candidates match.

A GeoJSON FeatureCollection of Addresses

AddressesV2_ReverseGeocoder.v2

type

string · enum · required

Enum values:

FeatureCollection

query

number[] · required

object[] · required

Matched candidates, or an empty array when no match is found.

messages

string[] · required

Supplementary information about the request or result. A message can accompany a successful 200 response.

requestTimeStamp

number · required

Request time in seconds since the Unix epoch (1970-01-01T00:00:00Z), including fractional seconds.

requestDateTime

string · required

Request time in UTC in ISO 8601 form. The timezone suffix may be omitted.

attribution

string · required

Rights notice for the data returned

GET/v2/addresses/reverseGeocoder

curl --fail-with-body --get "https://api.psma.com.au/v2/addresses/reverseGeocoder" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/geo+json" \
  --data-urlencode "latitude=-35.32202098" \
  --data-urlencode "longitude=149.14668176" \
  --data-urlencode "matchType=address"

Example Responses

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          149.14668176,
          -35.32202098
        ]
      },
      "properties": {
        "addressId": "GAACT717940975",
        "jurisdictionId": "3704312514F5ED2F9F",
        "formattedAddress": "113 CANBERRA AV, GRIFFITH ACT 2603",
        "addressRecordType": "PRIMARY",
        "aliasPrincipal": "PRINCIPAL",
        "geoFeature": "FRONTAGE CENTRE SETBACK",
        "streetName": "CANBERRA",
        "localityName": "GRIFFITH",
        "localityAlias": [
          "CANBERRA CENTRAL",
          "KINGSTON",
          "MANUKA"
        ],
        "localityNeighbour": [
          "BARTON",
          "FORREST",
          "FYSHWICK",
          "KINGSTON",
          "NARRABUNDAH",
          "RED HILL"
        ],
        "stateTerritory": "ACT",
        "postcode": "2603",
        "cadastralIdentifier": "CANB/GRIF/25/14/",
        "streetNumber1": "113",
        "streetType": "AV",
        "streetTypeDescription": "AVENUE",
        "localityId": "ACT220",
        "streetLocalityId": "ACT1507",
        "streetAlias": [],
        "dataset": "gnaf,mailAddress,continuousAddress"
      },
      "matchDistance": 0,
      "matchType": "Primary Address",
      "matchMethod": "Property Polygon Intersect",
      "messages": []
    }
  ],
  "query": [
    149.14668176,
    -35.32202098
  ],
  "messages": [],
  "requestTimeStamp": 1661282561.241786,
  "requestDateTime": "2022-08-24T05:22:41.241977",
  "attribution": "NOTICE All rights reserved. Use of this data is subject to the Geoscape Developer Terms and Conditions (https://developer.geoscape.com.au/legal). Data is subject to copyright (https://geoscape.com.au/legal/data-copyright-and-disclaimer/)"
}

json

application/geo+json

Find addresses by parcel ID

GET

https://api.psma.com.au

/v2/addresses/findByParcel

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Find addresses associated with a jurisdictional parcel identifier. Use the cadastralIdentifier returned by an address search as parcelId.

Use limit and offset to page through results.
Use stateFilter to restrict the jurisdiction.
Decode the JSON string for Victorian identifiers, which contain backslashes. Then URL-encode the value when sending it as a query parameter.
Use additionalProperties for related attributes. Some require paid-plan access and incur additional charges. See Additional Properties.

Code
curl --fail-with-body --get "https://api.psma.com.au/v2/addresses/findByParcel" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/geo+json" \
  --data-urlencode "parcelId=CANB/GRIF/25/14" \
  --data-urlencode "limit=10" \
  --data-urlencode "offset=0"

Find addresses by parcel ID › query Parameters

parcelId

string · required

Jurisdictional parcel identifier from cadastralIdentifier. URL-encode punctuation, including slashes and backslashes.

additionalProperties

string[] · style: form

Optional related attributes. Send one comma-separated query value, for example additionalProperties=buildings,localGovernmentArea. Omit to return base attributes only. Names are case-sensitive.

Enum values:

asgsMain

asgsRemoteness

buildings

commonwealthElectorate

localGovernmentArea

parcelBundle

propertyBundle

seifa

maxResults

integer · min: 1 · max: 20

Deprecated page-size parameter. Use limit instead.

Default: 1

limit

integer · min: 1 · max: 1000

Maximum features per page. Follow links.next for the next page, or increase offset by this value.

Default: 1

offset

integer · min: 0

Number of matching features to skip. Use with limit for pagination. An offset beyond the matching records returns an empty page with a message.

Default: 0

dataset

string[] · style: form

Source datasets to search. Send one comma-separated query value, for example dataset=gnaf,continuousAddress. Omit to search both.

Value	Meaning
`gnaf`	Geocoded National Address File (G-NAF)
`continuousAddress`	Continuously maintained address data

Enum values:

gnaf

continuousAddress

stateFilter

string[] · style: form

States and territories to search. Send one comma-separated query value, for example stateFilter=NSW,ACT. Omit to search all jurisdictions.

Value	State or territory
`ACT`	Australian Capital Territory
`NSW`	New South Wales
`NT`	Northern Territory
`QLD`	Queensland
`SA`	South Australia
`TAS`	Tasmania
`VIC`	Victoria
`WA`	Western Australia
`OT`	Other Territories

Enum values:

ACT

NSW

QLD

TAS

VIC

excludeAliases

boolean

Return principal addresses only, excluding aliases.

Default: false

Find addresses by parcel ID › Headers

Accept

string

Preferred response media type. Use application/geo+json for address search and lookup responses. MailPoint returns application/json.

Accept-Crs

string

Response coordinate reference system. Send angle-bracketed CRS URIs, separated by commas. Optional ;q= values set preference. Defaults to GDA94 (EPSG:4283).

Supported EPSG codes: 4283 (GDA94), 7844 (GDA2020), 4326 (WGS84), 4202 (AGD66), 3857 (Web Mercator), and 4167 (NZGD2000). See CRS selection and preferences.

Default: <https://www.opengis.net/def/crs/EPSG/0/4283>

Find addresses by parcel ID › Responses

GeoJSON collection of addresses linked to the parcel, with pagination in links.

A GeoJSON FeatureCollection of Addresses

AddressesV2_FindByParcelId.v2

type

string · enum · minLength: 1 · required

Enum values:

FeatureCollection

Default: FeatureCollection

object[] · minItems: 0 · unique · required

messages

string[] · required

Supplementary information about the request or result. A message can accompany a successful 200 response.

requestTimeStamp

number · required

Request time in seconds since the Unix epoch (1970-01-01T00:00:00Z), including fractional seconds.

requestDateTime

string · required

Request time in UTC in ISO 8601 form. The timezone suffix may be omitted.

attribution

string · required

query

string

object

Pagination counts and URLs. next and prev are omitted when unavailable.

GET/v2/addresses/findByParcel

curl --fail-with-body --get "https://api.psma.com.au/v2/addresses/findByParcel" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/geo+json" \
  --data-urlencode "parcelId=CANB/GRIF/25/14" \
  --data-urlencode "limit=10" \
  --data-urlencode "offset=0"

Example Responses

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "stateTerritory": "ACT",
        "addressId": "GAACT717940957",
        "addressRecordType": "SECONDARY",
        "aliasPrincipal": "PRINCIPAL",
        "geoFeature": "FRONTAGE CENTRE SETBACK",
        "cadastralIdentifier": "CANB/GRIF/25/14",
        "formattedAddress": "UNIT 1 113 CANBERRA AV, GRIFFITH ACT 2603",
        "localityName": "GRIFFITH",
        "postcode": "2603",
        "streetName": "CANBERRA",
        "streetNumber1": "113",
        "complexUnitNumber": "1",
        "complexUnitType": "UNIT",
        "complexUnitTypeDescription": "UNIT",
        "streetType": "AV",
        "streetTypeDescription": "AVENUE",
        "localityNeighbour": [
          "BARTON",
          "FORREST",
          "FYSHWICK",
          "KINGSTON",
          "NARRABUNDAH",
          "RED HILL"
        ],
        "localityAlias": [
          "CANBERRA CENTRAL",
          "KINGSTON",
          "MANUKA"
        ],
        "localityId": "loc4d979cf6e3c5",
        "streetLocalityId": "ACT1507",
        "streetAlias": [],
        "dataset": "gnaf"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          149.14668730603353,
          -35.32200812263528
        ]
      },
      "messages": []
    }
  ],
  "messages": [],
  "query": "CANB/GRIF/25/14",
  "requestTimeStamp": 1687145569.55453,
  "requestDateTime": "2022-08-24T05:22:41.241977",
  "attribution": "NOTICE All rights reserved. Use of this data is subject to the Geoscape Developer Terms and Conditions (https://geoscape.com.au/legal/geoscape-developer-terms/)"
}

json

application/geo+json

Find addresses by property ID

GET

https://api.psma.com.au

/v2/addresses/findByProperty

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Find addresses associated with a Geoscape property ID (prp…) or a jurisdictional property identifier.

Use stateFilter to restrict the jurisdiction, especially for contributor identifiers that may occur in more than one state.
Use limit and offset to page through results.
Use additionalProperties for related attributes. Some require paid-plan access and incur additional charges. See Additional Properties.

Code
curl --fail-with-body --get "https://api.psma.com.au/v2/addresses/findByProperty" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/geo+json" \
  --data-urlencode "propertyId=prpf728e2d4734d" \
  --data-urlencode "limit=10" \
  --data-urlencode "offset=0"

Find addresses by property ID › query Parameters

propertyId

string · required

Geoscape property ID (prp…) or jurisdictional property identifier. Use stateFilter to narrow contributor identifiers to a jurisdiction.

additionalProperties

string[] · style: form

Optional related attributes. Send one comma-separated query value, for example additionalProperties=buildings,localGovernmentArea. Omit to return base attributes only. Names are case-sensitive.

Enum values:

asgsMain

asgsRemoteness

buildings

commonwealthElectorate

localGovernmentArea

parcelBundle

propertyBundle

seifa

limit

integer · min: 1 · max: 1000

Maximum features per page. Follow links.next for the next page, or increase offset by this value.

Default: 1

offset

integer · min: 0

Number of matching features to skip. Use with limit for pagination. An offset beyond the matching records returns an empty page with a message.

Default: 0

stateFilter

string[] · style: form

States and territories to search. Send one comma-separated query value, for example stateFilter=NSW,ACT. Omit to search all jurisdictions.

Value	State or territory
`ACT`	Australian Capital Territory
`NSW`	New South Wales
`NT`	Northern Territory
`QLD`	Queensland
`SA`	South Australia
`TAS`	Tasmania
`VIC`	Victoria
`WA`	Western Australia
`OT`	Other Territories

Enum values:

ACT

NSW

QLD

TAS

VIC

dataset

string[] · style: form

Source datasets to search. Send one comma-separated query value, for example dataset=gnaf,continuousAddress. Omit to search both.

Value	Meaning
`gnaf`	Geocoded National Address File (G-NAF)
`continuousAddress`	Continuously maintained address data

Enum values:

gnaf

continuousAddress

excludeAliases

boolean

Return principal addresses only, excluding aliases.

Default: false

Find addresses by property ID › Headers

Accept

string

Preferred response media type. Use application/geo+json for address search and lookup responses. MailPoint returns application/json.

Accept-Crs

string

Response coordinate reference system. Send angle-bracketed CRS URIs, separated by commas. Optional ;q= values set preference. Defaults to GDA94 (EPSG:4283).

Supported EPSG codes: 4283 (GDA94), 7844 (GDA2020), 4326 (WGS84), 4202 (AGD66), 3857 (Web Mercator), and 4167 (NZGD2000). See CRS selection and preferences.

Default: <https://www.opengis.net/def/crs/EPSG/0/4283>

Find addresses by property ID › Responses

GeoJSON collection of addresses linked to the property, with pagination in links.

A GeoJSON FeatureCollection of Addresses

AddressesV2_FindByPropertyId.v2

type

string · enum · minLength: 1 · required

Enum values:

FeatureCollection

Default: FeatureCollection

object[] · minItems: 0 · unique · required

messages

string[] · required

Supplementary information about the request or result. A message can accompany a successful 200 response.

requestTimeStamp

number · required

Request time in seconds since the Unix epoch (1970-01-01T00:00:00Z), including fractional seconds.

requestDateTime

string · required

Request time in UTC in ISO 8601 form. The timezone suffix may be omitted.

attribution

string · required

query

string

object

Pagination counts and URLs. next and prev are omitted when unavailable.

GET/v2/addresses/findByProperty

curl --fail-with-body --get "https://api.psma.com.au/v2/addresses/findByProperty" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/geo+json" \
  --data-urlencode "propertyId=prpf728e2d4734d" \
  --data-urlencode "limit=10" \
  --data-urlencode "offset=0"

Example Responses

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "addressId": "GAQLD157364842",
        "jurisdictionId": "1269613-PC",
        "addressRecordType": "PRIMARY",
        "aliasPrincipal": "PRINCIPAL",
        "geoFeature": "PROPERTY CENTROID",
        "cadastralIdentifier": "356/RP727226",
        "formattedAddress": "30 ANGELA ST, WOREE QLD 4868",
        "localityName": "WOREE",
        "stateTerritory": "QLD",
        "postcode": "4868",
        "streetName": "ANGELA",
        "streetNumber1": "30",
        "streetType": "ST",
        "streetTypeDescription": "STREET",
        "lotIdentifier": "356",
        "localityNeighbour": [
          "BAYVIEW HEIGHTS",
          "BUNGALOW",
          "EARLVILLE",
          "MOUNT SHERIDAN",
          "PORTSMITH",
          "WHITE ROCK"
        ],
        "localityAlias": [
          "BAYVIEW HEIGHTS",
          "EARLVILLE",
          "WHITE ROCK"
        ],
        "localityId": "loc2f789ba95ebe",
        "streetLocalityId": "QLD162555",
        "streetAlias": [],
        "dataset": "gnaf,mailAddress,continuousAddress",
        "contributorPropertyId": "5095700"
      },
      "geometry": {
        "coordinates": [
          145.74042713,
          -16.95238445
        ],
        "type": "Point"
      },
      "messages": []
    }
  ],
  "query": "5095700",
  "messages": [],
  "attribution": "NOTICE All rights reserved. Use of this data is subject to the Geoscape Developer Terms and Conditions (https://geoscape.com.au/legal/geoscape-developer-terms/)",
  "links": {
    "numberMatched": 2,
    "numberReturned": 1,
    "self": "/v2/addresses/findByProperty?propertyId=5095700&offset=0&limit=1",
    "next": "/v2/addresses/findByProperty?propertyId=5095700&offset=1&limit=1"
  },
  "requestTimeStamp": 1742430497.85556,
  "requestDateTime": "2025-03-20T00:28:17.855562"
}

json

application/geo+json

Verify v1 · Mailpoint Addresses v2 · Address Verification