Website logo

Retrieve hot listings

Retrieves the hot items for the whole country or for a single region.

URL: https://api.trademe.co.nz/v1/Listings/Hot.{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

buy Enumeration (optional)

Filters listings to only those with Buy Now.

All

Any.

BuyNow

Only items with Buy Now.

clearance Enumeration (optional)

Filters listings to only those on clearance, for stores that have set clearance items.

All

No clearance filter is applied

Clearance

Results are restricted to those marked as clearance

OnSale

Results are restricted to those marked as clearance and which are on sale.

condition Enumeration (optional)

Filter listings by condition.

All

Any condition.

New

The item is new.

Used

The item is used.

page Integer (optional)

The page number of the set of results to return, starting from 1. Defaults to 1.

pay Enumeration (optional)

Filters listings to only those with Pay Now.

All

Any method of payment.

PayNow

Items supporting Pay Now or Ping. Deprecated please use 'Ping'.

Afterpay

Items supporting Afterpay.

Ping

Items supporting Ping.

photo_size Enumeration (optional)

The size of the images to return in the results. Defaults to Thumbnail.

Thumbnail

The thumbnail sized photo (always 85x64, with white borders).

List

The list view sized photo (scaled down to fit 160x120).

Medium

The medium sized photo (scaled down to fit 175x175).

Gallery

The gallery sized photo (scaled down to fit 233x176).

Large

The large sized photo (scaled down to fit 352x264).

FullSize

The full sized photo (scaled down to fit 670x502).

region Integer (optional)

The ID of the region to return listings for. Defaults to 100 (all regions).

rows Integer (optional)

The number of results per page; also the maximum number of results to return. Defaults to 50.

sort_order Enumeration (optional)

Sorts the returned results using the specified sort order.

Default

The default sort order. The exact sort order depends on the type of search (for example, simple category searches show featured listings first, but keyword searches show the best matches first).

FeaturedFirst

Featured listings are shown at the top of the list. The secondary sort order depends on the search (can be either expiry date or best match). In some categories listings with Gallery are given priority over those without, but will still follow Featured listings.

SuperGridFeaturedFirst

Used to order by feature first for supergrid layout.

TitleAsc

Sort by title (alphabetically).

ExpiryAsc

Sort by expiry date (expiring soon).

ExpiryDesc

Sort by expiry date (newest listings).

PriceAsc

Sort by price (lowest to highest).

PriceDesc

Sort by price (highest to lowest).

BidsMost

Sort by number of bids (highest to lowest).

BuyNowAsc

Sort by Buy Now price (lowest to highest).

BuyNowDesc

Sort by Buy Now price (highest to lowest).

ReviewsDesc

Sort by number of reviews (highest to lowest). Applies to services listings only.

MotorsExpiryAsc

Motors only sort by expiry date (expiring soon).

MotorsLatestListings

Motors only sort by expiry date (newest listings).

MotorsTitleAsc

Motors only sort by title (alphabetically).

HighestSalary

Sort by salary (highest to lowest). Only applicable to jobs.

LowestSalary

Sort by salary (lowest to highest). Only applicable to jobs.

MotorsLowestKilometres

Sort by number of kilometres (lowest to highest). Only applicable to motors. For boats, this sort order uses the number of engine hours instead of kilometres.

MotorsHighestKilometres

Sort by number of kilometres (highest to lowest). Only applicable to motors. For boats, this sort order uses the number of engine hours instead of kilometres.

MotorsNewestVehicle

Sort by year of manufacture (newest to oldest). Only applicable to motors.

MotorsOldestVehicle

Sort by year of manufacture (oldest to newest). Only applicable to motors.

BestMatch

Sort by best match. Only applicable to jobs.

LargestDiscount

Sort by largest discount (highest to lowest).

PropertyFeature

Sort by featured first, with premium listings taking priority on featured

EarliestOpenHome

Sort by earliest open home (not ones in the past) on the nested field `OpenHomesStartDate` and then by `HasTopTier`, `IsFeature`, `RefreshDate` descending.

Returns

<HotListings>

TotalCount Integer

The total number of results in the collection. Can be larger than the number of returned results.

TotalCountTruncated Boolean

True if the total count of results exceeded the allowed maximum and was truncated.

Page Integer

The index of the current page of results (starts at 1).

PageSize Integer

The number of results in the current page.

List Collection of <Listing> or null

A list of the results in the current page.

ListingId Long Integer

