/zigbang/items

POST /api/zigbang/items

Price: 1 credit

Get a Zigbang (직방) one-room, villa or officetel listing by id or URL: deal type, deposit, rent or sale price, maintenance fee and what it covers, size, room type, floor, facing, options, parking, move-in, address, nearby stations and places, photos and the listing broker

How to use it

Listing ids come from zigbang/items/search and zigbang/complexes/items. 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)
• item string required — Zigbang listing id or listing URL (examples: "50499184", "https://www.zigbang.com/home/oneroom/items/50499184"; minLength: 1)

Response

• @type string (default: "ZigbangItem")
• id string required
• url string required
• property_type string nullable
• deal_type string nullable
• status string nullable
• description string nullable
• deposit number nullable
• rent number nullable
• sale_price number nullable
• maintenance_fee number nullable
• maintenance_fee_type string nullable
• maintenance_includes array (default: [])
• maintenance_excludes array (default: [])
• area_m2 number nullable
• contract_area_m2 number nullable
• land_share_area_m2 number nullable
• room_type string nullable
• floor string nullable
• floors_total integer nullable
• bathroom_count integer nullable
• direction string nullable
• direction_basis string nullable
• has_elevator boolean nullable
• parking string nullable
• parking_spaces string nullable
• move_in string nullable
• residence_type string nullable
• use_approval_date integer nullable
• options array (default: [])
• image string nullable
• images array (default: [])
• latitude number nullable
• longitude number nullable
• address string nullable
• city string nullable
• district string nullable
• neighborhood string nullable
• jibun_address string nullable
• legal_dong_code string nullable
• parcel_number string nullable
• building_id string nullable
• building_dong string nullable
• listing_type string nullable
• is_premium boolean nullable
• is_non_compliant_building boolean nullable
• tags array (default: [])
• badges array (default: [])
• subways array (default: [])
  • @type string (default: "ZigbangSubway")
  • id string nullable
  • name string nullable
  • lines string nullable
• nearby_places array (default: [])
  • @type string (default: "ZigbangNearbyPlace")
  • kind string nullable
  • distance_m integer nullable
  • travel_seconds integer nullable
  • travel_mode string nullable
• amenities array (default: [])
• delivery_services array (default: [])
  • @type string (default: "ZigbangDeliveryService")
  • company string nullable
  • services array (default: [])
• complex object nullable
  • @type string (default: "ZigbangItemComplex")
  • id string nullable
  • name string nullable
  • stage string nullable
  • household_count integer nullable
  • use_approval_date integer nullable
  • city string nullable
  • district string nullable
  • neighborhood string nullable
  • latitude number nullable
  • longitude number nullable
  • image string nullable
• agent object nullable
  • @type string (default: "ZigbangAgent")
  • id string nullable
  • name string nullable
  • office_name string nullable
  • office_address string nullable
  • office_phone string nullable
  • phone string nullable
  • office_registration_number string nullable
  • business_registration_number string nullable
  • office_latitude number nullable
  • office_longitude number nullable
  • intro string nullable
  • image string nullable
  • status string nullable
  • languages array (default: [])
  • listing_counts object (default: {})
    • * integer
  • stats object nullable
    • @type string (default: "ZigbangAgentStats")
    • inquiry_count integer nullable
    • inquiry_answer_count integer nullable
    • inquiry_answer_rate number nullable
    • inquiry_answer_seconds_avg integer nullable
    • feedback_count integer nullable
    • thumbs_up_rate number nullable
    • positive_reasons object (default: {})
      • * integer
    • chat_response_rate number nullable
    • chat_response_minutes integer nullable
    • labels array (default: [])
• updated_at integer nullable
• verified_at 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 — Zigbang has no listing 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.