/anjuke/rental-listings

POST /api/anjuke/rental-listings

Price: 20 credits

Get one Anjuke rental listing by id or URL: monthly rent, payment terms and fees, layout, area, floor, decoration, amenities, the community with its district, coordinates, photos, the listing text and the agent.

How to use it

Use to read a rental listing whose id or URL you already have; the community_id it returns works with anjuke/communities in 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 rental is published 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")
• listing string required — Rental listing id or rental listing URL (examples: "4728280416445444", "https://gz.zu.anjuke.com/fangyuan/4728280416445444"; minLength: 1)

Response

• @type string (default: "AnjukeRentalListing")
• id string required
• url string required
• price number nullable
• currency string (default: "CNY")
• payment_terms string nullable
• agent_fee string nullable
• service_fee string nullable
• rent_type string nullable
• room_count integer nullable
• hall_count integer nullable
• bathroom_count integer nullable
• area_sqm number nullable
• orientation string nullable
• floor string nullable
• decoration string nullable
• property_type string nullable
• community_id string nullable
• community_name string nullable
• district string nullable
• block string nullable
• address string nullable
• latitude number nullable
• longitude number nullable
• amenities array (default: [])
• tags array (default: [])
• text string nullable
• image string nullable
• images array (default: [])
• broker_name string nullable
• updated_date 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 — No rental listing with this id is published on Anjuke 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.