The ID of the listing.

Title String or null

The listing title.

Category String or null

The listing category.

StartPrice Number

The start price.

BuyNowPrice Number

The Buy Now price.

StartDate DateTime

The date the listing was created.

EndDate DateTime

The date the listing will end.

IsFeatured Boolean

Is this a featured listing?

HasGallery Boolean

Is this a gallery listing?

IsBold Boolean

Is this a bold listing?

IsHighlighted Boolean

Is this a highlighted listing?

HasHomePageFeature Boolean

Is this a homepage feature listing?

MaxBidAmount Number

The current leading bid amount.

AsAt DateTime

The date and time the response was generated on the server.

CategoryPath String or null

The category path.

PictureHref String or null

The URL of the primary photo for the listing (if the listing has a photo). By default you'll get a thumbnail-sized photo, but you can control the size of the photo using the photo_size parameter.

HasPayNow Boolean

Indicates whether the item has Pay Now.

IsNew Boolean

Indicates whether the item is marked as new.

RegionId Integer

The ID of the region where this item is located. In the general search, listing details and watchlist APIs this is the ID of the seller's region (using the two-tier region/suburb system), which means it might be inconsistent with the region name. In the property search API this is the ID of the property region, using the three-tier region/district/suburb system.

This field cannot cope with the two main geographical classification systems. Except for the property search API, it should not be used.

Region String or null

The name of the region where this item is located.

SuburbId Integer

The ID of the suburb where this item is located. Only populated by the property search API, which means it uses the three-tier region/district/suburb system.

Suburb String or null

The name of the suburb where this item is located.

BidCount Integer

The number of bids on the item.

IsReserveMet Boolean

Indicates whether the item's reserve has been met.

HasReserve Boolean

Indicates whether the item has a reserve.

HasBuyNow Boolean

Indicates whether the item has Buy Now.

NoteDate DateTime

The date of the note on an item.

ReserveState Enumeration

The flag to display on an item.

None 0

There is no reserve on the item (i.e. the reserve price is the same as the starting price).

Met 1

The value of the highest bid has exceeded the reserve price.

NotMet 2

The value of the highest bid has not reached the reserve price.

NotApplicable 3

The listing cannot have a reserve because bidding is not allowed. This may be because it is a classified or because it is a Buy Now Only auction.

IsClassified Boolean

Indicates whether the item is a classified.

OpenHomes Collection of <OpenHome> or null

A collection of open home times for this listing. Only applies to open home listings.

Start DateTime

The date and time the open home is open for viewing. The date must be in the future and it must be less than 56 days from the current date. Specify dates in the UTC time zone.

End DateTime

The date and time the open home is no longer open for viewing. Must be the same day as Start.

Subtitle String or null

The subtitle, if present.

IsBuyNowOnly Boolean

Indicates whether or not this is a Buy Now Only listing.

RemainingGalleryPlusRelists Integer or null

The number of times the item can be relisted and get the gallery promotion for free. This value is only present if you are the seller and the listing had the gallery promotion applied due to the gallery plus promotion. Note that for this field, a value of zero is not the same as if the field is missing (a value of zero means gallery plus is in effect whereas if the field is missing it means that you are not the seller or gallery plus is not in effect).

IsOnWatchList Boolean

Indicates whether the item is on the authenticated member's watchlist.

GeographicLocation <GeographicLocation> or null

The geographic location (latitude and longitude) of a property.

Latitude Number

The latitude of the location, in degrees (WGS84).

Longitude Number

The longitude of the location, in degrees (WGS84).

Northing Integer

The northing of the location, in metres (NZTM).

Easting Integer

The easting of the location, in metres (NZTM).

Accuracy Enumeration

The accuracy of the geographic location (address, street or suburb).

None 0

The accuracy of the geographic location is not known.

Address 1

The geographic location is accurate to the address level.

Street 3

The geographic location is accurate to the street level.

Suburb 2

The geographic location is accurate to the suburb level.

PriceDisplay String or null

The price, in a format suitable for displaying to the user. Some categories may have special pricing rules, e.g. properties may have "Price by negotiation".

TotalReviewCount Integer

The total number of user-submitted reviews. Currently only applies to services listings.

PositiveReviewCount Integer

The number of user-submitted reviews which are positive (i.e. the user selected the thumbs up graphic when submitting a review). Currently only applies to services listings.

HasFreeShipping Boolean

Indicates if the listing offers free shipping as an option

