Search by address

URL:	https://api.trademe.co.nz/v1/Property/Address.{file_format}
HTTP Method:	GET
Requires Authentication?	Yes
Permission Required:	None
Supported Formats:	XML, JSON
Rate Limited?	Yes

URL parameters

file_format

Enumeration (required)

The format of the response.

xml	Serialize responses into XML.
json	Serialize responses into JSON.

Query String parameters

search	String (optional)	The partial address to retreive suggestions for.
type_filter	String (optional)	The maxinum number of suggestions to retreive. (Maximum 50, Default 10, Minimum 1)

Returns

Results

Collection of <AddressSearchResult> or null

Results

Latitude	Number	Latitude
Longitude	Number	Longitude
HomesSuburbId	Integer or null	HomesSuburbId
Address	String or null	Address

Example XML Response (switch to JSON)

<AddressSearchResponse xmlns="http://api.trademe.co.nz/v1">
  <Results>
    <AddressSearchResult>
      <Latitude>123.0</Latitude>
      <Longitude>123.0</Longitude>
      <HomesSuburbId>123</HomesSuburbId>
      <Address>ABC</Address>
    </AddressSearchResult>
    <AddressSearchResult>
      <Latitude>123.0</Latitude>
      <Longitude>123.0</Longitude>
      <HomesSuburbId>123</HomesSuburbId>
      <Address>ABC</Address>
    </AddressSearchResult>
  </Results>
</AddressSearchResponse>

Example JSON Response (switch to XML)

{
  "Results": [
    {
      "Latitude": 123.0,
      "Longitude": 123.0,
      "HomesSuburbId": 123,
      "Address": "ABC"
    },
    {
      "Latitude": 123.0,
      "Longitude": 123.0,
      "HomesSuburbId": 123,
      "Address": "ABC"
    }
  ]
}