DOdomain
AddressLocators

Address Locator API

Changed on

Retrieves address matching ids for use in other services.

get/v1/addressLocators

Request

  • Base URL
    https://api.domain.com.au
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization codehttps://auth.domain.com.au/v1/connect/authorize
      Client credentials
      Token URLhttps://auth.domain.com.au/v1/connect/token
      Scopesapi_addresslocators_read
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

searchLevelstring required

Requested search level. Valid values are: Address, and Suburb.

unitNumberstring

Unit number of the address.

streetNumberstring

Street number of the address.

streetNamestring

Street name of the address.

streetTypestring

Street type of the address. Can take long or short street type

suburbstring required

Suburb name of the address.

statestring required

State abbreviation of the address.

postcodestring

Postcode of the address.

Response

Retrieve address IDs that may be used to query information from other endpoints.

Changes

  • 7130302fb268Revision changes
    • breaking

      the query request parameter searchLevel became required

    • breaking

      the query request parameter state became required

    • breaking

      the query request parameter suburb became required

    • breaking

      added the pattern ^\d{4}$ to the query request parameter postcode

    • breaking

      removed the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status