IsClearance Boolean

This indicates that the listing is a clearance item. Clearance listings include listings with was/now pricing and general clearance stock.

WasPrice Number or null

The usual price that a product is sold at, or the price before it was marked down. This is always more than the Buy Now price for Auctions, or more than the asking price for Classifieds.This field will only be populated if IsClearance is true.

PercentageOff Integer or null

The percentage that a product has been discounted. This has been rounded for display purposes. This field will only be populated if IsClearance is true.

Branding <Branding> or null

A list of branding images associated with this listing.

LargeSquareLogo String or null

A large square branding image with dimensions of 480x480.

LargeWideLogo String or null

A large rectangular branding image with dimensions of 480x200.

BackgroundColor String or null

Banner outline/stroke colour, tick the checkbox before saving to apply the new colour

TextColor String or null

Banner background colour, tick the checkbox before saving to apply the new colour

StrokeColor String or null

Banner text colour, tick the checkbox before saving to apply the new colour

DisableBanner Boolean

Disable the agent branding regardless of Super Feature status

OfficeLocation String or null

The name of the office location

LargeBannerURL String or null

The url of a larger version of the logo

IsSuperFeatured Boolean

Is this a super featured listing?

ShortDescription String or null

Short description of a listing. This is Jobs and Services specfic.

PhotoUrls Collection of String or null

A collection of photo urls for the listing

PromotionId Integer or null

The ID of the promotion applied to this listing.

HasEmbeddedVideo Boolean

Indicates whether the listing has an embedded video

VariantDefinitionSummary <VariantDefinitionSummary> or null

A summary of the variant information.

PriceLow Number or null

The lowest price of all the variants, if there is a price range.

PriceHigh Number or null

The highest price of all the variants, if there is a price range.

Price Number or null

The price of all the variants, if they are all the same.

HasPriceRange Boolean

Whether or not the variants have a single price or a price range.

DiscountPercentLow Integer or null

The lowest discount percentage of all the variants, if there is a discount percentage range.

DiscountPercentHigh Integer or null

The highest discount percentage of all the variants, if there is a discount percentage range.

DiscountPercent Integer or null

The discount percentage of all the variants, if they are all the same.

HasDiscountPercentRange Boolean

Whether or not the variants have a single discount percentage or a discount percentage range.

AllDiscounted Boolean

Whether or not the variants are all discounted.

AllOnClearance Boolean

Whether or not the variants are all on clearance.

AdditionalData <AdditionalData> or null

Structured information for Listing Additional Data

BulletPoints Collection of String or null

The bullet points for display in the search results

Tags Collection of <Tag> or null

The tags for display in the search results

Name String or null

The name of the tag

ListingExtras Collection of String or null

A collection of extras that are currently applied to the listing

IsLoyaltyEligible Boolean

Indicates whether the listing is eligible to loyalty program.

HasPing Boolean

Indicates whether Ping is a supported payment option.

StoreBrandLogoUrl String or null

The store seller profile photo Url. This field is populated only if below criterias met - Listing has Gallery or Feature depth products - Listing belongs to a store - Store has a tier where store brand logo feature has turned on

WhyPayPrice Number or null

The why pay marketing price that is supplied by the deal provider when they create listings for our deal channel.

Has3DTour Boolean

Indicates whether the listing has a 3D Tour

FoundCategories Collection of <FoundCategory> or null

A collection of suggested categories and the number of search results in each category.

Count Integer

The number of results that were found in this category.

Category String or null

The category identifier string in the form nnnn- (e.g. "0344-3357-6420-").

Name String or null

The name of the category (e.g. "Blackberry").

IsRestricted Boolean

True if the category is restricted. All R18 categories are restricted by default.

CategoryId Integer

The category id (e.g. 6420).

IsLeaf Boolean

True if the category is a leaf category

Parameters Collection of <SearchParameter> or null

A list of search parameters which are applicable to the searched category. Not returned unless return_metadata is true.

DisplayName String or null

The name of the search parameter, in a form suitable for displaying to the user.

Name String or null

The name of the search parameter.

Type Enumeration

Indicates the type of the parameter value.

Boolean 0

The parameter value is a boolean (true/false). The default value for boolean parameters is false.

Numeric 1

The parameter value is numeric, with min and max.

String 2

The parameter value is textual.

PropertyRegionId 3

The parameter value should be a property region ID.

PropertyDistrictId 4

The parameter value should be a property district ID.

