DOdomain
Listings

Suggests listing locations

The resulting suggested location can be of type "suburb" / "area" / "region".

The name property corresponds to the type of location returned.

The area name / region name can be fed into the corresponding fields search fields. See v1/listings/residential/_search

get/v1/listings/locations

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_listings_read, api_listings_write
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

termsstring

Suburb / area / region prefix, or postcode

Response

OK

namestring

Name

statestring

State

postcodestring

Postcode

areastring

Area

regionstring

Region

typestring

Type

Changes

No recorded changes to this operation across all 18 revisions of this API.