Website logo

Retrieve the recent searches for the logged in member

Retrieve the recent searches for the logged in member.

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

file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

Query String parameters

category_ids String (optional)

Comma separated list of category Ids. Default value is null and all recent searches will be returned.
return_favourite_id Boolean (optional)

true to populate the FavouriteId field. The default is false.

Returns

Collection of <RecentSearch>

A list of recent searches performed by the member.

Id String or null Id
SearchApi Enumeration SearchApi
General 0 General
UsedMotors 1 UsedMotors
MotorBoat 2 MotorBoat
MotorBike 3 MotorBike
Residential 4 Residential
Rental 5 Rental
CommercialSale 6 CommercialSale
CommercialLease 7 CommercialLease
Rural 8 Rural
Lifestyle 9 Lifestyle
Flatmate 10 Flatmate
OpenHomes 11 OpenHomes
Retirement 12 Retirement
Job 13 Job
NewHomes 14 NewHomes
Caravan 15 Caravan
Motorhome 16 Motorhome
SearchString String or null SearchString
Keywords String or null Keywords
Seller <Member> or null Seller
MemberId Integer MemberId
Nickname String or null Nickname
DateAddressVerified DateTime DateAddressVerified
DateJoined DateTime DateJoined
UniqueNegative Integer UniqueNegative
UniquePositive Integer UniquePositive
FeedbackCount Integer FeedbackCount
IsAddressVerified Boolean IsAddressVerified
IsDealer Boolean IsDealer
IsAuthenticated Boolean IsAuthenticated
IsInTrade Boolean IsInTrade
IsTopSeller Boolean IsTopSeller
CategoryName String or null CategoryName
CanonicalPath String or null CanonicalPath
Breadcrumbs Collection of <Breadcrumb> or null Breadcrumbs
DisplayName String or null DisplayName
CanonicalPath String or null CanonicalPath
CanonicalPathFragment String or null CanonicalPathFragment
Name String or null Name
Value String or null Value
AreaOfBusiness Enumeration AreaOfBusiness
NotSpecified 0 NotSpecified
All 0 All
Marketplace 1 Marketplace
Property 2 Property
Motors 3 Motors
Jobs 4 Jobs
Services 5 Services
Refinements Collection of <RefinementDescriptor> or null Refinements
DisplayName String or null DisplayName
DisplayValue String or null DisplayValue
FavouriteId Integer or null FavouriteId
Title String or null Title

Example XML Response (switch to JSON) 

<RecentSearchCollection xmlns="http://api.trademe.co.nz/v1">
  <RecentSearch>
    <Id>ABC</Id>
    <SearchApi>General</SearchApi>
    <SearchString>ABC</SearchString>
    <Keywords>ABC</Keywords>
    <Seller>
      <MemberId>123</MemberId>
      <Nickname>ABC</Nickname>
      <DateAddressVerified>2018-01-01T00:00:00Z</DateAddressVerified>
      <DateJoined>2018-01-01T00:00:00Z</DateJoined>
      <UniqueNegative>123</UniqueNegative>
      <UniquePositive>123</UniquePositive>
      <FeedbackCount>123</FeedbackCount>
      <IsAddressVerified>false</IsAddressVerified>
      <IsDealer>false</IsDealer>
      <IsAuthenticated>false</IsAuthenticated>
      <IsInTrade>false</IsInTrade>
      <IsTopSeller>false</IsTopSeller>
    </Seller>
    <CategoryName>ABC</CategoryName>
    <CanonicalPath>ABC</CanonicalPath>
    <Breadcrumbs>
      <Breadcrumb>
        <DisplayName>ABC</DisplayName>
        <CanonicalPath>ABC</CanonicalPath>
        <CanonicalPathFragment>ABC</CanonicalPathFragment>
        <Name>ABC</Name>
        <Value>ABC</Value>
      </Breadcrumb>
      <Breadcrumb>
        <DisplayName>ABC</DisplayName>
        <CanonicalPath>ABC</CanonicalPath>
        <CanonicalPathFragment>ABC</CanonicalPathFragment>
        <Name>ABC</Name>
        <Value>ABC</Value>
      </Breadcrumb>
    </Breadcrumbs>
    <AreaOfBusiness>NotSpecified</AreaOfBusiness>
    <Refinements>
      <RefinementDescriptor>
        <DisplayName>ABC</DisplayName>
        <DisplayValue>ABC</DisplayValue>
      </RefinementDescriptor>
      <RefinementDescriptor>
        <DisplayName>ABC</DisplayName>
        <DisplayValue>ABC</DisplayValue>
      </RefinementDescriptor>
    </Refinements>
    <FavouriteId>123</FavouriteId>
    <Title>ABC</Title>
  </RecentSearch>
  <RecentSearch>
    <Id>ABC</Id>
    <SearchApi>General</SearchApi>
    <SearchString>ABC</SearchString>
    <Keywords>ABC</Keywords>
    <Seller>
      <MemberId>123</MemberId>
      <Nickname>ABC</Nickname>
      <DateAddressVerified>2018-01-01T00:00:00Z</DateAddressVerified>
      <DateJoined>2018-01-01T00:00:00Z</DateJoined>
      <UniqueNegative>123</UniqueNegative>
      <UniquePositive>123</UniquePositive>
      <FeedbackCount>123</FeedbackCount>
      <IsAddressVerified>false</IsAddressVerified>
      <IsDealer>false</IsDealer>
      <IsAuthenticated>false</IsAuthenticated>
      <IsInTrade>false</IsInTrade>
      <IsTopSeller>false</IsTopSeller>
    </Seller>
    <CategoryName>ABC</CategoryName>
    <CanonicalPath>ABC</CanonicalPath>
    <Breadcrumbs>
      <Breadcrumb>
        <DisplayName>ABC</DisplayName>
        <CanonicalPath>ABC</CanonicalPath>
        <CanonicalPathFragment>ABC</CanonicalPathFragment>
        <Name>ABC</Name>
        <Value>ABC</Value>
      </Breadcrumb>
      <Breadcrumb>
        <DisplayName>ABC</DisplayName>
        <CanonicalPath>ABC</CanonicalPath>
        <CanonicalPathFragment>ABC</CanonicalPathFragment>
        <Name>ABC</Name>
        <Value>ABC</Value>
      </Breadcrumb>
    </Breadcrumbs>
    <AreaOfBusiness>NotSpecified</AreaOfBusiness>
    <Refinements>
      <RefinementDescriptor>
        <DisplayName>ABC</DisplayName>
        <DisplayValue>ABC</DisplayValue>
      </RefinementDescriptor>
      <RefinementDescriptor>
        <DisplayName>ABC</DisplayName>
        <DisplayValue>ABC</DisplayValue>
      </RefinementDescriptor>
    </Refinements>
    <FavouriteId>123</FavouriteId>
    <Title>ABC</Title>
  </RecentSearch>
