/house591/business_listings/search

POST /api/house591/business_listings/search

Price: 5 credits

Search shops, offices, residential offices, factories and land for rent or for sale on 591 in one Taiwanese city or county: by district, keyword and price. Each row carries price, price per ping, area, floor, fit-out, address, business district, nearest transit, tags, photos and the poster's role.

How to use it

Get a row's full record with house591/business_listings, passing its id and deal_type.

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)
• deal_type string required — For rent or for sale (one of: "rent", "sale")
• property_type string required — Kind of property (one of: "shop", "office", "residential_office", "factory", "land")
• 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"])
• keyword string nullable — Words to find in listings (examples: "忠孝"; minLength: 1)
• price_min number nullable — Minimum price, TWD (monthly for rentals) (examples: 50000; min: 0)
• price_max number nullable — Maximum price, TWD (monthly for rentals) (examples: 100000; min: 0)

Response

• @type string (default: "House591BusinessListing")
• id string required
• url string required
• deal_type string nullable (one of: "rent", "sale")
• kind_code string nullable
• kind_name string nullable
• price number nullable
• price_unit string nullable
• unit_price number nullable
• area_ping number nullable
• floor string nullable
• total_floors integer nullable
• layout string nullable
• fitment string nullable
• address string nullable
• street string nullable
• region_id string nullable
• region_name string nullable
• district_id string nullable
• district_name string nullable
• community_id string nullable
• community_name string nullable
• business_district string nullable
• road_width_m number 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: [])
• image_count integer nullable
• video object nullable
  • @type string (default: "House591Video")
  • id string nullable
  • url string required
  • image string nullable
• contact_name string nullable
• poster_role string nullable
• view_count integer nullable
• posted_text string nullable
• updated_at integer nullable
• refreshed_at integer nullable

Errors

• 422 — Unknown deal type, property type or region, 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.