Website logo

Search by address

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 retrieve suggestions for.
type_filter String (optional)

The type to filter by(address, street, suburb, city).

Returns

<AddressSearchResponse>

Results Collection of <AddressSearchResult> or null Results
Latitude Number

Latitude
Longitude Number

Longitude
HomesSuburbId Integer or null

HomesSuburbId
Address String or null

Address
AddressType Enumeration

Address Type of this item
Unknown 0

Unknown
City 1

City
Suburb 2

Suburb
Street 3

Street
FullAddress 4

FullAddress
PropertyId String or null

PropertyId if the item is FullAddress and Homes propertyId matched

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>
      <AddressType>Unknown</AddressType>
      <PropertyId>ABC</PropertyId>
    </AddressSearchResult>
    <AddressSearchResult>
      <Latitude>123.0</Latitude>
      <Longitude>123.0</Longitude>
      <HomesSuburbId>123</HomesSuburbId>
      <Address>ABC</Address>
      <AddressType>Unknown</AddressType>
      <PropertyId>ABC</PropertyId>
    </AddressSearchResult>
  </Results>
</AddressSearchResponse>

Example JSON Response (switch to XML) 

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