# /zigbang/items/search

`POST /api/zigbang/items/search`

Price: 20 credits

Search Zigbang (직방) one-room, villa or officetel listings within a radius of a point, nearest first, with deal type, deposit, rent, sale price, maintenance fee, room type, size, floor, bathroom, option and amenity filters: one row per listing with price, size, floor, location, distance and posting time

## How to use it

Take the centre from zigbang/places/search. Pass a returned id to zigbang/items for the full listing and its broker. 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)
- `property_type` (string, required) — Listing category (one of: "one_room", "villa", "officetel")
- `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)
- `deal_types` (array, nullable) — Deal types; any may match (one of: "monthly_rent", "jeonse", "sale", "short_term")
- `deposit_min` (integer, nullable) — Minimum deposit, KRW (min: 0)
- `deposit_max` (integer, nullable) — Maximum deposit, KRW (min: 0)
- `rent_min` (integer, nullable) — Minimum monthly rent, KRW (min: 0)
- `rent_max` (integer, nullable) — Maximum monthly rent, KRW (min: 0)
- `sale_price_min` (integer, nullable) — Minimum sale price, KRW (min: 0)
- `sale_price_max` (integer, nullable) — Maximum sale price, KRW (min: 0)
- `maintenance_fee_max` (integer, nullable) — Maximum monthly maintenance fee, KRW (min: 0)
- `no_maintenance_fee` (boolean) — Only listings without a maintenance fee (default: false)
- `room_types` (array, nullable) — Room layouts; any may match (one of: "open_studio", "separated_studio", "duplex_studio", "two_rooms", "three_rooms_plus", "four_rooms_plus")
- `area_min_m2` (integer, nullable) — Minimum exclusive area, m² (min: 0)
- `area_max_m2` (integer, nullable) — Maximum exclusive area, m² (min: 0)
- `floors` (array, nullable) — Floor kinds; any may match (one of: "semi_basement", "first", "above_ground", "rooftop")
- `bathroom_count` (integer, nullable) — Bathroom count; 3 means three or more (min: 1; max: 3)
- `options` (array, nullable) — Built-in options; all must match (one of: "air_conditioner", "refrigerator", "washing_machine", "gas_stove", "induction", "microwave", "desk", "bookshelf", "bed", "wardrobe", "shoe_cabinet", "sink")
- `immediate_move_in` (boolean) — Only listings available for immediate move-in (default: false)
- `south_facing` (boolean) — Only south-facing listings (default: false)
- `has_elevator` (boolean) — Only listings with an elevator (default: false)
- `has_parking` (boolean) — Only listings with parking (default: false)
- `has_cctv` (boolean) — Only listings with CCTV (default: false)
- `pets_allowed` (boolean) — Only listings that allow pets (default: false)
- `jeonse_loan_available` (boolean) — Only listings eligible for a jeonse loan (default: false)
- `has_ev_charging` (boolean) — Only listings with EV charging (default: false)
- `count` (integer, required) — Max number of listings to return (min: 1; max: 2500)

## Response

### 200 — Successful Response

- `@type` (string) (default: "ZigbangItemCard")
- `id` (string, required)
- `url` (string, required)
- `property_type` (string, nullable)
- `deal_type` (string, nullable)
- `deposit` (number, nullable)
- `rent` (number, nullable)
- `sale_price` (number, nullable)
- `maintenance_fee` (number, nullable)
- `is_short_term` (boolean, nullable)
- `contract` (string, nullable)
- `area_m2` (number, nullable)
- `supply_area_m2` (number, nullable)
- `contract_area_m2` (number, nullable)
- `room_type_code` (string, nullable)
- `floor` (string, nullable)
- `floors_total` (integer, nullable)
- `image` (string, nullable)
- `latitude` (number, nullable)
- `longitude` (number, nullable)
- `distance_km` (number, nullable)
- `address` (string, nullable)
- `city` (string, nullable)
- `district` (string, nullable)
- `neighborhood` (string, nullable)
- `move_in_date` (integer, nullable)
- `listing_type` (string, nullable)
- `is_new` (boolean, nullable)
- `favorite_count` (integer, nullable)
- `tags` (array) (default: [])
- `badges` (array) (default: [])
- `registered_at` (integer, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: 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

What to do: 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

What to do: 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

What to do: 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

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these 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.