Website logo

Get map dots for a given search request

Get map dots for a given search request

URL: https://api.trademe.co.nz/v1/Property/Map/Dots.{file_format}
HTTP Method: POST
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.

POST Data

<MapDotsRequest>

Polylines Collection of String (optional) Polylines
Limit Integer (optional) Limit
Page Integer (optional) Page
Sort <Sort> (optional) Sort
Order String (optional) Order
Direction String (optional) Direction
DisplayRentals Boolean (optional) DisplayRentals
ForSale Boolean (optional) ForSale
ForRent Boolean (optional) ForRent
JustSold Boolean (optional) JustSold
OffMarket Boolean (optional) OffMarket
SalePriceMin Integer (optional) SalePriceMin
SalePriceMax Integer (optional) SalePriceMax
RentRateMin Integer (optional) RentRateMin
RentRateMax Integer (optional) RentRateMax
OffMarketMin Integer (optional) OffMarketMin
OffMarketMax Integer (optional) OffMarketMax
ForSaleBathrooms Integer (optional) ForSaleBathrooms
ForSaleBedrooms Integer (optional) ForSaleBedrooms
ForRentBathrooms Integer (optional) ForRentBathrooms
ForRentBedrooms Integer (optional) ForRentBedrooms
OffMarketBathrooms Integer (optional) OffMarketBathrooms
OffMarketBedrooms Integer (optional) OffMarketBedrooms
ForSaleBathroomsMax Integer (optional) ForSaleBathroomsMax
ForRentBathroomsMax Integer (optional) ForRentBathroomsMax
ForRentBedroomsMax Integer (optional) ForRentBedroomsMax
OffMarketBathroomsMax Integer (optional) OffMarketBathroomsMax
OffMarketBedroomsMax Integer (optional) OffMarketBedroomsMax
DateMin DateTime (optional) DateMin
DateMax DateTime (optional) DateMax
SuburbId Integer (optional) SuburbId
FilterOutTbc Integer (optional) FilterOutTbc
UnitIdentifier String (optional) UnitIdentifier
StreetNumber String (optional) StreetNumber
StreetName String (optional) StreetName
StreetType String (optional) StreetType
StreetDirection String (optional) StreetDirection
StreetAlpha String (optional) StreetAlpha
MinLatitude Number (optional) MinLatitude
MinLongitude Number (optional) MinLongitude
MaxLatitude Number (optional) MaxLatitude
MaxLongitude Number (optional) MaxLongitude

Returns

<MapDotsResponse>

A list of properties on a map

MapItems Collection of <MapItem> or null MapItems
ItemId String or null ItemId
Id String or null Id
State Integer State
Price Number or null Price
Point <Point> or null Point
Lat Number Lat
Long Number Long
Url String or null Url
FeaturedAt DateTime or null FeaturedAt
FeaturedPlan Integer or null FeaturedPlan
DisplayPriceShort String or null DisplayPriceShort
DisplayStreetNumber String or null DisplayStreetNumber
Clusters Collection of <Cluster> or null Clusters
Properties Collection of <Property> or null Properties
ItemId String or null ItemId
Id String or null Id
State Integer State
Price Number or null Price
Date DateTime or null Date
DisplayPrice String or null DisplayPrice
PropertyDetails <PropertyDetails> or null PropertyDetails
Address String or null Address
CoverImageUrl String or null CoverImageUrl
GoogleStreetViewUrl String or null GoogleStreetViewUrl
Point <Point> or null Point
(This type has already been defined)
Url String or null Url
FeaturedAt DateTime or null FeaturedAt
FeaturedPlan Integer or null FeaturedPlan
DisplayPriceShort String or null DisplayPriceShort
State Integer State
Point <Point> or null Point
(This type has already been defined)
FeaturedAt DateTime or null FeaturedAt
FeaturedPlan Integer or null FeaturedPlan
Hits Integer Hits
Error String or null Error

Example XML Request (switch to JSON) 

