/anjuke/new-homes/search

POST /api/anjuke/new-homes/search

Price: 20 credits

Search Anjuke new-home projects (xinfang loupan) in a Chinese city by district, bedrooms, property type, sales stage and decoration, with average price per square metre, sales status, layouts on offer, floor-area range, location and tags on each.

How to use it

List the new-build projects a city or district is selling, then pass an id with the same city to anjuke/new-homes for opening and delivery dates, developer, presale licence and layouts.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• city string required — City to search in, as named in the site's host (one of: "baoding", "baotou", "beijing", "bengbu", "cc", "chengdu", "chenzhou", "chongqing", "cs", "cz", "dalian", "dg", "foshan", "fz", "guangzhou", "gy", "haikou", "hangzhou", "heb", "hf", "huhehaote", "huizhou", "huzhou", "jinan", "jx", "km", "ks", "lanzhou", "liuzhou", "luoyang", "mianyang", "nanjing", "nanning", "nantong", "nanyang", "nb", "nc", "qd", "qinhuangdao", "quanzhou", "sanya", "shanghai", "shaoxing", "shenzhen", "sjz", "suzhou", "sy", "taicang", "tianjin", "ty", "weifang", "weihai", "wenzhou", "wuhan", "wulumuqi", "wuxi", "xa", "xm", "xuzhou", "yancheng", "yt", "zh", "zhengzhou", "zibo", "zs"; examples: "guangzhou")
• count integer required — Max number of new-home projects to return (min: 1; max: 1500)
• district string nullable — District alias as used in the city's new-home URLs (examples: "tianhe"; pattern: ^[a-z0-9]+$)
• rooms string nullable — Projects offering layouts with this many bedrooms (one of: "h1", "h2", "h3", "h4", "h5")
• property_type string nullable — Property type; villa is labelled low-density housing in some cities (one of: "w1", "w2", "w3", "w4", "w5")
• sale_status string nullable — Sales stage of the project (one of: "a1", "a2", "a4", "a6")
• decoration string nullable — Delivery finish of the units (one of: "z1", "z2", "z3")
• sort string — Result order (default: "default"; one of: "default", "s2", "s3")

Response

• @type string (default: "AnjukeNewHome")
• id string required
• url string required
• name string nullable
• alias string nullable
• sale_status string nullable
• property_type string nullable
• tags array (default: [])
• avg_price_per_sqm number nullable
• total_price_from number nullable
• nearby_avg_price_per_sqm number nullable
• previous_avg_price_per_sqm number nullable
• currency string (default: "CNY")
• room_counts array (default: [])
• area_min_sqm number nullable
• area_max_sqm number nullable
• district string nullable
• block string nullable
• address string nullable
• latitude number nullable
• longitude number nullable
• opening_date string nullable
• delivery_date string nullable
• developer string nullable
• presale_license string nullable
• presale_license_date string nullable
• features array (default: [])
• phone string nullable
• rankings array (default: [])
• layout_counts array (default: [])
  • @type string (default: "AnjukeNewHomeLayoutCount")
  • room_count integer required
  • layout_count integer required
• layouts array (default: [])
  • @type string (default: "AnjukeNewHomeLayout")
  • id string nullable
  • url string nullable
  • room_count integer nullable
  • hall_count integer nullable
  • bathroom_count integer nullable
  • area_sqm number nullable
  • price_from number nullable
  • price_to number nullable
  • currency string (default: "CNY")
  • sale_status string nullable
  • image string nullable
• site_plan_image string nullable
• buildings array (default: [])
  • @type string (default: "AnjukeNewHomeBuilding")
  • id string required
  • name string nullable
  • sale_status string nullable
  • opening_date string nullable
  • delivery_date string nullable
  • unit_count integer nullable
  • floor_count integer nullable
  • household_count integer nullable
  • building_type string nullable
• has_vr_tour boolean nullable
• vr_tour_url string nullable
• has_video boolean nullable
• image string 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 district alias does not exist in this city 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.