/house591/communities

POST /api/house591/communities

Price: 5 credits

Get one residential community on 591: building facts (age, households, floors, structure, developer, builder, architect, licences, parking, management fee, nearby schools and transport), location, ratings for transport, business, education and planning against the district average, registered price summary (latest, lowest, highest, yearly average per ping), prices by bedroom count, floor plans with area, direction and asking price, site-plan images, photos, nearby places and nearby communities

How to use it

Find ids with house591/communities/search; every registered sale is in house591/communities/transactions.

Parameters

• access-token string required

Request body

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

Response

• @type string (default: "House591CommunityDetail")
• id string required
• url string required
• name string nullable
• community_type string nullable
• housing_type string nullable
• purpose string nullable
• address string nullable
• region_id string nullable
• region_name string nullable
• district_id string nullable
• district_name string nullable
• business_district string nullable
• nearest_station string nullable
• latitude number nullable
• longitude number nullable
• new_project_id string nullable
• sale_count integer nullable
• rent_count integer nullable
• scores object nullable
  • @type string (default: "House591CommunityScores")
  • total number nullable
  • transport number nullable
  • business number nullable
  • education number nullable
  • living number nullable
  • community_planning number nullable
  • layout_planning number nullable
• district_average_scores object nullable
  • @type string (default: "House591CommunityScores")
  • total number nullable
  • transport number nullable
  • business number nullable
  • education number nullable
  • living number nullable
  • community_planning number nullable
  • layout_planning number nullable
• district_rank integer nullable
• district_rank_total integer nullable
• district_rank_label string nullable
• review_url string nullable
• advantages array (default: [])
• disadvantages array (default: [])
• building object nullable
  • @type string (default: "House591CommunityBuild")
  • age_years number nullable
  • household_count integer nullable
  • parking_count integer nullable
  • price_per_ping_text string nullable
  • parking_price_text string nullable
  • management_fee string nullable
  • service_phone string nullable
  • layouts array (default: [])
  • facilities array (default: [])
  • sell_status string nullable
  • completion string nullable
  • handover string nullable
  • public_area_ratio string nullable
  • building_coverage_ratio string nullable
  • purpose string nullable
  • secondary_purpose string nullable
  • structure string nullable
  • floors string nullable
  • buildings string nullable
  • base_area string nullable
  • land_zoning string nullable
  • parking string nullable
  • parking_ratio string nullable
  • orientation string nullable
  • fit_out string nullable
  • down_payment string nullable
  • loan_ratio string nullable
  • management_committee string nullable
  • property_manager string nullable
  • sales_agency string nullable
  • developer string nullable
  • builder string nullable
  • architect string nullable
  • landscape_designer string nullable
  • building_license string nullable
  • use_license string nullable
  • ev_charging string nullable
  • materials string nullable
  • remarks string nullable
  • schools string nullable
  • supermarkets string nullable
  • markets string nullable
  • parks string nullable
  • shopping_areas string nullable
  • hospitals string nullable
  • metro string nullable
  • freeways string nullable
  • expressways string nullable
  • rail string nullable
  • other_transport string nullable
  • sales_office_address string nullable
  • government string nullable
  • nearby_other string nullable
  • high_speed_rail string nullable
  • parking_types string nullable
  • interior_designer string nullable
  • lighting_designer string nullable
  • project_payment string nullable
  • refuse_disposal string nullable
  • latest_update_text string nullable
  • latest_update_date integer nullable
• prices object nullable
  • @type string (default: "House591CommunityPriceSummary")
  • transaction_count integer nullable
  • latest_price_per_ping number nullable
  • lowest_price_per_ping number nullable
  • highest_price_per_ping number nullable
  • yearly_average_price_per_ping number nullable
  • updated_text string nullable
• room_prices array (default: [])
  • @type string (default: "House591CommunityRoomPrices")
  • name string required
  • transaction_count integer nullable
  • sale_count integer nullable
  • rent_count integer nullable
  • average_price_per_ping number nullable
  • average_price_period string nullable
  • asking_price_per_ping_text string nullable
• layouts array (default: [])
  • @type string (default: "House591CommunityLayout")
  • name string required
  • bedrooms integer nullable
  • area_ping number nullable
  • image string nullable
• listed_layouts array (default: [])
  • @type string (default: "House591CommunityListedLayout")
  • name string required
  • bedrooms integer nullable
  • area_ping number nullable
  • direction string nullable
  • sale_count integer nullable
  • asking_price_text string nullable
  • image string nullable
• site_plan_images array (default: [])
• hot_rank integer nullable
• hot_rank_label string nullable
• images array (default: [])
• 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
• nearby_communities array (default: [])
  • @type string (default: "House591NearbyCommunity")
  • id string required
  • name string nullable
  • distance_m number nullable
  • age_text string nullable
  • purpose string nullable
  • average_price_per_ping number nullable
  • image string nullable
• tags array (default: [])

Errors

• 422 — id is not a 591 community 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 community 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.