PropertySuburbId 5

The parameter value should be a property suburb ID.

Location 6

The parameter value should be a location.

AllowsMultipleValues Boolean

Indicates the user is allowed to select multiple values. Each value should be comma-separated. Currently applies only to String parameters.

DependentOn String or null

If present, the Name (not the DisplayName) of another parameter. If the user is filtering by that other parameter, then this filter becomes available for use. The parameter that is referenced will be a single-valued (non-ranged).

ExternalOptionsKey String or null

If present, indicates that the list of options is not immediately available, but can be retrieved from the SearchOptions API endpoint. The value is the key that should be passed to the SearchOptions API. Either the list of options is really long, or the list is dependent on the value of another parameter (see the DependentOn field).

Options Collection of <AttributeOption> or null

A list of options to display to the user.

Value String or null

The value of the item as a string.

Display String or null

What should be displayed for this value (often the same).

DependentParameter <SearchParameter> or null

Dependent parameter to display cascading structure

(This type has already been defined)
DisplaySuggested Boolean

Indicates this parameter should be displayed by default

SortOrders Collection of <AttributeOption> or null

A list of sort orders which are applicable to the searched category. Not returned unless return_metadata is true.

(This type has already been defined)

Example XML Response (switch to JSON)

<HotListings xmlns="http://api.trademe.co.nz/v1">
  <TotalCount>123</TotalCount>
  <TotalCountTruncated>false</TotalCountTruncated>
  <Page>123</Page>
  <PageSize>123</PageSize>
  <List>
    <Listing>
      <ListingId>123</ListingId>
      <Title>ABC</Title>
      <Category>ABC</Category>
      <StartPrice>123.0</StartPrice>
      <BuyNowPrice>123.0</BuyNowPrice>
      <StartDate>2018-01-01T00:00:00Z</StartDate>
      <EndDate>2018-01-01T00:00:00Z</EndDate>
      <IsFeatured>false</IsFeatured>
      <HasGallery>false</HasGallery>
      <IsBold>false</IsBold>
      <IsHighlighted>false</IsHighlighted>
      <HasHomePageFeature>false</HasHomePageFeature>
      <MaxBidAmount>123.0</MaxBidAmount>
      <AsAt>2018-01-01T00:00:00Z</AsAt>
      <CategoryPath>ABC</CategoryPath>
      <PictureHref>ABC</PictureHref>
      <HasPayNow>false</HasPayNow>
      <IsNew>false</IsNew>
      <RegionId>123</RegionId>
      <Region>ABC</Region>
      <SuburbId>123</SuburbId>
      <Suburb>ABC</Suburb>
      <BidCount>123</BidCount>
      <IsReserveMet>false</IsReserveMet>
      <HasReserve>false</HasReserve>
      <HasBuyNow>false</HasBuyNow>
      <NoteDate>2018-01-01T00:00:00Z</NoteDate>
      <ReserveState>None</ReserveState>
      <IsClassified>false</IsClassified>
      <OpenHomes>
        <OpenHome>
          <Start>2018-01-01T00:00:00Z</Start>
          <End>2018-01-01T00:00:00Z</End>
        </OpenHome>
        <OpenHome>
          <Start>2018-01-01T00:00:00Z</Start>
          <End>2018-01-01T00:00:00Z</End>
        </OpenHome>
      </OpenHomes>
      <Subtitle>ABC</Subtitle>
      <IsBuyNowOnly>false</IsBuyNowOnly>
      <RemainingGalleryPlusRelists>123</RemainingGalleryPlusRelists>
      <IsOnWatchList>false</IsOnWatchList>
      <GeographicLocation>
        <Latitude>123.0</Latitude>
        <Longitude>123.0</Longitude>
        <Northing>123</Northing>
        <Easting>123</Easting>
        <Accuracy>None</Accuracy>
      </GeographicLocation>
      <PriceDisplay>ABC</PriceDisplay>
      <TotalReviewCount>123</TotalReviewCount>
      <PositiveReviewCount>123</PositiveReviewCount>
      <HasFreeShipping>false</HasFreeShipping>
      <IsClearance>false</IsClearance>
      <WasPrice>123.0</WasPrice>
      <PercentageOff>123</PercentageOff>
      <Branding>
        <LargeSquareLogo>ABC</LargeSquareLogo>
        <LargeWideLogo>ABC</LargeWideLogo>
        <BackgroundColor>ABC</BackgroundColor>
        <TextColor>ABC</TextColor>
        <StrokeColor>ABC</StrokeColor>
        <DisableBanner>false</DisableBanner>
        <OfficeLocation>ABC</OfficeLocation>
        <LargeBannerURL>ABC</LargeBannerURL>
      </Branding>
      <IsSuperFeatured>false</IsSuperFeatured>
      <ShortDescription>ABC</ShortDescription>
      <PhotoUrls>
        <PhotoUrl>ABC</PhotoUrl>
        <PhotoUrl>ABC</PhotoUrl>
      </PhotoUrls>
      <PromotionId>123</PromotionId>
      <HasEmbeddedVideo>false</HasEmbeddedVideo>
      <VariantDefinitionSummary>
        <PriceLow>123.0</PriceLow>
        <PriceHigh>123.0</PriceHigh>
        <Price>123.0</Price>
        <HasPriceRange>false</HasPriceRange>
        <DiscountPercentLow>123</DiscountPercentLow>
        <DiscountPercentHigh>123</DiscountPercentHigh>
        <DiscountPercent>123</DiscountPercent>
        <HasDiscountPercentRange>false</HasDiscountPercentRange>
        <AllDiscounted>false</AllDiscounted>
        <AllOnClearance>false</AllOnClearance>
      </VariantDefinitionSummary>
      <AdditionalData>
        <BulletPoints>
          <BulletPoint>ABC</BulletPoint>
          <BulletPoint>ABC</BulletPoint>
        </BulletPoints>
        <Tags>
          <Tag>
            <Name>ABC</Name>
          </Tag>
          <Tag>
            <Name>ABC</Name>
          </Tag>
        </Tags>
      </AdditionalData>
      <ListingExtras>
        <ListingExtra>ABC</ListingExtra>
        <ListingExtra>ABC</ListingExtra>
      </ListingExtras>
      <IsLoyaltyEligible>false</IsLoyaltyEligible>
      <HasPing>false</HasPing>
      <StoreBrandLogoUrl>ABC</StoreBrandLogoUrl>
      <WhyPayPrice>123.0</WhyPayPrice>
      <Has3DTour>false</Has3DTour>
    </Listing>
    <Listing>
      <ListingId>123</ListingId>
      <Title>ABC</Title>
      <Category>ABC</Category>
      <StartPrice>123.0</StartPrice>
      <BuyNowPrice>123.0</BuyNowPrice>
      <StartDate>2018-01-01T00:00:00Z</StartDate>
      <EndDate>2018-01-01T00:00:00Z</EndDate>
      <IsFeatured>false</IsFeatured>
      <HasGallery>false</HasGallery>
      <IsBold>false</IsBold>
      <IsHighlighted>false</IsHighlighted>
      <HasHomePageFeature>false</HasHomePageFeature>
      <MaxBidAmount>123.0</MaxBidAmount>
      <AsAt>2018-01-01T00:00:00Z</AsAt>
      <CategoryPath>ABC</CategoryPath>
      <PictureHref>ABC</PictureHref>
      <HasPayNow>false</HasPayNow>
      <IsNew>false</IsNew>
      <RegionId>123</RegionId>
      <Region>ABC</Region>
      <SuburbId>123</SuburbId>
      <Suburb>ABC</Suburb>
      <BidCount>123</BidCount>
      <IsReserveMet>false</IsReserveMet>
      <HasReserve>false</HasReserve>
      <HasBuyNow>false</HasBuyNow>
      <NoteDate>2018-01-01T00:00:00Z</NoteDate>
      <ReserveState>None</ReserveState>
      <IsClassified>false</IsClassified>
      <OpenHomes>
        <OpenHome>
          <Start>2018-01-01T00:00:00Z</Start>
          <End>2018-01-01T00:00:00Z</End>
        </OpenHome>
        <OpenHome>
          <Start>2018-01-01T00:00:00Z</Start>
          <End>2018-01-01T00:00:00Z</End>
        </OpenHome>
      </OpenHomes>
      <Subtitle>ABC</Subtitle>
      <IsBuyNowOnly>false</IsBuyNowOnly>
      <RemainingGalleryPlusRelists>123</RemainingGalleryPlusRelists>
      <IsOnWatchList>false</IsOnWatchList>
      <GeographicLocation>
        <Latitude>123.0</Latitude>
        <Longitude>123.0</Longitude>
        <Northing>123</Northing>
        <Easting>123</Easting>
        <Accuracy>None</Accuracy>
      </GeographicLocation>
      <PriceDisplay>ABC</PriceDisplay>
      <TotalReviewCount>123</TotalReviewCount>
      <PositiveReviewCount>123</PositiveReviewCount>
      <HasFreeShipping>false</HasFreeShipping>
      <IsClearance>false</IsClearance>
      <WasPrice>123.0</WasPrice>
      <PercentageOff>123</PercentageOff>
      <Branding>
        <LargeSquareLogo>ABC</LargeSquareLogo>
        <LargeWideLogo>ABC</LargeWideLogo>
        <BackgroundColor>ABC</BackgroundColor>
        <TextColor>ABC</TextColor>
        <StrokeColor>ABC</StrokeColor>
        <DisableBanner>false</DisableBanner>
        <OfficeLocation>ABC</OfficeLocation>
        <LargeBannerURL>ABC</LargeBannerURL>
      </Branding>
      <IsSuperFeatured>false</IsSuperFeatured>
      <ShortDescription>ABC</ShortDescription>
      <PhotoUrls>
        <PhotoUrl>ABC</PhotoUrl>
        <PhotoUrl>ABC</PhotoUrl>
      </PhotoUrls>
      <PromotionId>123</PromotionId>
      <HasEmbeddedVideo>false</HasEmbeddedVideo>
      <VariantDefinitionSummary>
        <PriceLow>123.0</PriceLow>
        <PriceHigh>123.0</PriceHigh>
        <Price>123.0</Price>
        <HasPriceRange>false</HasPriceRange>
        <DiscountPercentLow>123</DiscountPercentLow>
        <DiscountPercentHigh>123</DiscountPercentHigh>
        <DiscountPercent>123</DiscountPercent>
        <HasDiscountPercentRange>false</HasDiscountPercentRange>
        <AllDiscounted>false</AllDiscounted>
        <AllOnClearance>false</AllOnClearance>
      </VariantDefinitionSummary>
      <AdditionalData>
        <BulletPoints>
          <BulletPoint>ABC</BulletPoint>
          <BulletPoint>ABC</BulletPoint>
        </BulletPoints>
        <Tags>
          <Tag>
            <Name>ABC</Name>
          </Tag>
          <Tag>
            <Name>ABC</Name>
          </Tag>
        </Tags>
      </AdditionalData>
      <ListingExtras>
        <ListingExtra>ABC</ListingExtra>
        <ListingExtra>ABC</ListingExtra>
      </ListingExtras>
      <IsLoyaltyEligible>false</IsLoyaltyEligible>
      <HasPing>false</HasPing>
      <StoreBrandLogoUrl>ABC</StoreBrandLogoUrl>
      <WhyPayPrice>123.0</WhyPayPrice>
      <Has3DTour>false</Has3DTour>
    </Listing>
  </List>
  <FoundCategories>
    <FoundCategory>
      <Count>123</Count>
      <Category>ABC</Category>
      <Name>ABC</Name>
      <IsRestricted>false</IsRestricted>
      <CategoryId>123</CategoryId>
      <IsLeaf>false</IsLeaf>
    </FoundCategory>
    <FoundCategory>
      <Count>123</Count>
      <Category>ABC</Category>
      <Name>ABC</Name>
      <IsRestricted>false</IsRestricted>
      <CategoryId>123</CategoryId>
      <IsLeaf>false</IsLeaf>
    </FoundCategory>
  </FoundCategories>
  <Parameters>
    <SearchParameter>
      <DisplayName>ABC</DisplayName>
      <Name>ABC</Name>
      <Type>Boolean</Type>
      <AllowsMultipleValues>false</AllowsMultipleValues>
      <DependentOn>ABC</DependentOn>
      <ExternalOptionsKey>ABC</ExternalOptionsKey>
      <Options>
        <AttributeOption>
          <Value>ABC</Value>
          <Display>ABC</Display>
        </AttributeOption>
        <AttributeOption>
          <Value>ABC</Value>
          <Display>ABC</Display>
        </AttributeOption>
      </Options>
      <DependentParameter />
      <DisplaySuggested>false</DisplaySuggested>
    </SearchParameter>
    <SearchParameter>
      <DisplayName>ABC</DisplayName>
      <Name>ABC</Name>
      <Type>Boolean</Type>
      <AllowsMultipleValues>false</AllowsMultipleValues>
      <DependentOn>ABC</DependentOn>
      <ExternalOptionsKey>ABC</ExternalOptionsKey>
      <Options>
        <AttributeOption>
          <Value>ABC</Value>
          <Display>ABC</Display>
        </AttributeOption>
        <AttributeOption>
          <Value>ABC</Value>
          <Display>ABC</Display>
        </AttributeOption>
      </Options>
      <DependentParameter />
      <DisplaySuggested>false</DisplaySuggested>
    </SearchParameter>
  </Parameters>
  <SortOrders>
    <AttributeOption />
    <AttributeOption />
  </SortOrders>
