Get property timeline data

Get property timeline by homes property id

URL:	https://api.trademe.co.nz/v1/Property/Timeline/{homesPropertyId}.{file_format}
HTTP Method:	GET
Requires Authentication?	Yes
Permission Required:	MyTradeMeRead: Read your membership & listing data.
Supported Formats:	XML, JSON
Rate Limited?	Yes

URL parameters

homesPropertyId

String (required)

file_format

Enumeration (required)

The format of the response.

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

Returns

Property timeline

Events

Collection of <PropertyTimelineDetail> or null

The events of the property timeline detail

Price

Long Integer or null

The price of the property

DisplaySalePrice

String or null

The display price of the property

SaleType

String or null

The sale type of the property

SaleTypeDescription

String or null

The description of the sale type

PriceOn

DateTime or null

The price on of the property (in NZST)

CapitalValue

Long Integer or null

The capital value of the property

ImprovementValue

Long Integer or null

The improvement value of the property

LandValue

Long Integer or null

The land value of the property

DecadeBuilt

String or null

The decade when the property was built

Value

String or null

The value of the property

Description

String or null

The description of the property

SaleAgents

Collection of <Agent> or null

The sale agents of the property

ProfileImageUrl	String or null	The profile image URL of the sale agent
Name	String or null	The name of the sale agent
UrlSlug	String or null	The url slug of the sale agent

SaleBranches

Collection of <Branch> or null

The sale branches of the property

OfficeMemberId	Integer or null	The office member id of branch
BranchName	String or null	The name of the branch.
LogoUrl	String or null	The URL of the branch's logo.
BrandingBackgroundColor	String or null	Branding background color

Example XML Response (switch to JSON)

<PropertyTimelineResponse xmlns="http://api.trademe.co.nz/v1">
  <Events>
    <PropertyTimelineDetail>
      <Price>123</Price>
      <DisplaySalePrice>ABC</DisplaySalePrice>
      <SaleType>ABC</SaleType>
      <SaleTypeDescription>ABC</SaleTypeDescription>
      <PriceOn>2018-01-01T00:00:00Z</PriceOn>
      <CapitalValue>123</CapitalValue>
      <ImprovementValue>123</ImprovementValue>
      <LandValue>123</LandValue>
      <DecadeBuilt>ABC</DecadeBuilt>
      <Value>ABC</Value>
      <Description>ABC</Description>
      <SaleAgents>
        <Agent>
          <ProfileImageUrl>ABC</ProfileImageUrl>
          <Name>ABC</Name>
          <UrlSlug>ABC</UrlSlug>
        </Agent>
        <Agent>
          <ProfileImageUrl>ABC</ProfileImageUrl>
          <Name>ABC</Name>
          <UrlSlug>ABC</UrlSlug>
        </Agent>
      </SaleAgents>
      <SaleBranches>
        <Branch>
          <OfficeMemberId>123</OfficeMemberId>
          <BranchName>ABC</BranchName>
          <LogoUrl>ABC</LogoUrl>
          <BrandingBackgroundColor>ABC</BrandingBackgroundColor>
        </Branch>
        <Branch>
          <OfficeMemberId>123</OfficeMemberId>
          <BranchName>ABC</BranchName>
          <LogoUrl>ABC</LogoUrl>
          <BrandingBackgroundColor>ABC</BrandingBackgroundColor>
        </Branch>
      </SaleBranches>
    </PropertyTimelineDetail>
    <PropertyTimelineDetail>
      <Price>123</Price>
      <DisplaySalePrice>ABC</DisplaySalePrice>
      <SaleType>ABC</SaleType>
      <SaleTypeDescription>ABC</SaleTypeDescription>
      <PriceOn>2018-01-01T00:00:00Z</PriceOn>
      <CapitalValue>123</CapitalValue>
      <ImprovementValue>123</ImprovementValue>
      <LandValue>123</LandValue>
      <DecadeBuilt>ABC</DecadeBuilt>
      <Value>ABC</Value>
      <Description>ABC</Description>
      <SaleAgents>
        <Agent>
          <ProfileImageUrl>ABC</ProfileImageUrl>
          <Name>ABC</Name>
          <UrlSlug>ABC</UrlSlug>
        </Agent>
        <Agent>
          <ProfileImageUrl>ABC</ProfileImageUrl>
          <Name>ABC</Name>
          <UrlSlug>ABC</UrlSlug>
        </Agent>
      </SaleAgents>
      <SaleBranches>
        <Branch>
          <OfficeMemberId>123</OfficeMemberId>
          <BranchName>ABC</BranchName>
          <LogoUrl>ABC</LogoUrl>
          <BrandingBackgroundColor>ABC</BrandingBackgroundColor>
        </Branch>
        <Branch>
          <OfficeMemberId>123</OfficeMemberId>
          <BranchName>ABC</BranchName>
          <LogoUrl>ABC</LogoUrl>
          <BrandingBackgroundColor>ABC</BrandingBackgroundColor>
        </Branch>
      </SaleBranches>
    </PropertyTimelineDetail>
  </Events>
</PropertyTimelineResponse>

Example JSON Response (switch to XML)

{
  "Events": [
    {
      "Price": 123,
      "DisplaySalePrice": "ABC",
      "SaleType": "ABC",
      "SaleTypeDescription": "ABC",
      "PriceOn": "\/Date(1514764800)\/",
      "CapitalValue": 123,
      "ImprovementValue": 123,
      "LandValue": 123,
      "DecadeBuilt": "ABC",
      "Value": "ABC",
      "Description": "ABC",
      "SaleAgents": [
        {
          "ProfileImageUrl": "ABC",
          "Name": "ABC",
          "UrlSlug": "ABC"
        },
        {
          "ProfileImageUrl": "ABC",
          "Name": "ABC",
          "UrlSlug": "ABC"
        }
      ],
      "SaleBranches": [
        {
          "OfficeMemberId": 123,
          "BranchName": "ABC",
          "LogoUrl": "ABC",
          "BrandingBackgroundColor": "ABC"
        },
        {
          "OfficeMemberId": 123,
          "BranchName": "ABC",
          "LogoUrl": "ABC",
          "BrandingBackgroundColor": "ABC"
        }
      ]
    },
    {
      "Price": 123,
      "DisplaySalePrice": "ABC",
      "SaleType": "ABC",
      "SaleTypeDescription": "ABC",
      "PriceOn": "\/Date(1514764800)\/",
      "CapitalValue": 123,
      "ImprovementValue": 123,
      "LandValue": 123,
      "DecadeBuilt": "ABC",
      "Value": "ABC",
      "Description": "ABC",
      "SaleAgents": [
        {
          "ProfileImageUrl": "ABC",
          "Name": "ABC",
          "UrlSlug": "ABC"
        },
        {
          "ProfileImageUrl": "ABC",
          "Name": "ABC",
          "UrlSlug": "ABC"
        }
      ],
      "SaleBranches": [
        {
          "OfficeMemberId": 123,
          "BranchName": "ABC",
          "LogoUrl": "ABC",
          "BrandingBackgroundColor": "ABC"
        },
        {
          "OfficeMemberId": 123,
          "BranchName": "ABC",
          "LogoUrl": "ABC",
          "BrandingBackgroundColor": "ABC"
        }
      ]
    }
  ]
}