/house591/communities/search

POST /api/house591/communities/search

Price: 10 credits

Search residential communities (buildings and estates) on 591 in one Taiwanese city or county, by district or by name. Each row carries the average registered transaction price per ping, transaction, sale and rental counts, households, building purpose, nearest station, location and tags.

How to use it

Get a community's building facts, scores and price trend with house591/communities, and its registered sales with house591/communities/transactions.

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 communities to return (min: 1; max: 5000)
• 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 (examples: ["5"])
• keyword string nullable — Community name or address words (examples: "信義"; minLength: 1)

Response

• @type string (default: "House591Community")
• id string required
• url string required
• name string nullable
• district_name string nullable
• address string nullable
• latitude number nullable
• longitude number nullable
• purpose string nullable
• housing_type string nullable
• household_count integer nullable
• nearest_station string nullable
• business_district string nullable
• average_price_per_ping number nullable
• price_label string nullable
• transaction_count integer nullable
• sale_count integer nullable
• rent_count integer nullable
• view_count integer nullable
• review_score number nullable
• review_summary string nullable
• new_project_id string nullable
• tags array (default: [])
• image string nullable

Errors

• 422 — Unknown region or a non-numeric district id 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.