/daangn/realty/search

POST /api/daangn/realty/search

Price: 5 credits

List Daangn (당근) real-estate listings around a neighbourhood: one row per property with type, deal type, deposit, monthly rent or sale price, area, floor, photos, nearby subway stations and whether a broker or the owner posted it

How to use it

Take region_id from daangn/regions/search. Pass a returned id to daangn/realty for the description, maintenance fee and broker. Money is in KRW. property_types and trade_types narrow the feed; floor is empty when the listing only states a floor_band (LOW, MIDDLE or HIGH).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• region_id integer required — Daangn neighbourhood (dong) id (examples: 6035; min: 1)
• property_types array nullable — Property types; any may match. one_room covers open and split one-room units (one of: "APART", "OFFICETEL", "ONE_ROOM", "TWO_ROOM", "HOUSE", "OFFICE", "STORE", "BUILDING", "LAND", "FACTORY", "ETC")
• trade_types array nullable — Deal types: sale, jeonse (deposit only), monthly rent or short term; any may match (one of: "BUY", "BORROW", "MONTH", "SHORT")
• count integer required — Max number of property listings to return (min: 1; max: 200)

Response

• @type string (default: "DaangnRealtyCard")
• id string required
• node_id string nullable
• property_type string nullable
• status string nullable
• headline string nullable
• building_name string nullable
• area_m2 number nullable
• supply_area_m2 number nullable
• floor string nullable
• top_floor string nullable
• floor_band string nullable
• is_entire_building boolean nullable
• complex_name string nullable
• complex_type string nullable
• complex_approval_date integer nullable
• verification object nullable
  • @type string (default: "DaangnVerification")
  • lessor string nullable
  • lessor_is_corporation boolean nullable
  • tenant string nullable
  • corporation string nullable
  • corporation_role string nullable
  • resident string nullable
  • is_writer_resident boolean nullable
• trades array (default: [])
  • @type string (default: "DaangnRealtyTrade")
  • trade_type string nullable
  • deposit number nullable
  • monthly_rent number nullable
  • price number nullable
  • is_preferred boolean nullable
  • description string nullable
• images array (default: [])
• video_thumbnail string nullable
• latitude number nullable
• longitude number nullable
• neighborhood string nullable
• district string nullable
• subway_stations array (default: [])
  • @type string (default: "DaangnSubwayStation")
  • name string nullable
  • lines array (default: [])
  • walk_minutes integer nullable
• writer_type string nullable
• writer_sub_type string nullable
• writer_id string nullable
• writer_name string nullable
• broker_badges array (default: [])
• watch_count 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.