/zigbang/complexes/search

POST /api/zigbang/complexes/search

Price: 20 credits

Search Zigbang (직방) apartment complexes within a radius of a point, nearest first, with household, age and unit size filters: one row per complex with stage, households, approval date, location, distance and sale and offer price statistics

How to use it

Take the centre from zigbang/places/search. Pass a returned id to zigbang/complexes for the full record. 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)
• latitude number required — Latitude of the search centre (min: 33; max: 39)
• longitude number required — Longitude of the search centre (min: 124; max: 132)
• radius_km number — Search radius around the centre, km (default: 1; examples: 1; max: 5; >: 0)
• household_min integer nullable — Minimum number of households (one of: 200, 500, 1000, 2000)
• built_within_years integer nullable — Maximum complex age, years (one of: 5, 10, 15, 20, 25)
• size_band_min string — Smallest unit size band, pyeong (default: "under_10_pyeong"; one of: "under_10_pyeong", "pyeong_10s", "pyeong_20s", "pyeong_30s", "pyeong_40s", "pyeong_50s", "pyeong_60_plus")
• size_band_max string — Largest unit size band, pyeong (default: "pyeong_60_plus"; one of: "under_10_pyeong", "pyeong_10s", "pyeong_20s", "pyeong_30s", "pyeong_40s", "pyeong_50s", "pyeong_60_plus")
• count integer required — Max number of complexes to return (min: 1)

Response

• @type string (default: "ZigbangComplexCard")
• id string required
• url string required
• name string nullable
• property_type string nullable
• stage string nullable
• city string nullable
• district string nullable
• neighborhood string nullable
• latitude number nullable
• longitude number nullable
• distance_km number nullable
• household_count integer nullable
• use_approval_date integer nullable
• is_post_completion_sale boolean nullable
• image string nullable
• sale_prices object nullable
  • @type string (default: "ZigbangPriceStats")
  • price_min number nullable
  • price_max number nullable
  • price_avg number nullable
  • price_per_pyeong number nullable
• offer_prices object nullable
  • @type string (default: "ZigbangPriceStats")
  • price_min number nullable
  • price_max number nullable
  • price_avg number nullable
  • price_per_pyeong number 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 rejected the filter combination 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.