/beike/new-homes

POST /api/beike/new-homes

Price: 10 credits

Get one Beike new-home development by id or URL: sale status, property type, reference average and total price, district, block, address and coordinates, latest opening date, room types, floor-area range, the count of each layout on sale, tags and photos.

How to use it

Use to read one development found through beike/new-homes/search; pass its id with the same city.

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 the development is in, as named in the site's host (one of: "aq", "ay", "baoji", "baotou", "bd", "bh", "bijie", "bj", "byne", "bz", "cangzhou", "cc", "cd", "cf", "changde", "changshu", "changzhi", "changzhou", "chengde", "chenzhou", "cm", "cq", "cs", "dali", "danyang", "dazhou", "dd", "dezhou", "dg", "dl", "dt", "dy", "eeds", "ez", "fcg", "fs", "fushun", "fuzhou", "fy", "fz", "ganzhou", "gl", "guangyuan", "gy", "gz", "ha", "haian", "haimen", "hanzhong", "hd", "heze", "hf", "hg", "hhht", "hk", "hrb", "hs", "huangshi", "hui", "huzhou", "hy", "hz", "jdz", "jh", "jian", "jiangmen", "jingzhou", "jining", "jiujiang", "jl", "jn", "jr", "jx", "jy", "kf", "km", "ks", "la", "leshan", "lf", "liangshan", "linyi", "liuzhou", "ls", "luohe", "luoyang", "luzhou", "lvliang", "lx", "lyg", "lz", "mas", "mianyang", "ms", "nanchong", "nb", "nc", "neijiang", "nj", "nn", "nt", "ny", "pds", "pingxiang", "pt", "py", "pzh", "qd", "qhd", "qidong", "qingzhou", "qj", "quanzhou", "qy", "rg", "rz", "san", "sh", "shangqiu", "shouguang", "sjz", "sn", "sq", "sr", "su", "sx", "sy", "sz", "ta", "taizhou", "tianshui", "tj", "tongliao", "ts", "ty", "weihai", "wf", "wh", "wlmq", "wn", "wuhu", "wx", "wz", "xa", "xc", "xg", "xiangtan", "xiantao", "xianyang", "xining", "xinxiang", "xinyang", "xinzhou", "xm", "xsbn", "xt", "xx", "xy", "xz", "yaan", "yangjiang", "yb", "yc", "ych", "yibin", "yichang", "yinchuan", "yiyang", "yk", "yongzhou", "yt", "yulin", "yuncheng", "yw", "yy", "yz", "zb", "zh", "zhangzhou", "zhanjiang", "zhoushan", "zhucheng", "zhuozhou", "zhuzhou", "zj", "zjg", "zjk", "zk", "zmd", "zq", "zs", "zunyi", "zz"; examples: "tj")
• project string required — Development id as returned by the search, or the development URL (examples: "tdgtglhybybodaq", "https://tj.fang.ke.com/loupan/p_tdgtglhybybodaq/"; minLength: 1)

Response

• @type string (default: "BeikeNewHome")
• id string required
• url string required
• name string nullable
• resblock_id string nullable
• alternative_names array (default: [])
• status string nullable
• property_type string nullable
• city_id string nullable
• city string nullable
• district string nullable
• block string nullable
• address string nullable
• latitude number nullable
• longitude number nullable
• room_types array (default: [])
• area_min_sqm number nullable
• area_max_sqm number nullable
• avg_price_per_sqm number nullable
• price_label string nullable
• total_price_min number nullable
• total_price_max number nullable
• currency string (default: "CNY")
• opening_date_text string nullable
• layouts array (default: [])
  • @type string (default: "BeikeLayoutCount")
  • name string required
  • count integer required
• tags array (default: [])
• image string nullable
• images array (default: [])

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 — No new-home development with this id is published in this city on Beike 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.