<MapDotsRequest xmlns="http://api.trademe.co.nz/v1">
  <Polylines>
    <string>ABC</string>
    <string>ABC</string>
  </Polylines>
  <Limit>123</Limit>
  <Page>123</Page>
  <Sort>
    <Order>ABC</Order>
    <Direction>ABC</Direction>
  </Sort>
  <DisplayRentals>false</DisplayRentals>
  <ForSale>false</ForSale>
  <ForRent>false</ForRent>
  <JustSold>false</JustSold>
  <OffMarket>false</OffMarket>
  <SalePriceMin>123</SalePriceMin>
  <SalePriceMax>123</SalePriceMax>
  <RentRateMin>123</RentRateMin>
  <RentRateMax>123</RentRateMax>
  <OffMarketMin>123</OffMarketMin>
  <OffMarketMax>123</OffMarketMax>
  <ForSaleBathrooms>123</ForSaleBathrooms>
  <ForSaleBedrooms>123</ForSaleBedrooms>
  <ForRentBathrooms>123</ForRentBathrooms>
  <ForRentBedrooms>123</ForRentBedrooms>
  <OffMarketBathrooms>123</OffMarketBathrooms>
  <OffMarketBedrooms>123</OffMarketBedrooms>
  <ForSaleBathroomsMax>123</ForSaleBathroomsMax>
  <ForRentBathroomsMax>123</ForRentBathroomsMax>
  <ForRentBedroomsMax>123</ForRentBedroomsMax>
  <OffMarketBathroomsMax>123</OffMarketBathroomsMax>
  <OffMarketBedroomsMax>123</OffMarketBedroomsMax>
  <DateMin>2018-01-01T00:00:00Z</DateMin>
  <DateMax>2018-01-01T00:00:00Z</DateMax>
  <SuburbId>123</SuburbId>
  <FilterOutTbc>123</FilterOutTbc>
  <UnitIdentifier>ABC</UnitIdentifier>
  <StreetNumber>ABC</StreetNumber>
  <StreetName>ABC</StreetName>
  <StreetType>ABC</StreetType>
  <StreetDirection>ABC</StreetDirection>
  <StreetAlpha>ABC</StreetAlpha>
  <MinLatitude>123.0</MinLatitude>
  <MinLongitude>123.0</MinLongitude>
  <MaxLatitude>123.0</MaxLatitude>
  <MaxLongitude>123.0</MaxLongitude>
</MapDotsRequest>

Example JSON Request (switch to XML) 

{
  "Polylines": [
    "ABC",
    "ABC"
  ],
  "Limit": 123,
  "Page": 123,
  "Sort": {
    "Order": "ABC",
    "Direction": "ABC"
  },
  "DisplayRentals": false,
  "ForSale": false,
  "ForRent": false,
  "JustSold": false,
  "OffMarket": false,
  "SalePriceMin": 123,
  "SalePriceMax": 123,
  "RentRateMin": 123,
  "RentRateMax": 123,
  "OffMarketMin": 123,
  "OffMarketMax": 123,
  "ForSaleBathrooms": 123,
  "ForSaleBedrooms": 123,
  "ForRentBathrooms": 123,
  "ForRentBedrooms": 123,
  "OffMarketBathrooms": 123,
  "OffMarketBedrooms": 123,
  "ForSaleBathroomsMax": 123,
  "ForRentBathroomsMax": 123,
  "ForRentBedroomsMax": 123,
  "OffMarketBathroomsMax": 123,
  "OffMarketBedroomsMax": 123,
  "DateMin": "\/Date(1514764800)\/",
  "DateMax": "\/Date(1514764800)\/",
  "SuburbId": 123,
  "FilterOutTbc": 123,
  "UnitIdentifier": "ABC",
  "StreetNumber": "ABC",
  "StreetName": "ABC",
  "StreetType": "ABC",
  "StreetDirection": "ABC",
  "StreetAlpha": "ABC",
  "MinLatitude": 123.0,
  "MinLongitude": 123.0,
  "MaxLatitude": 123.0,
  "MaxLongitude": 123.0
}

Example XML Response (switch to JSON) 

