/zigbang/complexes/items

POST /api/zigbang/complexes/items

Price: 5 credits

List the for-sale, jeonse and monthly-rent listings of a Zigbang (직방) apartment complex: deal type, price, rent, unit type and size, building, floor, title and verification

How to use it

Complex ids come from zigbang/complexes/search. A source_listings id with source zigbang opens zigbang/items. One unit can be listed for several deal types. 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)
• deal_types array nullable — Deal types; any may match, all when omitted (one of: "sale", "jeonse", "monthly_rent")
• count integer required — Max number of listings to return (min: 1)

Response

• @type string (default: "ZigbangComplexListing")
• unit_id string required
• complex_id string nullable
• complex_name string nullable
• deal_type string nullable
• listing_kind string nullable
• deposit number nullable
• rent number nullable
• sale_price number nullable
• is_price_range boolean nullable
• room_type_id string nullable
• area_m2 number nullable
• contract_area_m2 number nullable
• area_label_m2 string nullable
• area_label_pyeong string nullable
• building_dong string nullable
• floor string nullable
• district string nullable
• neighborhood string nullable
• image string nullable
• is_verified boolean nullable
• favorite_count integer nullable
• listing_count integer nullable
• source_listings array (default: [])
  • @type string (default: "ZigbangSourceListing")
  • source string nullable
  • id 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.