</HotListings>

Example JSON Response (switch to XML)

{
  "TotalCount": 123,
  "TotalCountTruncated": false,
  "Page": 123,
  "PageSize": 123,
  "List": [
    {
      "ListingId": 123,
      "Title": "ABC",
      "Category": "ABC",
      "StartPrice": 123.0,
      "BuyNowPrice": 123.0,
      "StartDate": "\/Date(1514764800)\/",
      "EndDate": "\/Date(1514764800)\/",
      "IsFeatured": false,
      "HasGallery": false,
      "IsBold": false,
      "IsHighlighted": false,
      "HasHomePageFeature": false,
      "MaxBidAmount": 123.0,
      "AsAt": "\/Date(1514764800)\/",
      "CategoryPath": "ABC",
      "PictureHref": "ABC",
      "HasPayNow": false,
      "IsNew": false,
      "RegionId": 123,
      "Region": "ABC",
      "SuburbId": 123,
      "Suburb": "ABC",
      "BidCount": 123,
      "IsReserveMet": false,
      "HasReserve": false,
      "HasBuyNow": false,
      "NoteDate": "\/Date(1514764800)\/",
      "ReserveState": 0,
      "IsClassified": false,
      "OpenHomes": [
        {
          "Start": "\/Date(1514764800)\/",
          "End": "\/Date(1514764800)\/"
        },
        {
          "Start": "\/Date(1514764800)\/",
          "End": "\/Date(1514764800)\/"
        }
      ],
      "Subtitle": "ABC",
      "IsBuyNowOnly": false,
      "RemainingGalleryPlusRelists": 123,
      "IsOnWatchList": false,
      "GeographicLocation": {
        "Latitude": 123.0,
        "Longitude": 123.0,
        "Northing": 123,
        "Easting": 123,
        "Accuracy": 0
      },
      "PriceDisplay": "ABC",
      "TotalReviewCount": 123,
      "PositiveReviewCount": 123,
      "HasFreeShipping": false,
      "IsClearance": false,
      "WasPrice": 123.0,
      "PercentageOff": 123,
      "Branding": {
        "LargeSquareLogo": "ABC",
        "LargeWideLogo": "ABC",
        "BackgroundColor": "ABC",
        "TextColor": "ABC",
        "StrokeColor": "ABC",
        "DisableBanner": false,
        "OfficeLocation": "ABC",
        "LargeBannerURL": "ABC"
      },
      "IsSuperFeatured": false,
      "ShortDescription": "ABC",
      "PhotoUrls": [
        "ABC",
        "ABC"
      ],
      "PromotionId": 123,
      "HasEmbeddedVideo": false,
      "VariantDefinitionSummary": {
        "PriceLow": 123.0,
        "PriceHigh": 123.0,
        "Price": 123.0,
        "HasPriceRange": false,
        "DiscountPercentLow": 123,
        "DiscountPercentHigh": 123,
        "DiscountPercent": 123,
        "HasDiscountPercentRange": false,
        "AllDiscounted": false,
        "AllOnClearance": false
      },
      "AdditionalData": {
        "BulletPoints": [
          "ABC",
          "ABC"
        ],
        "Tags": [
          {
            "Name": "ABC"
          },
          {
            "Name": "ABC"
          }
        ]
      },
      "ListingExtras": [
        "ABC",
        "ABC"
      ],
      "IsLoyaltyEligible": false,
      "HasPing": false,
      "StoreBrandLogoUrl": "ABC",
      "WhyPayPrice": 123.0,
      "Has3DTour": false
    },
    {
      "ListingId": 123,
      "Title": "ABC",
      "Category": "ABC",
      "StartPrice": 123.0,
      "BuyNowPrice": 123.0,
      "StartDate": "\/Date(1514764800)\/",
      "EndDate": "\/Date(1514764800)\/",
      "IsFeatured": false,
      "HasGallery": false,
      "IsBold": false,
      "IsHighlighted": false,
      "HasHomePageFeature": false,
      "MaxBidAmount": 123.0,
      "AsAt": "\/Date(1514764800)\/",
      "CategoryPath": "ABC",
      "PictureHref": "ABC",
      "HasPayNow": false,
      "IsNew": false,
      "RegionId": 123,
      "Region": "ABC",
      "SuburbId": 123,
      "Suburb": "ABC",
      "BidCount": 123,
      "IsReserveMet": false,
      "HasReserve": false,
      "HasBuyNow": false,
      "NoteDate": "\/Date(1514764800)\/",
      "ReserveState": 0,
      "IsClassified": false,
      "OpenHomes": [
        {
          "Start": "\/Date(1514764800)\/",
          "End": "\/Date(1514764800)\/"
        },
        {
          "Start": "\/Date(1514764800)\/",
          "End": "\/Date(1514764800)\/"
        }
      ],
      "Subtitle": "ABC",
      "IsBuyNowOnly": false,
      "RemainingGalleryPlusRelists": 123,
      "IsOnWatchList": false,
      "GeographicLocation": {
        "Latitude": 123.0,
        "Longitude": 123.0,
        "Northing": 123,
        "Easting": 123,
        "Accuracy": 0
      },
      "PriceDisplay": "ABC",
      "TotalReviewCount": 123,
      "PositiveReviewCount": 123,
      "HasFreeShipping": false,
      "IsClearance": false,
      "WasPrice": 123.0,
      "PercentageOff": 123,
      "Branding": {
        "LargeSquareLogo": "ABC",
        "LargeWideLogo": "ABC",
        "BackgroundColor": "ABC",
        "TextColor": "ABC",
        "StrokeColor": "ABC",
        "DisableBanner": false,
        "OfficeLocation": "ABC",
        "LargeBannerURL": "ABC"
      },
      "IsSuperFeatured": false,
      "ShortDescription": "ABC",
      "PhotoUrls": [
        "ABC",
        "ABC"
      ],
      "PromotionId": 123,
      "HasEmbeddedVideo": false,
      "VariantDefinitionSummary": {
        "PriceLow": 123.0,
        "PriceHigh": 123.0,
        "Price": 123.0,
        "HasPriceRange": false,
        "DiscountPercentLow": 123,
        "DiscountPercentHigh": 123,
        "DiscountPercent": 123,
        "HasDiscountPercentRange": false,
        "AllDiscounted": false,
        "AllOnClearance": false
      },
      "AdditionalData": {
        "BulletPoints": [
          "ABC",
          "ABC"
        ],
        "Tags": [
          {
            "Name": "ABC"
          },
          {
            "Name": "ABC"
          }
        ]
      },
      "ListingExtras": [
        "ABC",
        "ABC"
      ],
      "IsLoyaltyEligible": false,
      "HasPing": false,
      "StoreBrandLogoUrl": "ABC",
      "WhyPayPrice": 123.0,
      "Has3DTour": false
    }
  ],
  "FoundCategories": [
    {
      "Count": 123,
      "Category": "ABC",
      "Name": "ABC",
      "IsRestricted": false,
      "CategoryId": 123,
      "IsLeaf": false
    },
    {
      "Count": 123,
      "Category": "ABC",
      "Name": "ABC",
      "IsRestricted": false,
      "CategoryId": 123,
      "IsLeaf": false
    }
  ],
  "Parameters": [
    {
      "DisplayName": "ABC",
      "Name": "ABC",
      "Type": 0,
      "AllowsMultipleValues": false,
      "DependentOn": "ABC",
      "ExternalOptionsKey": "ABC",
      "Options": [
        {
          "Value": "ABC",
          "Display": "ABC"
        },
        {
          "Value": "ABC",
          "Display": "ABC"
        }
      ],
      "DependentParameter": {
      },
      "DisplaySuggested": false
    },
    {
      "DisplayName": "ABC",
      "Name": "ABC",
      "Type": 0,
      "AllowsMultipleValues": false,
      "DependentOn": "ABC",
      "ExternalOptionsKey": "ABC",
      "Options": [
        {
          "Value": "ABC",
          "Display": "ABC"
        },
        {
          "Value": "ABC",
          "Display": "ABC"
        }
      ],
      "DependentParameter": {
      },
      "DisplaySuggested": false
    }
  ],
  "SortOrders": [
    {
    },
    {
    }
  ]
}