/zigbang/complexes

POST /api/zigbang/complexes

Price: 5 credits

Get a Zigbang (직방) apartment complex by id or URL: address, households, buildings, floors, approval date, parking, heating, facilities, builder, photos, resident reviews and score, local rank, price ranges, monthly price-per-pyeong history, VR tours and related complexes

How to use it

Complex ids come from zigbang/complexes/search and zigbang/places/search with scope apartment. Listings are in zigbang/complexes/items, deals in zigbang/complexes/transactions. Money is in KRW.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• complex string required — Zigbang apartment complex id or complex URL (examples: "2978", "https://www.zigbang.com/home/apt/danjis/2978"; minLength: 1)

Response

• @type string (default: "ZigbangComplex")
• id string required
• url string required
• name string nullable
• property_type string nullable
• stage string nullable
• tagline string nullable
• description string nullable
• location_description string nullable
• address string nullable
• road_address string nullable
• jibun_address string nullable
• city string nullable
• district string nullable
• neighborhood string nullable
• district_code string nullable
• neighborhood_code string nullable
• legal_dong_code string nullable
• latitude number nullable
• longitude number nullable
• use_approval_date integer nullable
• sale_month string nullable
• household_count integer nullable
• sale_household_count integer nullable
• building_count integer nullable
• floors_max integer nullable
• floors_min integer nullable
• parking_spaces integer nullable
• parking_per_household number nullable
• parking_location string nullable
• heating_type string nullable
• heating_fuel string nullable
• facilities array (default: [])
• floor_area_ratio number nullable
• building_coverage_ratio number nullable
• constructor string nullable
• builder string nullable
• developer string nullable
• management_office_phone string nullable
• has_seismic_design boolean nullable
• is_post_completion_sale boolean nullable
• brand string nullable
• image string nullable
• photos array (default: [])
  • @type string (default: "ZigbangComplexPhoto")
  • text string nullable
  • image string nullable
• features array (default: [])
• review_score number nullable
• review_count integer nullable
• reviews array (default: [])
  • @type string (default: "ZigbangComplexReview")
  • score number nullable
  • text string nullable
  • residence_period string nullable
• district_rank integer nullable
• district_rank_total integer nullable
• neighborhood_rank integer nullable
• neighborhood_rank_total integer nullable
• regulation_area string nullable
• listing_count integer nullable
• price_ranges array (default: [])
  • @type string (default: "ZigbangPriceRange")
  • deal_type string nullable
  • price_min number nullable
  • price_max number nullable
  • area_type_count integer nullable
• sale_price_per_pyeong_history array (default: [])
  • @type string (default: "ZigbangPricePoint")
  • month_date integer nullable
  • price_per_pyeong number nullable
• vr_tours array (default: [])
  • @type string (default: "ZigbangVrTour")
  • room_type_id string nullable
  • area_m2 number nullable
  • supply_area_m2 number nullable
  • room_count integer nullable
  • bathroom_count integer nullable
  • entrance_type string nullable
  • building_dong string nullable
  • household_count integer nullable
  • url string nullable
  • image string nullable
  • created_at integer nullable
• related_complexes array (default: [])
  • @type string (default: "ZigbangRelatedComplex")
  • id string nullable
  • name string nullable
  • age string nullable
  • households string nullable
  • district string nullable
  • neighborhood string nullable
  • latitude number nullable
  • longitude number nullable
  • listing_count integer nullable
  • image string nullable

Errors

• 422 — The request body did not validate 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 — Zigbang has no apartment complex 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.