/trademe/properties

POST /api/trademe/properties

Price: 5 credits

Get full TradeMe property listing details by listing ID (or listing URL): address, price and sale method, bedrooms/bathrooms/parking, floor and land area, property type, council valuation, certificate of title, broadband availability, description, photo gallery, open-home times, in-zone local schools and the advertiser (private member and/or licensed real-estate agency with its agents).

How to use it

Fetch a single TradeMe (New Zealand) property listing by numeric listing ID or a listing URL. Returns one item with id, title, url, description, region/suburb/district, address, price_display and sale_method (asking_price/auction/tender/negotiation/deadline_sale) with sale_date, bedrooms/bathrooms/ensuites/toilets/garage_parking/off_street_parking, property_type, ownership_type, floor_area, land_area, decade_built, wall_material/roof_material, capital_value/land_value/improvement_value, certificate_of_title, legal_description, broadband, latitude/longitude, view_count, bidder_and_watcher_count, listed_at, image+images, broadband_technologies, attributes (full council/TradeMe attribute list), open_homes, recent_local_sales, schools (in-zone primary/intermediate/secondary with distance) and the advertiser: member (private seller with feedback) and agency (licensed real-estate agency with REAA details and agents).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• listing string required — TradeMe listing ID or a listing URL containing it (examples: "5995989628", "https://www.trademe.co.nz/a/property/residential/sale/.../listing/5995989628"; minLength: 1)

Response

• @type string (default: "TrademeListing")
• id integer required
• url string nullable
• description string nullable
• category_name string nullable
• region string nullable
• suburb string nullable
• price_display string nullable
• sale_method string nullable
• sale_date string nullable
• address string nullable
• district string nullable
• bedrooms integer nullable
• bathrooms integer nullable
• ensuites integer nullable
• toilets integer nullable
• garage_parking integer nullable
• off_street_parking integer nullable
• property_type string nullable
• ownership_type string nullable
• floor_area string nullable
• land_area string nullable
• decade_built string nullable
• wall_material string nullable
• roof_material string nullable
• capital_value string nullable
• land_value string nullable
• improvement_value string nullable
• certificate_of_title string nullable
• legal_description string nullable
• broadband string nullable
• latitude number nullable
• longitude number nullable
• view_count integer nullable
• bidder_and_watcher_count integer nullable
• listed_at string nullable
• image string nullable
• images array (default: [])
• broadband_technologies array (default: [])
  • @type string (default: "TrademeBroadbandTechnology")
  • name string required
  • availability string nullable
• attributes array (default: [])
  • @type string (default: "TrademeListingAttribute")
  • name string required
  • value string required
  • source string nullable
  • display_name string nullable
  • display_group string nullable
• open_homes array (default: [])
  • @type string (default: "TrademeOpenHome")
  • start_at string nullable
  • end_at string nullable
• recent_local_sales array (default: [])
  • @type string (default: "TrademeRecentSale")
  • address string required
  • sale_price integer nullable
• schools array (default: [])
  • @type string (default: "TrademeSchool")
  • id integer required
  • name string required
  • institution_type string nullable
  • authority string nullable
  • gender string nullable
  • school_roll integer nullable
  • age_groups array (default: [])
  • street_address string nullable
  • suburb string nullable
  • city_district string nullable
  • post_code string nullable
  • latitude number nullable
  • longitude number nullable
  • distance integer nullable
  • in_zone boolean nullable
• member object nullable
  • @type string (default: "TrademeMember")
  • id integer required
  • nickname string nullable
  • suburb string nullable
  • region string nullable
  • feedback_count integer nullable
  • unique_positive integer nullable
  • unique_negative integer nullable
  • is_address_verified boolean nullable
  • is_authenticated boolean nullable
  • is_in_trade boolean nullable
  • joined_at string nullable
• agency object nullable
  • @type string (default: "TrademeAgency")
  • id integer required
  • name string nullable
  • phone string nullable
  • image string nullable
  • is_real_estate_agency boolean nullable
  • is_licensed boolean nullable
  • agents array (default: [])
    • @type string (default: "TrademeAgencyAgent")
    • full_name string required
    • alias string nullable
    • image string nullable
    • mobile_phone string nullable
    • membership_type integer nullable
    • review_count integer nullable
    • testimonial_count 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 — Listing not found (well-formed but nonexistent, expired or removed listing) 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.