申请测试

房价网开放平台(Fangjia Open Platform)是房价网商务基础服务的重要开放途径,房价网开放平台的使命是把房价网的优质海量数据像水、电、煤一样输送给有需要的商家、开发者、社区媒体和各行各业。

2.1  调用方式

接口调用方式采用http调用方式,使用REST API模式。

2.2  参数编码

参数值部分采用UTF-8编码。详情见附录4.3。

2.3  大小写

所有URL路径,参数key/value均大小写敏感。

2.4  公共参数

所有的接口方法调用都必须加上token参数,token参数须向房价网申请。
注意:token的有效时间为2小时,过期后请调用授权接口重新获取

2.5  城市和区域参数

接口中的城市和区域参数需要使用简称,例如:上海市输入“上海”即可,黄浦区输入“黄浦”即可,您可以使用城市列表接口以及城市区域查询接口获得我们支持的标准城市以及区域。

2.6  响应方式

接口返回的数据格式为JSON格式。

在访问房价网开放API前必须向房价网申请token。
注意:token的有效时间为2小时,过期后请调用授权接口重新获取

3.1.1  接口地址

http://open.fangjia.com/accessToken

3.1.2  输入参数
参数名 参数类型 是否必填 说明
username String 用户名
password String 密码
appKey String appKey
3.1.3  响应参数
名称 类型 描述
token String
3.1.4  响应示例

根据相关条件搜索小区。

3.2.1.1  接口地址

http://open.fangjia.com/property/search

3.2.1.2  输入参数
参数名 参数类型 是否必填 说明
city String 城市,例:上海
district String 区域名,例:长宁
block String 板块名(部分城市不支持板块),例:中山公园
keyword String 查询关键词
lat double 纬度
lng double 经度
from int 经纬度坐标系,1:百度(默认)2:高德
radius int 搜索半径,单位:米,仅当提供了lat和lng参数时有效,默认半径1000,最大5000
max int 最大返回结果数,默认20,最大100
token String API访问授权凭证

注意:查询关键词与经纬度至少填写其中的一个参数,否则默认搜索城市中心点附近的小区

3.2.1.3  响应参数
名称 类型 描述
id String 小区ID
city String 城市名
district String 区域
block String 板块
name String 小区名
address String 地址
lng String 经度(经纬度类型由from参数决定)
lat String 纬度(经纬度类型由from参数决定)
propertyType String 物业类型,例:普通住宅、别墅、商住
distance String 返回小区与输入经纬度之间的距离,单位:米
3.2.1.4  响应示例

根据小区ID或小区名或地址获得小区详细信息。

3.2.2.1  接口地址

http://open.fangjia.com/property/detail

3.2.2.2  输入参数
参数名 参数类型 是否必填 说明
city String 城市,例:上海
district String 区域名,例:长宁
name String 小区名
id String 小区ID
token String API访问授权凭证
3.2.2.2.1  组合场景
3.2.2.2.1.1  根据小区名获得小区详情
参数名 参数类型 是否必填 说明
city String 城市,例:上海
district String 区域名,例:长宁
name String 小区名
3.2.2.2.1.2  根据小区ID获得小区详情
参数名 参数类型 是否必填 说明
id String 小区ID
3.2.2.3  响应参数
名称 类型 描述
id String 小区ID
city String 城市
district String 区域
name String 小区名
address String 地址
avgPrice int 均价,单位:元/平米
lng double 经度
lat double 纬度
propertyType String 物业类型,例:普通住宅、别墅(独立别墅、双拼别墅、联排别墅、叠加别墅)、商住
3.2.2.4  响应示例

获得小区当前均价。

3.2.3.1  接口地址

http://open.fangjia.com/property/avgPrice

