/trademe/agents

POST /api/trademe/agents

Price: 5 credits

Get a full TradeMe real-estate agent profile by slug (or agent URL): name, agency, contact details, REAA license number, biography, career description, experience, spoken languages, service suburbs and districts, awards, client testimonials, web links, sold and live listing counts and the agent's current property listings.

How to use it

Fetch a single TradeMe (New Zealand) real-estate agent by profile slug or agent URL. Returns one item with id, alias, first_name, last_name, url, email, work_phone, mobile_phone, reaa_license_number, image, biography, career_description, agency_name, agency_image, experience_years/months, sold_listing_count, live_listing_count, is_partner, joined_at, spoken_languages, suburbs and districts (serviced areas), awards, testimonials (client reviews with text, full_name and created_at), web_links (website/social) and listings (the agent's current property listings with id, address, price and property type).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• agent string required — TradeMe agent profile slug or agent profile URL (examples: "Tina-Gao", "https://www.trademe.co.nz/a/property/agent/Tina-Gao"; minLength: 1)

Response

• @type string (default: "TrademeAgent")
• id integer required
• alias string required
• first_name string nullable
• last_name string nullable
• url string nullable
• email string nullable
• work_phone string nullable
• mobile_phone string nullable
• reaa_license_number string nullable
• image string nullable
• biography string nullable
• career_description string nullable
• agency_name string nullable
• agency_image string nullable
• experience_years integer nullable
• experience_months integer nullable
• sold_listing_count integer nullable
• live_listing_count integer nullable
• is_partner boolean nullable
• joined_at string nullable
• spoken_languages array (default: [])
• suburbs array (default: [])
  • @type string (default: "TrademeAgentSuburb")
  • id integer required
  • name string nullable
  • district_id integer nullable
  • region_id integer nullable
• districts array (default: [])
  • @type string (default: "TrademeAgentDistrict")
  • id integer required
  • name string nullable
  • region_id integer nullable
• awards array (default: [])
• testimonials array (default: [])
  • @type string (default: "TrademeAgentTestimonial")
  • id integer required
  • text string required
  • full_name string nullable
  • created_at string nullable
• web_links array (default: [])
  • @type string (default: "TrademeAgentWebLink")
  • type string nullable
  • url string required
• listings array (default: [])
  • @type string (default: "TrademeAgentListing")
  • id integer required
  • url string nullable
  • category_name string nullable
  • region string nullable
  • district string nullable
  • suburb string nullable
  • price_display string nullable
  • property_type string nullable
  • bedrooms integer nullable
  • bathrooms integer nullable
  • image string nullable
  • listed_at string 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 — Agent not found (well-formed but nonexistent or removed profile) 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.