/house591/rent_listings/search

POST /api/house591/rent_listings/search

Price: 5 credits

Search homes for rent on 591 in one Taiwanese city or county: by district, rental type (whole home, studio, shared suite, room, parking), building type, keyword, monthly rent, floor area, bedrooms and features. Each row carries rent, area, layout, floor, address, community, nearest transit, tags, photos and the poster's role.

How to use it

Get a listing's full terms, fees, facilities and contact with house591/rent_listings.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of listings to return (min: 1; max: 3000)
• region string required — City or county (one of: "taipei", "keelung", "new_taipei", "hsinchu_city", "hsinchu_county", "taoyuan", "miaoli", "taichung", "changhua", "nantou", "chiayi_city", "chiayi_county", "yunlin", "tainan", "kaohsiung", "pingtung", "yilan", "taitung", "hualien", "penghu", "kinmen", "lienchiang")
• district_ids array nullable — District ids within the region, as returned in district_id (examples: ["5","7"])
• kind string nullable — Type of rental (one of: "whole_home", "studio", "shared_suite", "room", "parking", "other")
• keyword string nullable — Words to find in listings (examples: "信義", "捷運"; minLength: 1)
• price_min number nullable — Minimum monthly rent, TWD (examples: 10000; min: 0)
• price_max number nullable — Maximum monthly rent, TWD (examples: 30000; min: 0)
• area_min number nullable — Minimum floor area, ping (examples: 10; min: 0)
• area_max number nullable — Maximum floor area, ping (examples: 40; min: 0)
• bedrooms integer nullable — Number of bedrooms (examples: 2; min: 1; max: 4)
• building_type string nullable — Type of building (one of: "apartment", "elevator_building", "townhouse", "villa")
• features array nullable — Features every listing must have (one of: "pets_allowed", "new_listing", "near_metro")
• sort string — Result order (default: "relevance"; one of: "relevance", "newest", "price_asc", "price_desc")

Response

• @type string (default: "House591RentListing")
• id string required
• url string nullable
• kind_code string nullable
• kind_name string nullable
• price number nullable
• price_unit string nullable
• price_includes string nullable
• extra_fee_note string nullable
• original_price number nullable
• price_drop_percent number nullable
• area_ping number nullable
• layout string nullable
• floor string nullable
• fitment string nullable
• address string nullable
• region_id string nullable
• district_id string nullable
• community_id string nullable
• community_name string nullable
• nearby_transit object nullable
  • @type string (default: "House591Transit")
  • kind string nullable
  • name string required
  • distance_m number nullable
• tags array (default: [])
• image string nullable
• images array (default: [])
• video object nullable
  • @type string (default: "House591Video")
  • id string nullable
  • url string required
  • image string nullable
• poster_role string nullable
• contact_name string nullable
• view_count integer nullable
• refreshed_text string nullable
• is_preferred boolean nullable
• is_social_housing boolean nullable

Errors

• 422 — Unknown region, kind, building type, feature or sort, a non-numeric district id, or an inverted range 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 — The entity was not found, or a precondition failed 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.