item_get 接口(官方标准命名 fang.item.get)是通过房源 / 楼盘 ID 获取房产全维度结构化数据的核心接口,覆盖新房、二手房、租房、商业地产等全品类房产详情,包含房源基础信息、户型、价格、配套设施、业主评价、交易状态等字段,适配房产信息平台搭建、市场分析、购房决策辅助等场景。该接口采用 HTTPS+API Key/Secret 签名认证,支持 JSON/XML 双格式返回,具备数据权威合规、字段完整、实时性强的特点。本攻略从接口认知、权限准备、实操对接、调试排错到生产级优化,提供全链路标准化指导。一、接口核心认知:功能与适配场景
1. 接口定位与核心价值
核心功能:输入房源唯一 ID(
house_id)或楼盘 ID(building_id),返回对应房产的全量详情数据,支持新房、二手房、租房、商铺、写字楼等多类型房产查询;可通过参数指定返回字段粒度,平衡数据完整性与接口响应速度。房天下数据特性
权威合规:数据源自房天下官方房产数据库,符合住建部房产信息公示规范,支持商用场景;
字段维度全:覆盖房源基本属性、户型图、实景图、配套设施(学校 / 医院 / 交通)、价格走势、交易记录、业主评价等 50 + 核心字段;
实时性强:二手房价格、租房状态等动态数据 10 分钟内同步,新房开盘信息实时更新;
权限分级管控:基础房源信息开放度高,业主联系方式、精准成交价格等敏感数据需企业资质授权。
典型应用场景
房产信息平台搭建:整合房源详情数据,为用户提供一站式房产查询、比价服务;
房产市场分析:统计区域房价走势、户型占比、配套完善度,辅助行业研究与投资决策;
购房 / 租房决策工具:基于房源详情自动匹配用户需求(如学区房、地铁房),生成推荐报告;
房产中介管理系统:批量获取房源详情,自动化更新房源库,提升经纪人工作效率。
2. 核心参数与返回字段
(1)请求参数(GET/POST 提交,需签名认证)
| 参数类型 | 参数名称 | 类型 | 是否必填 | 说明 | 应用示例 |
|---|---|---|---|---|---|
| 公共参数 | key | string | 是 | 调用 key(开放平台获取) | fang_api_89abcdef |
| secret | string | 是 | 调用密钥(开放平台获取) | fang_secret_12345678 | |
| api_name | string | 是 | 接口名称,固定为item_get | fang.item.get | |
| result_type | string | 否 | 响应格式,默认 JSON | json/xml | |
| cache | string | 否 | 是否启用缓存,默认 yes | yes/no | |
| 业务参数 | house_id | string | 是 | 房源唯一 ID(与 building_id 二选一) | HS20260115001 |
| building_id | string | 否 | 楼盘 ID(与 house_id 二选一) | BD20260101005 | |
| data_level | int | 否 | 数据返回粒度(1 = 基础,2 = 扩展,3 = 完整) | 3 | |
| need_img | bool | 否 | 是否返回图片 URL(户型图 / 实景图) | true | |
| need_support | bool | 否 | 是否返回配套设施信息 | true | |
| need_price_trend | bool | 否 | 是否返回价格走势数据 | false |
注意事项
house_id和building_id二选一,传入building_id会返回整个楼盘的详情(含楼栋、户型、均价);
data_level=3会返回完整的成交记录、业主评价等大字段,响应体积较大,非必要不开启;签名生成需包含所有非空参数,按参数名 ASCII 升序排序后拼接 secret 进行 MD5 加密。
(2)返回核心字段(按业务分类)
| 字段分类 | 核心字段 | 说明 |
|---|---|---|
| 基础房源信息 | house_id | 房源唯一 ID |
| house_name | 房源名称(如 “XX 小区 3 室 2 厅”) | |
| building_name | 所属楼盘名称 | |
| house_type | 房产类型(新房 / 二手房 / 租房 / 商铺) | |
| house_style | 户型(如 3 室 2 厅 1 卫) | |
| area | 建筑面积(㎡) | |
| region | 所属区域(省 / 市 / 区 / 街道) | |
| address | 详细地址 | |
| 价格与交易信息 | price | 挂牌价(元 /㎡ 或 总价万元) |
| unit_price | 单价(元 /㎡) | |
| price_trend | 近 3 个月价格走势(需 need_price_trend=true) | |
| transaction_status | 交易状态(在售 / 已售 / 出租中) | |
| publish_time | 房源发布时间 | |
| 户型与图片信息 | room_num | 卧室数量 |
| hall_num | 客厅数量 | |
| bath_num | 卫生间数量 | |
| huxing_img | 户型图 URL(需 need_img=true) | |
| real_img | 实景图 URL 列表(需 need_img=true) | |
| 配套设施信息 | school | 周边学校(学区划分) |
| metro | 周边地铁(线路 + 距离) | |
| hospital | 周边医院 | |
| commerce | 周边商业(商场 / 超市) | |
| 楼盘信息(传 building_id 返回) | avg_price | 楼盘均价(元 /㎡) |
| building_year | 建成年份 | |
| property_fee | 物业费(元 /㎡・月) | |
| developer | 开发商名称 |
提示:need_price_trend=true会增加接口响应时间,建议仅在需要分析价格走势时开启。
3. 接口限制与注意事项
| 权限类型 | 日调用上限 | 调用频率 | 适用场景 |
|---|---|---|---|
| 个人测试权限 | 100 次 / 天 | 2 次 / 秒 | 功能调试、个人房产查询 |
| 企业基础权限 | 1000 次 / 天 | 5 次 / 秒 | 中小型房产中介、个人建站 |
| 企业高级权限 | 10000 次 / 天 | 20 次 / 秒 | 大型房产平台、数据服务商、行业研究机构 |
数据缓存规则:基础房源信息缓存 30 分钟,价格走势、交易状态等动态数据缓存 10 分钟;
内容限制:违规房源、已下架房源不返回数据,业主联系方式、精准成交价格需单独申请权限;
合规要求:数据仅用于合规房产信息展示、市场分析,严禁转售、篡改或用于炒房等违规用途;
地域限制:部分城市的房产数据受当地监管政策限制,仅对本地企业开放。
二、对接前准备:权限与环境搭建
1. 获取接口权限(官方唯一合规路径)
item_get 接口由房天下开放平台提供,接入步骤如下:登录房天下开放平台(https://open1.fang.com),注册企业 / 个人开发者账号;
提交资质审核:企业上传营业执照、房产中介备案证书(如有);个人上传身份证,填写应用用途(如 “房产信息查询工具”);
创建应用,填写应用名称、服务器 IP 白名单、数据用途说明,提交审核;
审核通过后,获取
key和secret(接口调用核心凭证),配置服务器 IP 白名单;申请
fang.item.get接口权限,根据业务需求选择权限等级(基础 / 进阶 / 高级)。
风险提示:严禁使用非合规爬虫、第三方代理接口抓取数据,违反平台协议会导致账号封禁、法律追责。
2. 技术环境准备
(1)支持语言与协议
协议:HTTPS(强制,HTTP 请求会被直接拦截);
开发语言:Python、Java、PHP、Go 等主流语言,推荐 Python(适配签名生成、异步并发与数据解析)。
(2)必备工具与依赖
| 工具类型 | 推荐工具 | 用途 |
|---|---|---|
| 调试工具 | 房天下开放平台调试工具 | 自动生成签名,验证参数与响应结果 |
| Postman | 模拟 GET/POST 请求,排查代码逻辑问题 | |
| 房源 ID 查询工具 | 从房天下官网获取房源 / 楼盘 ID | |
| 开发依赖 | requests | 发送 HTTPS 请求 |
| hashlib | 生成 MD5 签名,确保接口安全 | |
| jsonpath-ng | 快速解析嵌套 JSON 响应数据 | |
| pandas | 批量整理房源详情数据,生成 Excel 报告 | |
| 辅助工具 | Redis | 缓存房源详情,减少接口调用次数 |
| logging | 记录接口调用日志,便于审计与问题追溯 |
三、实操步骤:接口对接全流程(Python 示例)
步骤 1:理解签名认证规则(核心,必掌握)
收集所有非空请求参数(含公共参数与业务参数);
按参数名 ASCII 升序 排序;
拼接参数为
key1value1key2value2...的字符串格式;将
secret拼接在参数串末尾,生成签名原串;对原串进行 MD5 加密,转为小写字符串,即为签名
sign;将
sign添加到请求参数中,发送 HTTPS 请求。
步骤 2:完整代码实现(含签名生成 + 调用 + 数据标准化)
(1)依赖安装
(2)Python 代码实现
import requests
import hashlib
import time
import logging
import pandas as pd
from urllib.parse import urlencode
# 封装好API供应商demo url=https://console.open.onebound.cn/console/?i=Lex
# 日志配置:记录调用日志,便于问题排查
logging.basicConfig(
level=logging.INFO,
format="%(asctime)s - %(levelname)s - %(message)s",
handlers=[logging.FileHandler("fang_item_get.log"), logging.StreamHandler()]
)
# 配置信息(替换为你的开放平台信息)
CONFIG = {
"key": "你的接口key",
"secret": "你的接口secret",
"api_url": "https://api.fang.com/fang/item_get",
"result_type": "json",
"cache": "yes"
}
def generate_sign(params: dict, secret: str) -> str:
"""生成房天下接口签名(MD5加密)"""
# 1. 按参数名ASCII升序排序
sorted_params = sorted(params.items(), key=lambda x: x[0])
# 2. 拼接参数为key1value1key2value2格式
param_str = "".join([f"{k}{v}" for k, v in sorted_params])
# 3. 拼接secret并MD5加密
sign_str = param_str + secret
sign = hashlib.md5(sign_str.encode("utf-8")).hexdigest().lower()
return sign
def standardize_house_data(raw_house: dict) -> dict:
"""标准化房源详情数据,统一输出格式"""
# 处理配套设施信息
support = raw_house.get("support_info", {})
# 处理图片信息
img = raw_house.get("img_info", {})
return {
"房源ID": raw_house.get("house_id", ""),
"房源名称": raw_house.get("house_name", ""),
"所属楼盘": raw_house.get("building_name", ""),
"房产类型": raw_house.get("house_type", ""),
"户型": raw_house.get("house_style", ""),
"建筑面积(㎡)": raw_house.get("area", 0.0),
"所属区域": raw_house.get("region", ""),
"详细地址": raw_house.get("address", ""),
"挂牌价(万元)": raw_house.get("price", 0.0),
"单价(元/㎡)": raw_house.get("unit_price", 0.0),
"交易状态": raw_house.get("transaction_status", ""),
"发布时间": raw_house.get("publish_time", ""),
"周边学校": support.get("school", ""),
"周边地铁": support.get("metro", ""),
"户型图URL": img.get("huxing_img", ""),
"实景图URL列表": ",".join(img.get("real_img", [])),
"物业费(元/㎡·月)": raw_house.get("property_fee", 0.0),
"开发商": raw_house.get("developer", ""),
"请求时间": time.strftime("%Y-%m-%d %H:%M:%S", time.localtime())
}
def fang_item_get(
house_id: str = None,
building_id: str = None,
data_level: int = 1,
need_img: bool = True,
need_support: bool = True,
need_price_trend: bool = False
) -> dict:
"""调用房天下item_get接口获取房源/楼盘详情"""
# 1. 校验必填参数
if not house_id and not building_id:
return {"success": False, "error_msg": "house_id和building_id必须传入一个", "data": {}}
# 2. 构建公共参数
params = {
"key": CONFIG["key"],
"api_name": "item_get",
"result_type": CONFIG["result_type"],
"cache": CONFIG["cache"],
"data_level": data_level,
"need_img": str(need_img).lower(),
"need_support": str(need_support).lower(),
"need_price_trend": str(need_price_trend).lower()
}
# 3. 添加工单ID参数
if house_id:
params["house_id"] = house_id
if building_id:
params["building_id"] = building_id
# 4. 生成签名
sign = generate_sign(params, CONFIG["secret"])
params["sign"] = sign
try:
# 5. 发送HTTPS请求
response = requests.get(
url=CONFIG["api_url"],
params=params,
timeout=15,
verify=True # 生产环境建议开启证书验证
)
response.raise_for_status() # 抛出HTTP状态码异常
result = response.json()
# 6. 解析响应结果
if result.get("error_response"):
error = result["error_response"]
error_msg = f"{error.get('code', '未知错误')}: {error.get('msg', '无错误信息')}"
logging.error(f"获取详情失败(ID:{house_id or building_id}):{error_msg}")
return {"success": False, "error_msg": error_msg, "data": {}}
raw_house = result.get("item_get_response", {}).get("house_info", {})
if not raw_house:
logging.warning(f"无房源数据返回(ID:{house_id or building_id})")
return {"success": False, "error_msg": "无匹配房源/楼盘数据", "data": {}}
# 7. 标准化数据
standard_data = standardize_house_data(raw_house)
return {
"success": True,
"data": standard_data,
"error_msg": ""
}
except requests.exceptions.RequestException as e:
logging.error(f"网络请求异常(ID:{house_id or building_id}):{str(e)}")
return {"success": False, "error_msg": f"网络异常:{str(e)}", "data": {}}
except Exception as e:
logging.error(f"数据解析异常(ID:{house_id or building_id}):{str(e)}")
return {"success": False, "error_msg": f"解析异常:{str(e)}", "data": {}}
# 封装好API供应商demo url=https://console.open.onebound.cn/console/?i=Lex
# 调用示例
if __name__ == "__main__":
# 示例1:查询单个房源详情
house_id = "HS20260115001"
result = fang_item_get(
house_id=house_id,
data_level=3,
need_img=True,
need_support=True,
need_price_trend=True
)
if result["success"]:
print("房源详情信息:")
for k, v in result["data"].items():
print(f"{k}: {v}")
# 保存为Excel
df = pd.DataFrame([result["data"]])
df.to_excel(f"房天下房源详情_{house_id}.xlsx", index=False)
else:
print(f"获取失败:{result['error_msg']}")
# 示例2:查询单个楼盘详情
# building_id = "BD20260101005"
# result = fang_item_get(building_id=building_id, data_level=2)四、调试与问题排查:快速解决对接异常
1. 优先用官方工具调试(排除签名与参数问题)
登录房天下开放平台调试工具,选择
fang.item.get接口;输入
house_id或building_id、数据粒度等参数,工具自动生成签名并发送请求;若官方工具调用成功 → 问题出在代码的签名生成或参数拼接逻辑;
若官方工具调用失败 → 问题出在权限配置或参数有效性(如 ID 错误、权限不足)。
2. 高频问题排查表
| 问题现象 | 常见原因 | 解决方案 |
|---|---|---|
| 签名验证失败(401) | 1. key/secret 错误;2. 参数未按 ASCII 升序排序;3. cache 参数未加入签名;4. 布尔参数未转小写(如 True→true) | 1. 核对开放平台应用的 key/secret;2. 严格按参数名 ASCII 升序排序所有非空参数;3. 将 cache 参数加入签名生成;4. 布尔参数统一转为小写字符串 |
| 权限不足(403) | 1. 未申请fang.item.get接口权限;2. 服务器 IP 不在白名单;3. 调用频率超限;4. 申请的权限等级不足(如请求敏感数据) | 1. 在开放平台申请对应接口权限;2. 添加服务器 IP 到白名单;3. 降低调用频率,控制并发数≤权限上限;4. 升级权限等级,申请敏感数据访问权限 |
| 参数错误(400) | 1. house_id 和 building_id 都未传入;2. data_level 值非法(非 1/2/3);3. 传入的 ID 格式错误 | 1. 确保二选一传入有效 ID;2. data_level 设置为 1/2/3;3. 从房天下官网复制正确的房源 / 楼盘 ID |
| 无数据返回(200 但 data 为空) | 1. 房源 / 楼盘 ID 错误;2. 房源已下架 / 违规;3. 数据受地域监管限制 | 1. 核对 ID 是否正确,可在房天下官网搜索验证;2. 更换有效 ID 测试;3. 联系开放平台客服确认地域权限 |
| 响应超时(504) | 1. 网络波动;2. data_level=3 且开启多个附加参数;3. 高峰期调用(工作日 9:00-11:00) | 1. 添加重试机制;2. 降低数据粒度(如改为 data_level=1),关闭非必要参数;3. 避开高峰期调用,增加超时时间至 15 秒 |
五、进阶优化:生产级稳定性提升
1. 性能与配额优化
批量调用优化:多房源 ID 查询时采用 异步并发(
aiohttp),并发数≤权限允许的频率上限(如企业基础权限 5 次 / 秒);避免循环同步调用导致的效率低下。智能缓存策略:用 Redis 缓存房源详情,缓存 key 为
fang_house_房源ID_data_level,动态数据(价格 / 状态)缓存 10 分钟,基础数据缓存 30 分钟;楼盘数据缓存时间可延长至 1 小时。字段按需获取:根据业务需求选择
data_level,例如仅展示基础信息时用data_level=1,避免请求冗余字段拖慢响应速度。
2. 数据质量优化
数据去重与清洗:按
house_id去重,避免重复存储同一房源数据;过滤面积≤0、价格≤0 的异常数据;统一户型、区域等字段的命名格式(如 “3 室 2 厅” 而非 “三室两厅”)。缺失值处理:对返回的缺失字段(如物业费、开发商)填充默认值(如 “暂无数据”),避免下游系统报错。
价格单位统一:接口返回的价格可能有 “元 /㎡” 和 “总价万元” 两种单位,需在标准化函数中统一转换为用户易理解的格式。
3. 合规与安全优化
密钥管理:生产环境禁止硬编码
key和secret,存储在配置中心(如 Nacos、Apollo)或环境变量中;定期轮换密钥(每 3 个月一次),降低泄露风险。重试机制:对 403(频率超限)、504(超时)等临时性错误,添加 指数退避重试 策略,首次重试间隔 1 秒,之后间隔翻倍,最多重试 3 次;对 400、401 等永久性错误直接抛出,不重试。
日志审计:记录每次调用的
house_id、data_level、响应状态、耗时等信息,日志保留至少 30 天;便于排查问题和满足合规审计要求。
六、扩展场景:接口联动与功能升级
联动 item_search 接口:通过
item_search按关键词(如 “学区房 地铁口”)获取房源 ID 列表,再批量调用item_get获取详情,实现 “搜索 - 详情” 全链路数据采集。房价走势分析系统:定时调用
item_get(开启need_price_trend=true),收集历史价格数据,生成区域房价走势图,辅助用户判断购房时机。智能房源推荐系统:基于
item_get返回的配套设施、户型等数据,结合用户画像(如刚需、改善、投资),构建推荐算法,实现精准房源匹配。房产中介工单系统:将
item_get接口与 CRM 系统对接,经纪人输入房源 ID 即可自动填充详情,减少手动录入工作量