<MapDotsResponse xmlns="http://api.trademe.co.nz/v1">
  <MapItems>
    <MapItem>
      <ItemId>ABC</ItemId>
      <Id>ABC</Id>
      <State>123</State>
      <Price>123.0</Price>
      <Point>
        <Lat>123.0</Lat>
        <Long>123.0</Long>
      </Point>
      <Url>ABC</Url>
      <FeaturedAt>2018-01-01T00:00:00Z</FeaturedAt>
      <FeaturedPlan>123</FeaturedPlan>
      <DisplayPriceShort>ABC</DisplayPriceShort>
      <DisplayStreetNumber>ABC</DisplayStreetNumber>
    </MapItem>
    <MapItem>
      <ItemId>ABC</ItemId>
      <Id>ABC</Id>
      <State>123</State>
      <Price>123.0</Price>
      <Point>
        <Lat>123.0</Lat>
        <Long>123.0</Long>
      </Point>
      <Url>ABC</Url>
      <FeaturedAt>2018-01-01T00:00:00Z</FeaturedAt>
      <FeaturedPlan>123</FeaturedPlan>
      <DisplayPriceShort>ABC</DisplayPriceShort>
      <DisplayStreetNumber>ABC</DisplayStreetNumber>
    </MapItem>
  </MapItems>
  <Clusters>
    <Cluster>
      <Properties>
        <Property>
          <ItemId>ABC</ItemId>
          <Id>ABC</Id>
          <State>123</State>
          <Price>123.0</Price>
          <Date>2018-01-01T00:00:00Z</Date>
          <DisplayPrice>ABC</DisplayPrice>
          <PropertyDetails>
            <Address>ABC</Address>
            <CoverImageUrl>ABC</CoverImageUrl>
            <GoogleStreetViewUrl>ABC</GoogleStreetViewUrl>
          </PropertyDetails>
          <Point />
          <Url>ABC</Url>
          <FeaturedAt>2018-01-01T00:00:00Z</FeaturedAt>
          <FeaturedPlan>123</FeaturedPlan>
          <DisplayPriceShort>ABC</DisplayPriceShort>
        </Property>
        <Property>
          <ItemId>ABC</ItemId>
          <Id>ABC</Id>
          <State>123</State>
          <Price>123.0</Price>
          <Date>2018-01-01T00:00:00Z</Date>
          <DisplayPrice>ABC</DisplayPrice>
          <PropertyDetails>
            <Address>ABC</Address>
            <CoverImageUrl>ABC</CoverImageUrl>
            <GoogleStreetViewUrl>ABC</GoogleStreetViewUrl>
          </PropertyDetails>
          <Point />
          <Url>ABC</Url>
          <FeaturedAt>2018-01-01T00:00:00Z</FeaturedAt>
          <FeaturedPlan>123</FeaturedPlan>
          <DisplayPriceShort>ABC</DisplayPriceShort>
        </Property>
      </Properties>
      <State>123</State>
      <Point />
      <FeaturedAt>2018-01-01T00:00:00Z</FeaturedAt>
      <FeaturedPlan>123</FeaturedPlan>
    </Cluster>
    <Cluster>
      <Properties>
        <Property>
          <ItemId>ABC</ItemId>
          <Id>ABC</Id>
          <State>123</State>
          <Price>123.0</Price>
          <Date>2018-01-01T00:00:00Z</Date>
          <DisplayPrice>ABC</DisplayPrice>
          <PropertyDetails>
            <Address>ABC</Address>
            <CoverImageUrl>ABC</CoverImageUrl>
            <GoogleStreetViewUrl>ABC</GoogleStreetViewUrl>
          </PropertyDetails>
          <Point />
          <Url>ABC</Url>
          <FeaturedAt>2018-01-01T00:00:00Z</FeaturedAt>
          <FeaturedPlan>123</FeaturedPlan>
          <DisplayPriceShort>ABC</DisplayPriceShort>
        </Property>
        <Property>
          <ItemId>ABC</ItemId>
          <Id>ABC</Id>
          <State>123</State>
          <Price>123.0</Price>
          <Date>2018-01-01T00:00:00Z</Date>
          <DisplayPrice>ABC</DisplayPrice>
          <PropertyDetails>
            <Address>ABC</Address>
            <CoverImageUrl>ABC</CoverImageUrl>
            <GoogleStreetViewUrl>ABC</GoogleStreetViewUrl>
          </PropertyDetails>
          <Point />
          <Url>ABC</Url>
          <FeaturedAt>2018-01-01T00:00:00Z</FeaturedAt>
          <FeaturedPlan>123</FeaturedPlan>
          <DisplayPriceShort>ABC</DisplayPriceShort>
        </Property>
      </Properties>
      <State>123</State>
      <Point />
      <FeaturedAt>2018-01-01T00:00:00Z</FeaturedAt>
      <FeaturedPlan>123</FeaturedPlan>
    </Cluster>
  </Clusters>
  <Hits>123</Hits>
  <Error>ABC</Error>
