/house591/rent_listings

POST /api/house591/rent_listings

Price: 1 credit

Get one home rental on 591: rent, deposit and the full cost breakdown (utilities, management fee, parking, move-in cost), type, building type, floor, area, rental terms, facilities present and absent, the owner's description, location with nearby transit, schools and shops, and the poster's contact details

How to use it

Find ids with house591/rent_listings/search. Shop, office and factory rentals are served by house591/business_listings.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — Rental listing id or URL (examples: "22086411", "https://rent.591.com.tw/22086411")

Response

• @type string (default: "House591RentListingDetail")
• id string required
• url string required
• status string nullable
• kind_code string nullable
• kind_name string nullable
• building_type string nullable
• price number nullable
• price_unit string nullable
• deposit string nullable
• region_id string nullable
• region_name string nullable
• district_id string nullable
• district_name string nullable
• address string nullable
• latitude number nullable
• longitude number nullable
• community_id string nullable
• community_name string nullable
• area_ping number nullable
• floor string nullable
• tags array (default: [])
• attributes array (default: [])
  • @type string (default: "House591Attribute")
  • key string nullable
  • label string required
  • value string required
• rental_terms array (default: [])
  • @type string (default: "House591Attribute")
  • key string nullable
  • label string required
  • value string required
• cost_items array (default: [])
  • @type string (default: "House591Attribute")
  • key string nullable
  • label string required
  • value string required
• costs object nullable
  • @type string (default: "House591RentCosts")
  • rent number nullable
  • deposit string nullable
  • service_fee string nullable
  • parking_fee number nullable
  • parking_note string nullable
  • water_fee number nullable
  • water_fee_note string nullable
  • electricity_fee number nullable
  • electricity_fee_note string nullable
  • management_fee number nullable
  • management_fee_note string nullable
  • rent_includes string nullable
  • move_in_cost number nullable
  • move_in_cost_note string nullable
• facilities array (default: [])
• missing_facilities array (default: [])
• highlights array (default: [])
• description string nullable
• nearby array (default: [])
  • @type string (default: "House591Place")
  • category string nullable
  • kind string nullable
  • name string required
  • distance_m number nullable
  • latitude number nullable
  • longitude number nullable
• contact object nullable
  • @type string (default: "House591RentContact")
  • user_id string nullable
  • name string nullable
  • role string nullable
  • agency string nullable
  • certificate string nullable
  • mobile string nullable
  • phone string nullable
  • line_url string nullable
  • image string nullable
  • service_fee string nullable
  • labels array (default: [])
• image string nullable
• view_count integer nullable
• posted_at integer nullable
• published_text string nullable
• expires_date integer nullable

Errors

• 422 — id is not a 591 listing id or URL 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 home rental under that id 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.