3.2.3.2  输入参数
参数名 参数类型 是否必填 说明
city String 城市,例:上海
district String 区域名,例:长宁
name String 小区名
periodType String 均价周期类型,取值为:weekly(按周计算)或者monthly(按月计算)
periodCount int 最近多少期数据,范围1到156,默认为1
token String API访问授权凭证
3.2.3.3  响应参数
名称 类型 描述
city String 城市
district String 区域
name String 小区名
avgPrice int 均价,单位:元/平米
date String 日期,一般为周末,格式为yyyy-MM-dd或者yyyy-MM,根据周期变动
changePercent double 涨幅,单位:%
3.2.3.4  响应示例

获取小区租金走势数据。

3.2.4.1  接口地址

http://open.fangjia.com/property/rent

3.2.4.2  输入参数
参数名 参数类型 是否必填 说明
city String 城市,例:上海
district String 区域名,例:长宁
name String 小区名
houseType int 房型,例1:一室,2:二室
periodCount int 最近多少期数据,周期:月
token String API访问授权凭证
3.2.4.3  响应参数
名称 类型 描述
city String 城市
district String 区域
name String 小区名
rent int 租金,单位:元/平米•月
date String 日期,例:yyyy-MM
changePercent double 月涨幅,单位:%
houseType int 房型
3.2.4.4  响应示例

返回和用户输入相似的小区名。

3.2.5.1  接口地址

http://open.fangjia.com/property/autoComplete

3.2.5.2  输入参数
参数名 参数类型 是否必填 说明
city String 城市,例:上海
keyword String 关键词
max int 返回的记录数,默认10,最大20
token String API访问授权凭证

适用场景:该接口与小区搜索接口相比效率更高且支持拼音搜索,缺点是目前尚不支持经纬度搜索,且数据有一定的延迟

3.2.5.3  响应参数
名称 类型 描述
city String 城市
district String 区域
name String 小区名
address String 小区地址
3.2.5.4  响应示例

匹配与地址最相近的小区、商铺或者写字楼。

3.2.6.1  接口地址

http://open.fangjia.com/address/match

3.2.6.2  输入参数
参数名 参数类型 是否必填 说明
city String 城市,例:上海
address String 要匹配的地址
category String 要匹配的地址类型,可选值:1:property(小区)2:shop(商铺)3:office(写字楼)
suggestDistrict String 建议区域,优先匹配该区域的小区
token String API访问授权凭证
3.2.6.3  响应参数
名称 类型 描述
credit double 可信度
province String 省份
city String 城市
district String 区域
block String 板块
name String 小区名
address String 地址
lng double 经度(百度)
lat double 纬度(百度)
3.2.6.4  响应示例

解析并验证地址的真实性。

3.2.7.1  接口地址

http://open.fangjia.com/address/certificate

3.2.7.2  输入参数
参数名 参数类型 是否必填 说明
city String 参考城市
address String 地址
token String API访问授权凭证

注意:地址或者城市应至少有一个包含城市信息

3.2.7.3  响应参数
名称 类型 描述
province String 省份
city String 城市
district String 区域
developmentZone String 开发区
township String 乡镇
street String 街道(可认证)
streetNumber String 街道号(可认证)
name String 小区名(可认证)
buildingNumber String 楼栋号(可认证)
unitNumber String 单元号(可认证)
roomNumber String 室号(可认证)
formattedAddress String 格式化地址
certified List 认证字段列表

注意:
1. 验证室号时,如果不存在楼栋号或者单元号默认使用1
2. 验证单元时,如果不存在楼栋号默认使用1

3.2.7.4  响应示例

批量获取小区的均价,均价走势数据(最多12个小区)。

3.2.8.1  接口地址

http://open.fangjia.com/property/price

3.2.8.2  调用方式

调用接口时,使用POST请求、JSON数据包格式。

3.2.8.3  输入参数
参数名 参数类型 是否必填 说明
city String 城市
district String 区域
name String 小区名
id String 小区ID
token String API访问授权凭证

参数需要满足以下条件:
城市+区域+小区名不为空;或者小区ID不为空