</MapDotsResponse>

Example JSON Response (switch to XML) 

{
  "MapItems": [
    {
      "ItemId": "ABC",
      "Id": "ABC",
      "State": 123,
      "Price": 123.0,
      "Point": {
        "Lat": 123.0,
        "Long": 123.0
      },
      "Url": "ABC",
      "FeaturedAt": "\/Date(1514764800)\/",
      "FeaturedPlan": 123,
      "DisplayPriceShort": "ABC",
      "DisplayStreetNumber": "ABC"
    },
    {
      "ItemId": "ABC",
      "Id": "ABC",
      "State": 123,
      "Price": 123.0,
      "Point": {
        "Lat": 123.0,
        "Long": 123.0
      },
      "Url": "ABC",
      "FeaturedAt": "\/Date(1514764800)\/",
      "FeaturedPlan": 123,
      "DisplayPriceShort": "ABC",
      "DisplayStreetNumber": "ABC"
    }
  ],
  "Clusters": [
    {
      "Properties": [
        {
          "ItemId": "ABC",
          "Id": "ABC",
          "State": 123,
          "Price": 123.0,
          "Date": "\/Date(1514764800)\/",
          "DisplayPrice": "ABC",
          "PropertyDetails": {
            "Address": "ABC",
            "CoverImageUrl": "ABC",
            "GoogleStreetViewUrl": "ABC"
          },
          "Point": {
          },
          "Url": "ABC",
          "FeaturedAt": "\/Date(1514764800)\/",
          "FeaturedPlan": 123,
          "DisplayPriceShort": "ABC"
        },
        {
          "ItemId": "ABC",
          "Id": "ABC",
          "State": 123,
          "Price": 123.0,
          "Date": "\/Date(1514764800)\/",
          "DisplayPrice": "ABC",
          "PropertyDetails": {
            "Address": "ABC",
            "CoverImageUrl": "ABC",
            "GoogleStreetViewUrl": "ABC"
          },
          "Point": {
          },
          "Url": "ABC",
          "FeaturedAt": "\/Date(1514764800)\/",
          "FeaturedPlan": 123,
          "DisplayPriceShort": "ABC"
        }
      ],
      "State": 123,
      "Point": {
      },
      "FeaturedAt": "\/Date(1514764800)\/",
      "FeaturedPlan": 123
    },
    {
      "Properties": [
        {
          "ItemId": "ABC",
          "Id": "ABC",
          "State": 123,
          "Price": 123.0,
          "Date": "\/Date(1514764800)\/",
          "DisplayPrice": "ABC",
          "PropertyDetails": {
            "Address": "ABC",
            "CoverImageUrl": "ABC",
            "GoogleStreetViewUrl": "ABC"
          },
          "Point": {
          },
          "Url": "ABC",
          "FeaturedAt": "\/Date(1514764800)\/",
          "FeaturedPlan": 123,
          "DisplayPriceShort": "ABC"
        },
        {
          "ItemId": "ABC",
          "Id": "ABC",
          "State": 123,
          "Price": 123.0,
          "Date": "\/Date(1514764800)\/",
          "DisplayPrice": "ABC",
          "PropertyDetails": {
            "Address": "ABC",
            "CoverImageUrl": "ABC",
            "GoogleStreetViewUrl": "ABC"
          },
          "Point": {
          },
          "Url": "ABC",
          "FeaturedAt": "\/Date(1514764800)\/",
          "FeaturedPlan": 123,
          "DisplayPriceShort": "ABC"
        }
      ],
      "State": 123,
      "Point": {
      },
      "FeaturedAt": "\/Date(1514764800)\/",
      "FeaturedPlan": 123
    }
  ],
  "Hits": 123,
  "Error": "ABC"
}