/zigbang/places/search

POST /api/zigbang/places/search

Price: 5 credits

Look up places on Zigbang (직방) by name — neighbourhoods, subway stations, schools, universities and apartment complexes: one row per place with type, coordinates, address and the legal-dong code

How to use it

Feed latitude and longitude into zigbang/items/search or zigbang/complexes/search. With scope apartment, an apartment row's id opens zigbang/complexes.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Place name: neighbourhood, station, school or complex (examples: "역삼동"; minLength: 1)
• scope string — Listing category the lookup serves (default: "one_room"; one of: "one_room", "villa", "officetel", "apartment")
• count integer required — Max number of places to return (min: 1)

Response

• @type string (default: "ZigbangPlace")
• id string required
• kind string required
• name string nullable
• hint string nullable
• description string nullable
• latitude number nullable
• longitude number nullable
• city string nullable
• district string nullable
• neighborhood string nullable
• address string nullable
• road_address string nullable
• legal_dong_code string nullable
• parcel_number string nullable
• stage string nullable
• household_count integer nullable
• floors_max integer nullable
• use_approval_date integer nullable
• school_code string nullable
• school_level string nullable
• school_gender string nullable
• school_ownership string nullable
• founded_date integer 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 — 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.