</RecentSearchCollection>

Example JSON Response (switch to XML) 

[
  {
    "Id": "ABC",
    "SearchApi": 0,
    "SearchString": "ABC",
    "Keywords": "ABC",
    "Seller": {
      "MemberId": 123,
      "Nickname": "ABC",
      "DateAddressVerified": "\/Date(1514764800)\/",
      "DateJoined": "\/Date(1514764800)\/",
      "UniqueNegative": 123,
      "UniquePositive": 123,
      "FeedbackCount": 123,
      "IsAddressVerified": false,
      "IsDealer": false,
      "IsAuthenticated": false,
      "IsInTrade": false,
      "IsTopSeller": false
    },
    "CategoryName": "ABC",
    "CanonicalPath": "ABC",
    "Breadcrumbs": [
      {
        "DisplayName": "ABC",
        "CanonicalPath": "ABC",
        "CanonicalPathFragment": "ABC",
        "Name": "ABC",
        "Value": "ABC"
      },
      {
        "DisplayName": "ABC",
        "CanonicalPath": "ABC",
        "CanonicalPathFragment": "ABC",
        "Name": "ABC",
        "Value": "ABC"
      }
    ],
    "AreaOfBusiness": 0,
    "Refinements": [
      {
        "DisplayName": "ABC",
        "DisplayValue": "ABC"
      },
      {
        "DisplayName": "ABC",
        "DisplayValue": "ABC"
      }
    ],
    "FavouriteId": 123,
    "Title": "ABC"
  },
  {
    "Id": "ABC",
    "SearchApi": 0,
    "SearchString": "ABC",
    "Keywords": "ABC",
    "Seller": {
      "MemberId": 123,
      "Nickname": "ABC",
      "DateAddressVerified": "\/Date(1514764800)\/",
      "DateJoined": "\/Date(1514764800)\/",
      "UniqueNegative": 123,
      "UniquePositive": 123,
      "FeedbackCount": 123,
      "IsAddressVerified": false,
      "IsDealer": false,
      "IsAuthenticated": false,
      "IsInTrade": false,
      "IsTopSeller": false
    },
    "CategoryName": "ABC",
    "CanonicalPath": "ABC",
    "Breadcrumbs": [
      {
        "DisplayName": "ABC",
        "CanonicalPath": "ABC",
        "CanonicalPathFragment": "ABC",
        "Name": "ABC",
        "Value": "ABC"
      },
      {
        "DisplayName": "ABC",
        "CanonicalPath": "ABC",
        "CanonicalPathFragment": "ABC",
        "Name": "ABC",
        "Value": "ABC"
      }
    ],
    "AreaOfBusiness": 0,
    "Refinements": [
      {
        "DisplayName": "ABC",
        "DisplayValue": "ABC"
      },
      {
        "DisplayName": "ABC",
        "DisplayValue": "ABC"
      }
    ],
    "FavouriteId": 123,
    "Title": "ABC"
  }
]