3.2.8.4  请求JSON数据包示例
3.2.8.5  输出参数
参数名 参数类型 说明
avgPrice int 均价
id String 小区ID
city String 城市
district String 区域
name String 小区名
riseOnMonth int 比上月涨价
mom double 比上月涨幅
riseOnYear int 比去年同期涨价
yoy double 比去年同期涨幅
updatedDate String 更新日期,格式:yyyy-MM-dd
avgPriceTrend List 最近一年的月均价走势列表
date String 日期
3.2.8.6  响应示例

批量获取小区的配套数据。

3.2.9.1  接口地址

http://open.fangjia.com/property/facilities

3.2.9.2  调用方式

调用接口时,使用POST请求、JSON数据包格式。

3.2.9.3  输入参数
参数名 参数类型 是否必填 说明
city String 城市
district String 区域
name String 小区名
id String 小区ID
num int 返回的配套最大记录数
radius int 周边配套查询半径,单位:米,默认1000,最大5000
token String API访问授权凭证

参数需要满足以下条件:
城市+区域+小区名不为空;或者小区ID不为空

3.2.9.4  请求JSON数据包示例
3.2.9.5  输出参数
参数名 参数类型 说明
id String 小区ID
city String 城市
district String 区域
lng double 经度
lat double 纬度
distance int 和小区之间的距离
name String 小区名
count int 范围内配套设施总数
bus Object 公交信息
buses List 公交列表
metro Object 地铁信息
metros List 地铁列表
school Object 学校信息
schools List 学校列表
hospital Object 医院信息
hospitals List 医院列表
bank Object 银行信息
banks List 银行列表
supermarket Object 超市信息
supermarkets List 超市列表
market Object 商场信息
markets List 商场列表
beautySalon Object 美容院信息
beautySalons List 美容院列表
gym Object 健身中心信息
gyms List 健身中心列表
park Object 公园信息
parks List 公园列表
3.2.9.6  响应示例

对房子进行估价。

3.3.1  接口地址

http://open.fangjia.com/property/evaluate

3.3.2  输入参数
参数名 参数类型 是否必填 说明
city String 城市,例:上海
district String 区域,例:长宁
name String 小区名
buildingNumber String 楼号
unitNumber String 室号
size float 面积,单位:平米
floor int 所在楼层
maxFloor int 总楼层
room int 室数量
hall int 厅数量
toilet int 卫数量
calDate String 估价时间,默认为当前时间估价,例:2012-12-01
propertyType String 物业类型,取值为:0=普通住宅(默认)1=别墅  2=商住
direction String 朝向,可选值有:1=西南  2=东南  3=南(默认)4=西北  5=东北  6=东  7=西  8=北  9=东西  10=南北
decoration String 装修情况,可选值有:1=毛坯  2=简装(默认)3=精装  4=豪装
decorationCost int 装修价格,单位:元,decorationAge输入合法值才生效
decorationAge int 装修年限,可选值有:1=1年  2=2年  3=3年  4=4年  5=4年以上
view String 景观情况,可选值有:1=景观房  2=侧景观房  3=一般(默认)4=差
noise String 噪音情况,可选值有:0=无噪音(默认)1=噪音较小  2=噪音大
gardenSize float 花园面积,单位:平米
basementSize float 地下室面积,单位:平米
negativeFactor String 厌恶因素,可选值有:1=很近  2=较近  3=无(默认)
age int 房龄,单位:年
carportPrice int 车位价,单位:元,如无车位,则本字段填0
facilities String 小区配套,可选值有:0=健身房  1=游泳池  2=会所  3=网球场  4=球场  5=棋牌室  6=停车场  7=图书馆  8=活动中心,如同时拥有多个配套,使用逗号分隔
insidePosition String 小区位置,可选值有:0=离小区出口近  1=离小区出口远  2=离小区出口距离适中
token String API访问授权凭证
3.3.3  响应参数
名称 类型 描述
city String 城市
district String 区域
name String 小区名
totalPrice int 总价,单位:元
avgPrice int 单价,单位:元/平米
3.3.4  响应示例

查询指定小区内条件相似的挂牌房源。

3.4.1  接口地址

http://open.fangjia.com/property/house

