/anjuke/sale-listings/search

POST /api/anjuke/sale-listings/search

Price: 20 credits

Search Anjuke resale (second-hand) home listings in a Chinese city by district, bedrooms, decoration, residence type, building age, orientation and floor level, with price, unit price, layout, area, holding period and the community on each listing.

How to use it

Shortlist resale homes in one city, then pass an id with the same city to anjuke/sale-listings for the full record. One call returns at most 1,500 listings, so split a broad city search by district to cover more.

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 listings to return (min: 1; max: 1500)
• district string nullable — District alias as used in the city's listing URLs (examples: "tianhe"; pattern: ^[a-z0-9]+$)
• rooms string nullable — Number of bedrooms (one of: "一室", "二室", "三室", "四室", "五室", "五室以上")
• decoration string nullable — Decoration state (one of: "毛坯", "普通装修", "精装修", "豪华装修")
• use_type string nullable — Type of residence (one of: "公寓", "普通住宅", "别墅", "平房", "其它")
• building_age string nullable — Age of the building (one of: "y1", "y2", "y3", "y4")
• orientation string nullable — Direction the home faces (one of: "l1", "l2", "l3", "l4", "l9", "l10", "l5", "l7", "l6", "l8")
• floor_level string nullable — Floor position within the building (one of: "fl1", "fl2", "fl3", "fl4", "fl5")
• sort string — Result order (default: "o1"; one of: "o1", "o4", "o5", "o2")

Response

• @type string (default: "AnjukeSaleListing")
• id string required
• url string required
• city_id string nullable
• community_id string nullable
• price number nullable
• price_per_sqm number nullable
• currency string (default: "CNY")
• area_sqm number nullable
• room_count integer nullable
• hall_count integer nullable
• bathroom_count integer nullable
• built_year integer nullable
• orientation string nullable
• decoration string nullable
• floor string nullable
• floor_count integer nullable
• use_type string nullable
• ownership_type string nullable
• ownership_term string nullable
• is_only_home boolean nullable
• has_elevator boolean nullable
• has_heating boolean nullable
• has_video boolean nullable
• has_vr_tour boolean nullable
• is_verified boolean nullable
• is_government_verified boolean nullable
• is_landlord_listed boolean nullable
• is_quality_listing boolean nullable
• holding_period_years integer nullable
• government_verification_code string nullable
• government_verification_qr_image string nullable
• posted_at integer nullable
• text string nullable
• tags array (default: [])
• features array (default: [])
• image string nullable
• images array (default: [])
• floor_plan_images array (default: [])
• outdoor_images array (default: [])
• vr_tour_url string nullable
• video_url string nullable
• down_payment number nullable
• monthly_payment number nullable
• broker object nullable
  • @type string (default: "AnjukeBroker")
  • id string required
  • name string nullable
  • image string nullable
  • rating number nullable
  • company_id string nullable
  • company_name string nullable
  • company_full_name string nullable
  • store_id string nullable
  • store_name string nullable
  • url string nullable
  • company_url string nullable
• community object nullable
  • @type string (default: "AnjukeListingCommunity")
  • id string required
  • url string required
  • name string nullable
  • address string nullable
  • latitude number nullable
  • longitude number nullable
  • district string nullable
  • district_id string nullable
  • block string nullable
  • block_id string nullable
  • business_area string nullable
  • business_area_id string nullable
  • image string nullable
  • building_type string nullable
  • ownership_type string nullable
  • built_year integer nullable
  • rating number nullable
  • tags array (default: [])
  • avg_price_per_sqm number nullable
  • price_change_month_pct number nullable
  • price_change_year_pct number nullable
  • sale_listing_count integer nullable
  • rent_listing_count integer nullable
• community_price_history array (default: [])
  • @type string (default: "AnjukePricePoint")
  • month string required
  • price_per_sqm number nullable
• business_area_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 or a filter option 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.