/anjuke/communities/search

POST /api/anjuke/communities/search

Price: 20 credits

Search Anjuke residential communities (xiaoqu) in a Chinese city by district, average price band and building age, with location, build year, listed average price, listing counts and ratings on each.

How to use it

List the residential compounds of a city or district, then pass an id with the same city to anjuke/communities for developer, fees, ratios and price history.

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 communities to return (min: 1; max: 1250)
• district string nullable — District alias as used in the city's listing URLs (examples: "tianhe"; pattern: ^[a-z0-9]+$)
• avg_price string nullable — Band of the listed average price per square metre, in yuan (one of: "m260", "m261", "m262", "m263", "m264", "m265", "m266")
• building_age string nullable — Age of the community's buildings (one of: "f1", "f2", "f3", "f4", "f5", "f6")
• sort string — Result order (default: "default"; one of: "default", "o1", "o2", "o3", "o4", "o10", "o9")

Response

• @type string (default: "AnjukeCommunity")
• id string required
• url string required
• name string nullable
• alternative_names array (default: [])
• city_id string nullable
• city string nullable
• district string nullable
• district_id string nullable
• block string nullable
• block_id string nullable
• address string nullable
• latitude number nullable
• longitude number nullable
• image string nullable
• building_type string nullable
• ownership_type string nullable
• property_types array (default: [])
• built_year integer nullable
• land_use_term string nullable
• developer string nullable
• property_management_company string nullable
• property_management_brand string nullable
• property_management_features string nullable
• property_fee string nullable
• total_area_sqm number nullable
• plot_ratio number nullable
• greening_ratio_pct number nullable
• household_count integer nullable
• parking string nullable
• parking_fee string nullable
• water_power_supply string nullable
• has_elevator boolean nullable
• has_nearby_metro boolean nullable
• has_nearby_school boolean nullable
• has_panorama boolean nullable
• description string nullable
• merits string nullable
• demerits string nullable
• evaluation string nullable
• evaluation_summary string nullable
• tags array (default: [])
• metro array (default: [])
• school string nullable
• photo_count integer nullable
• video_count integer nullable
• panorama_count integer nullable
• avg_price_per_sqm number nullable
• price_change_month_pct number nullable
• market_sentiment string nullable
• sale_listing_count integer nullable
• rent_listing_count integer nullable
• new_home_count integer nullable
• rating number nullable
• rating_highlights array (default: [])
  • @type string (default: "AnjukeRatingItem")
  • name string required
  • score number nullable
  • note string nullable
• rating_breakdown array (default: [])
  • @type string (default: "AnjukeRatingItem")
  • name string required
  • score number nullable
  • note string nullable
• price_history array (default: [])
  • @type string (default: "AnjukePricePoint")
  • month string required
  • price_per_sqm number 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.