3.4.2  输入参数
参数名 参数类型 是否必填 说明
city String 城市,例:上海
district String 区域,例:长宁
name String 小区名
size float 面积,单位:平米
floor int 所在楼层
maxFloor int 总楼层
room int 室数量
hall int 厅数量
toilet int 卫数量
propertyType String 物业类型,取值为:0=普通住宅(默认)1=别墅(独立别墅、双拼别墅、联排别墅、叠加别墅)2=商住
decoration String 装修情况,可选值有:1=毛坯  2=简装  3=精装  4=豪装
convert boolean 是否把NULL值转换成0,默认:false
max int 指定返回的房源数,默认20条,最大100条
token String API访问授权凭证
3.4.3  响应参数
名称 类型 描述
city String 城市,例:上海
district String 区域,例:长宁
block String 板块
name String 小区名
address String 小区地址
size String 面积,单位:平米
avgPrice String 均价,单位:元/平米
listingPrice String 挂牌价,单位:元
decoration String 装修,例:精装
direction String 朝向,例:南
floor String 所在楼层
maxFloor String 总楼层
room String 室数量
hall String 厅数量
toilet String 卫数量
publishDate String 挂牌时间,例:2013-07-12
pic String 房源图片
source String 来源
3.4.4  响应示例

查询同一楼盘且条件相似的成交案例。

3.5.1  接口地址

http://open.fangjia.com/property/deal

3.5.2  输入参数
参数名 参数类型 是否必填 说明
city String 城市,例:上海
district String 区域,例:长宁
name String 小区名
max int 默认20,最多100
size float 面积,单位:平米
floor int 所在楼层
maxFloor int 总楼层
room int 室数量
hall int 厅数量
toilet int 卫数量
propertyType String 物业类型,取值为:0=普通住宅(默认)1=别墅(独立别墅、双拼别墅、联排别墅、叠加别墅)2=商住
decoration String 装修情况,可选值有:1=毛坯  2=简装  3=精装  4=豪装
convert boolean 是否把NULL值转换成0,默认:false
token String API访问授权凭证
3.5.3  响应参数
名称 类型 描述
city String 城市,例:上海
district String 区域,例:长宁
name String 小区名
size float 面积,单位:平米
avgPrice int 均价,单位:元/平米
totalPrice int 总价,单位:元
tradeDate String 成交时间,例:2013-07-14
floor String 所在楼层
maxFloor String 总楼层
room String 室数量
hall String 厅数量
toilet String 卫数量
decoration String 装修,例:精装
direction String 朝向,例:南
3.5.4  响应示例

获取所有支持的城市列表。

3.6.1.1  接口地址

http://open.fangjia.com/city/list

3.6.1.2  输入参数
参数名 参数类型 是否必填 说明
token String API访问授权凭证
3.6.1.3  响应参数
名称 类型 描述
name String 城市名
firstLetter String 拼音首字母
spell String 城市名拼音
lng double 经度(百度)
lat double 纬度(百度)
3.6.1.4  响应示例

查询指定城市的历史均价。

3.6.2.1  接口地址

http://open.fangjia.com/city/avgPrice2

3.6.2.2  输入参数
参数名 参数类型 是否必填 说明
city String 城市,例:上海
periodType String 均价周期类型,取值为: weekly(按周计算)或者monthly(按月计算)
periodCount int 最近多少期数据,范围1到156,默认为1
token String API访问授权凭证
3.6.2.3  响应参数
名称 类型 描述
city String 城市名
avgPrice String 均价,单位:元/平米
date String 日期,一般为周末,格式为yyyy-MM-dd或者yyyy-MM,根据周期变动
changePercent String 涨幅,单位:%
3.6.2.4  响应示例

查询指定城市下面所有的区域。

3.6.3.1  接口地址

http://open.fangjia.com/city/regions

3.6.3.2  输入参数
参数名 参数类型 是否必填 说明
city String 城市,例:上海
token String API访问授权凭证
3.6.3.3  响应参数
名称 类型 描述
name String 区域名
3.6.3.4  响应示例

