Beike APIs - Resale Housing List (V1)
Fetches a list of second-hand property listings from Beike (Lianjia) based on specified filters.
Key features:
- Supports filtering by city/region, price range, layout, and area.
- Returns core listing details such as title, total price, unit price, and community info.
- Provides house codes for fetching full details via the detail API.
Typical use cases:
- Building search result pages for property portals.
- Aggregating market data for regional housing trends.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
token | query | string | Yes | User authentication token. |
cityId | query | string | Yes | The ID of the city (e.g., '110000' for Beijing). |
condition | query | string | No | Filter conditions (e.g., region, price range, layout). |
offset | query | integer | No | Pagination offset, starting from 0 (e.g., 0, 20, 40...). |
Code Samples
💡 Environment Note
Default samples use https://api.justoneapi.com (prod-global). For users in Mainland China, it is recommended to replace it with http://47.117.133.51:30015 (prod-cn) for better performance. See Environment Guide.
bash
# Tip: For Mainland China, replace https://api.justoneapi.com with http://47.117.133.51:30015
curl -X GET "https://api.justoneapi.com/api/beike/get-ershoufang-list/v1?token=YOUR_API_KEY&cityId=VALUE"text
I want to use the "Resale Housing List (V1)" API from Just One API.
API Endpoint: https://api.justoneapi.com/api/beike/get-ershoufang-list/v1
HTTP Method: GET
Authentication: Append "?token=YOUR_API_KEY" to the URL.
OpenAPI Definition: https://docs.justoneapi.com/openapi/beike-apis/resale-housing-list-v1-en.json
Parameters:
- token (query): User authentication token. (Required)
- cityId (query): The ID of the city (e.g., '110000' for Beijing). (Required)
- condition (query): Filter conditions (e.g., region, price range, layout).
- offset (query): Pagination offset, starting from 0 (e.g., 0, 20, 40...).
Return format: JSON
Response Handling & Error Codes:
1. Business results should be determined by the "code" field in the response body (code 0 means success).
2. Timeout Recommendation: Set request timeout to at least 60 seconds.
3. Business Code Reference:
- 0: Success
- 100: Invalid or Inactive Token
- 301: Collection Failed. Please Retry.
- 302: Rate Limit Exceeded
- 303: Daily Quota Exceeded
- 400: Invalid Parameters
- 500: Internal Server Error
- 600: Permission Denied
- 601: Insufficient Balance
Please help me write a script in my preferred programming language to call this API and handle the response.python
# Tip: For Mainland China, replace https://api.justoneapi.com with http://47.117.133.51:30015
import requests
url = "https://api.justoneapi.com/api/beike/get-ershoufang-list/v1?token=YOUR_API_KEY&cityId=VALUE"
response = requests.get(url)
print(response.json())js
// Tip: For Mainland China, replace https://api.justoneapi.com with http://47.117.133.51:30015
const response = await fetch("https://api.justoneapi.com/api/beike/get-ershoufang-list/v1?token=YOUR_API_KEY&cityId=VALUE", {
method: "GET"
});
const data = await response.json();
console.log(data);java
// Tip: For Mainland China, replace https://api.justoneapi.com with http://47.117.133.51:30015
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.justoneapi.com/api/beike/get-ershoufang-list/v1?token=YOUR_API_KEY&cityId=VALUE"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}go
// Tip: For Mainland China, replace https://api.justoneapi.com with http://47.117.133.51:30015
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
client := &http.Client{}
url := "https://api.justoneapi.com/api/beike/get-ershoufang-list/v1?token=YOUR_API_KEY&cityId=VALUE"
req, _ := http.NewRequest("GET", url, nil)
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}php
// Tip: For Mainland China, replace https://api.justoneapi.com with http://47.117.133.51:30015
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.justoneapi.com/api/beike/get-ershoufang-list/v1?token=YOUR_API_KEY&cityId=VALUE");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($ch);
curl_close($ch);
echo $response;Responses
json
{
"code": 0,
"data": {
"request_id": "dd9a1e0e-1bc0-11f1-8335-ba5e53120619",
"uniqid": "1055-5AE4-9BAD-7E42-6B9B97F1E7C3",
"errno": 0,
"error": "",
"data": {
"totalCount": 0,
"noResultNearHouse": 0,
"returnCount": 0,
"hasMoreData": 0,
"headerList": [
{
"filters": {
"checkFilters": {
"region": {
"name": "区域",
"type": 0,
"options": [
{
"name": "区域",
"itemType": "district",
"type": 0,
"alias": "d",
"options": [
{
"name": "不限",
"type": 0,
"options": [
{
"name": "不限"
}
]
}
]
}
]
},
"price": {
"name": "价格",
"itemType": "totalPrice",
"type": 1,
"alias": "p",
"range": {
"name": "自定义价格",
"min": {
"name": "最低总价",
"key": "bp"
},
"max": {
"name": "最高总价",
"key": "ep"
},
"slide": {
"length": 10000000,
"step": 100000,
"minText": "0元",
"maxText": "1000万以上"
},
"rangeUnit": {
"default": "万",
"less": "万以下",
"more": "万以上"
},
"rangeUnitLow": {
"default": "元",
"less": "元以下",
"more": "元以上"
}
},
"options": [
{
"name": "200万以下",
"id": 1,
"key": "p1",
"left": 0,
"right": 2000000
}
]
},
"room": {
"name": "房型",
"itemType": "room_count",
"type": 1,
"alias": "l",
"options": [
{
"name": "一室",
"id": 1,
"key": "l1"
}
]
},
"area": {
"name": "建筑面积",
"itemType": "house_area",
"type": 1,
"alias": "a",
"range": {
"name": "自定义建筑面积",
"min": {
"name": "最小",
"key": "ba"
},
"max": {
"name": "最大",
"key": "ea"
},
"slide": {
"length": 200,
"step": 5,
"minText": "0㎡",
"maxText": "200㎡以上"
},
"rangeUnit": {
"default": "㎡",
"less": "㎡以下",
"more": "㎡以上"
}
},
"options": [
{
"name": "50㎡以下",
"id": 1,
"key": "a1",
"left": 0,
"right": 50
}
]
},
"more": {
"name": "更多",
"type": 1,
"options": [
{
"name": "建筑面积",
"itemType": "house_area",
"type": 1,
"alias": "a",
"range": {
"name": "自定义建筑面积",
"min": {
"name": "最小",
"key": "ba"
},
"max": {
"name": "最大",
"key": "ea"
},
"slide": {
"length": 200,
"step": 5,
"minText": "0㎡",
"maxText": "200㎡以上"
},
"rangeUnit": {
"default": "㎡",
"less": "㎡以下",
"more": "㎡以上"
}
},
"options": [
{
"name": "50㎡以下",
"id": 1,
"key": "a1",
"left": 0,
"right": 50
}
]
}
]
},
"soldMore": {
"name": "建筑面积",
"type": 1,
"options": [
{
"name": "建筑面积",
"itemType": "house_area",
"type": 1,
"alias": "a",
"range": {
"name": "自定义建筑面积",
"min": {
"name": "最小",
"key": "ba"
},
"max": {
"name": "最大",
"key": "ea"
},
"slide": {
"length": 200,
"step": 5,
"minText": "0㎡",
"maxText": "200㎡以上"
},
"rangeUnit": {
"default": "㎡",
"less": "㎡以下",
"more": "㎡以上"
}
},
"options": [
{
"name": "50㎡以下",
"id": 1,
"key": "a1",
"left": 0,
"right": 50
}
]
}
]
}
},
"sortFilters": [
{
"name": "默认排序"
}
],
"listFilters": [
{
"name": "满五年",
"id": 1,
"key": "mw1"
}
]
},
"itemKey": "filters"
}
],
"houseTooFew": 0,
"subscribe": 0
},
"cost": 58
}
}💡 Note: For list data, the example shows only 1-2 items for simplicity. The actual count depends on the API response.