Skip to main content
POST
/
api
/
trademe
/
agents
/
search
/trademe/agents/search
curl --request POST \
  --url https://api.anysite.io/api/trademe/agents/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "count": 2,
  "timeout": 300,
  "location": "auckland",
  "keyword": "barfoot",
  "sort": "featured"
}
'
[
  {
    "alias": "<string>",
    "@type": "@trademe_agent_card",
    "first_name": "<string>",
    "last_name": "<string>",
    "agency_name": "<string>",
    "work_phone": "<string>",
    "mobile_phone": "<string>",
    "image": "<string>",
    "agency_image": "<string>",
    "sold_listing_count": 123,
    "live_listing_count": 123,
    "is_partner": true,
    "recently_sold": []
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
count
integer
required

Max number of results to return

Required range: x >= 1
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
location
string | null

Location slug to find agents in (e.g. 'auckland', 'wellington').

Example:

"auckland"

keyword
string | null

Agent name or agency name to search for.

Example:

"barfoot"

sort
enum<string>
default:featured

Result ordering.

Available options:
featured,
sold_listings,
first_name_asc,
first_name_desc,
last_name_asc,
last_name_desc

Response

Successful Response

alias
string
required
@type
string
default:@trademe_agent_card
first_name
string | null
last_name
string | null
agency_name
string | null
work_phone
string | null
mobile_phone
string | null
image
string | null
agency_image
string | null
sold_listing_count
integer | null
live_listing_count
integer | null
is_partner
boolean | null
recently_sold
TrademeAgentSoldProperty · object[]