获得该城市所有区域的价格数据。

3.6.4.1  接口地址

http://open.fangjia.com/city/districtAvgPrice

3.6.4.2  输入参数
参数名 参数类型 是否必填 说明
city String 城市,例:上海
token String API访问授权凭证
3.6.4.3  响应参数
名称 类型 描述
name String 区域名
avgPrice int 均价,单位:元/平米
mom double 环比涨幅,单位:%
riseOnMonth int 月涨价,单位:元
updatedDate String 更新日期,格式:yyyy-MM-dd
3.6.4.4  响应示例

获得区域均价走势数据。

3.6.5.1  接口地址

http://open.fangjia.com/district/avgPrice

3.6.5.2  输入参数
参数名 参数类型 是否必填 说明
city String 城市,例:上海
district String 区域名,例:长宁
periodType String 均价周期类型,取值为:weekly(按周计算)或者monthly(按月计算)
periodCount int 最近多少期数据,范围1到156,默认为1
token String API访问授权凭证
3.6.5.3  响应参数
名称 类型 描述
city String 城市
district String 区域
avgPrice String 均价,单位:元/平米
date String 日期,一般为周末,格式为yyyy-MM-dd或者yyyy-MM,根据周期变动
changePercent String 涨幅,单位:%
3.6.5.4  响应示例

获取住宅区域范围的平均租金走势数据。

3.6.6.1  接口地址

http://open.fangjia.com/district/rent

3.6.6.2  输入参数
参数名 参数类型 是否必填 说明
city String 城市,例:上海
district String 区域名,例:长宁
houseType int 房型,例1:一室,2:二室
periodCount int 最近多少期数据,周期:月
token String API访问授权凭证
3.6.6.3  响应参数
名称 类型 描述
city String 城市
district String 区域
rent int 租金,单位:元/平米•月
date String 日期,一般为周末,格式为yyyy-MM-dd或者yyyy-MM,根据周期变动
changePercent double 涨幅,单位:%
houseType int 房型
3.6.6.4  响应示例

获得板块均价走势数据。

3.6.7.1  接口地址

http://open.fangjia.com/block/avgPrice

3.6.7.2  输入参数
参数名 参数类型 是否必填 说明
city String 城市,例:上海
district String 区域名,例:长宁
block String 板块名,例:中山公园
periodType String 均价周期类型,取值为:weekly(按周计算)或者monthly(按月计算)
periodCount int 最近多少期数据,范围1到156,默认为1
token String API访问授权凭证
3.6.7.3  响应参数
名称 类型 描述
city String 城市
district String 区域
block String 板块
avgPrice String 均价,单位:元/平米
date String 日期,一般为周末,格式为yyyy-MM-dd或者yyyy-MM,根据周期变动
changePercent String 涨幅,单位:%
3.6.7.4  响应示例
4.1  返回码说明
返回码 说明
200 正确
400 请求参数错误,详情可以看msg
401 未经授权,通常是进行了不被授权的操作
500 服务器内部错误
4.2  msg说明

200类:正常返回

400类:此类错误原因是请求格式不正确,msg描述参数错误的具体原因,如:“城市名为必填项”

401类:此类错误原因是授权验证出错,msg提示如下:

1. 没有权限访问对应的资源(认证失败)

2. 没有权限访问对应的资源(你的账户已失效)

3. 没有权限访问对应的资源(您未开通城市上海的权限)(该处只是示例,会根据城市不同做相应提示)

4. 没有权限访问对应的资源(已达到配额上限)

5. token过期,请重新获取token(认证失败)

500类:msg为“服务器内部错误” ,此时应该是我们遇到bug了,您可以联系我们

4.3  字符编码方法说明

1. javascript中一般采用encodeURIComponent函数对特殊字符进行编码。

2. Java中可以使用函数URLEncoder.encode对特殊字符进行编码。

3. C#中可以使用函数HttpUtility.UrlEncode对特殊字符进行编码。

4. php中可以使用函数urlencode对特殊字符进行编码。

确认