/trademe/agents/search

POST /api/trademe/agents/search

Price: 5 credits

Search TradeMe real-estate agents by location or by agent/agency name. Returns agent cards: name, agency, contact phones, photo, sold and live listing counts, partner status and recently sold properties.

How to use it

Search TradeMe (New Zealand) real-estate agents. Provide either location (e.g. 'auckland') or keyword (agent or agency name). Each result has alias (feed to trademe/agents for the full profile), first_name, last_name, agency_name, work_phone, mobile_phone, image, agency_image, sold_listing_count, live_listing_count, is_partner and recently_sold (recent sales with address, sale_price, sale_date). Sort by featured, sold_listings, first/last name ascending or descending.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• location string nullable — Location slug to find agents in (e.g. 'auckland', 'wellington'). (examples: "auckland")
• keyword string nullable — Agent name or agency name to search for. (examples: "barfoot", "Tina Gao")
• count integer required — Max number of results to return (min: 1)
• sort string — Result ordering. (default: "featured"; one of: "featured", "sold_listings", "first_name_asc", "first_name_desc", "last_name_asc", "last_name_desc")

Response

• @type string (default: "TrademeAgentCard")
• alias string required
• first_name string nullable
• last_name string nullable
• agency_name string nullable
• work_phone string nullable
• mobile_phone string nullable
• image string nullable
• agency_image string nullable
• sold_listing_count integer nullable
• live_listing_count integer nullable
• is_partner boolean nullable
• recently_sold array (default: [])
  • @type string (default: "TrademeAgentSoldProperty")
  • id integer required
  • address string nullable
  • sale_price integer nullable
  • sale_date string nullable
  • image string nullable
  • listing_id integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No agents matched the location or keyword Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.