Website logo

Retrieves landing page internal links and seo content for property

Retrieves internal links and seo content for the homepages of the property vertical

URL: https://api.trademe.co.nz/v1/seo/property/landingpageinfo.{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

vertical_search_tab Enumeration (optional)

Optional Enum ID for only using the tabs for a specific search page
ResidentialForSale ResidentialForSale
ResidentialForRent ResidentialForRent
SoldProperty SoldProperty
Flatmates Flatmates
RetirementVillages RetirementVillages
Agents Agents

Returns

<VerticalSeoLandingPageInfo>

SeoLandingPageContent Collection of <VerticalSeoLandingPageContent> or null

Landing page seo info collection for a vertical
DisplayTitle String or null

The homepage H1
PageTitle String or null

The Page title
PrimaryContentBlock <PagePrimaryContentBlock> or null

The content block will be displayed in homepage
Title String or null

Title of content block
Content String or null

Content of contentblock
Metadata <PageMetadata> or null

The site metadata
Title String or null

Meta title of page
Description String or null

Meta description of page
PageName String or null

The name of the vertical landing page
SeoLinks Collection of <SeoLinkGroup> or null

A list of SEO links for internal linking
VerticalSearchTab Enumeration

The vertical search tab refine value for the landing page, if applicable
ResidentialForSale 0 ResidentialForSale
ResidentialForRent 1 ResidentialForRent
SoldProperty 2 SoldProperty
Flatmates 3 Flatmates
RetirementVillages 4 RetirementVillages
Agents 5 Agents

Example XML Response (switch to JSON) 

<VerticalSeoLandingPageInfo xmlns="http://api.trademe.co.nz/v1">
  <SeoLandingPageContent>
    <VerticalSeoLandingPageContent>
      <DisplayTitle>ABC</DisplayTitle>
      <PageTitle>ABC</PageTitle>
      <PrimaryContentBlock>
        <Title>ABC</Title>
        <Content>ABC</Content>
      </PrimaryContentBlock>
      <Metadata>
        <Title>ABC</Title>
        <Description>ABC</Description>
      </Metadata>
      <PageName>ABC</PageName>
    </VerticalSeoLandingPageContent>
    <VerticalSeoLandingPageContent>
      <DisplayTitle>ABC</DisplayTitle>
      <PageTitle>ABC</PageTitle>
      <PrimaryContentBlock>
        <Title>ABC</Title>
        <Content>ABC</Content>
      </PrimaryContentBlock>
      <Metadata>
        <Title>ABC</Title>
        <Description>ABC</Description>
      </Metadata>
      <PageName>ABC</PageName>
    </VerticalSeoLandingPageContent>
  </SeoLandingPageContent>
  <SeoLinks>
    <SeoLinkGroup />
    <SeoLinkGroup />
  </SeoLinks>
  <VerticalSearchTab>ResidentialForSale</VerticalSearchTab>
</VerticalSeoLandingPageInfo>

Example JSON Response (switch to XML) 

{
  "SeoLandingPageContent": [
    {
      "DisplayTitle": "ABC",
      "PageTitle": "ABC",
      "PrimaryContentBlock": {
        "Title": "ABC",
        "Content": "ABC"
      },
      "Metadata": {
        "Title": "ABC",
        "Description": "ABC"
      },
      "PageName": "ABC"
    },
    {
      "DisplayTitle": "ABC",
      "PageTitle": "ABC",
      "PrimaryContentBlock": {
        "Title": "ABC",
        "Content": "ABC"
      },
      "Metadata": {
        "Title": "ABC",
        "Description": "ABC"
      },
      "PageName": "ABC"
    }
  ],
  "SeoLinks": [
    {
    },
    {
    }
  ],
  "VerticalSearchTab": 0
}