阿里大于 -

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
open_request	OpenRequest	必须			request
param ApartmentSearchTopRequest 必须 param └ search_text String 必须玉兰香苑联想词 └ city_id Number 必须 340100 城市id └ bedroom_range String 必须 3to4 卧室个数范围 └ area_range String 必须 80to100 面积范围 └ offset Number 必须 0 偏移量 └ limit Number 必须 16 单页大小

名称	类型	示例值	描述
result	Result		result
└ message_flag Boolean true 是否成功 └ message_info String success 错误message └ message_code Number 0 状态码 data OpenPagingWrapResult data paging_data OpenPagingData 分页信息 └ total Number 64 总数 list ApartmentSearchTopResponse [] list └ id String a80f46f2-8e3e-4ccd-8c96-830488780950 户型id └ name String 玉兰香苑户型名称 └ neighbor String 玉兰香苑小区名称 └ province_id Number 340000 省id └ province_name String 安徽省省名称 └ city_id Number 340100 城市id └ city_name String 合肥市城市名称 └ district_id Number 340122 区id └ district_name String 肥西县区名称 └ area BigDecimal 110.23 面积 └ gross_area BigDecimal 132.57 建筑面积 meta ApartmentMeta 元信息 └ image_2d_url String https://hxt.shejijia.com/Ast_wm/1dd85a44328d7d6e00a83fdadf2e889c.png 户型图封面图url └ bedroom_num Number 3 卧室数量 └ living_room_num Number 2 客厅数量 └ bathroom_num Number 1 卫生间数量

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaHomestylerApartmentSearchRequest req = new AlibabaHomestylerApartmentSearchRequest();
AlibabaHomestylerApartmentSearchRequest.OpenRequest obj1 = new AlibabaHomestylerApartmentSearchRequest.OpenRequest();
AlibabaHomestylerApartmentSearchRequest.ApartmentSearchTopRequest obj2 = new AlibabaHomestylerApartmentSearchRequest.ApartmentSearchTopRequest();
obj2.setSearchText("玉兰香苑");
obj2.setCityId(340100L);
obj2.setBedroomRange("3to4");
obj2.setAreaRange("80to100");
obj2.setOffset(0L);
obj2.setLimit(16L);
obj1.setParam(obj2);
req.setOpenRequest(obj1);
AlibabaHomestylerApartmentSearchResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaHomestylerApartmentSearchRequest req = new AlibabaHomestylerApartmentSearchRequest();
AlibabaHomestylerApartmentSearchRequest.OpenRequestDomain obj1 = new AlibabaHomestylerApartmentSearchRequest.OpenRequestDomain();
AlibabaHomestylerApartmentSearchRequest.ApartmentSearchTopRequestDomain obj2 = new AlibabaHomestylerApartmentSearchRequest.ApartmentSearchTopRequestDomain();
obj2.SearchText = "玉兰香苑";
obj2.CityId = 340100L;
obj2.BedroomRange = "3to4";
obj2.AreaRange = "80to100";
obj2.Offset = 0L;
obj2.Limit = 16L;
obj1.Param= obj2;
req.OpenRequest_ = obj1;
AlibabaHomestylerApartmentSearchResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaHomestylerApartmentSearchRequest;
$open_request = new OpenRequest;
$param = new ApartmentSearchTopRequest;
$param->search_text="玉兰香苑";
$param->city_id="340100";
$param->bedroom_range="3to4";
$param->area_range="80to100";
$param->offset="0";
$param->limit="16";
$open_request->param = $param;
$req->setOpenRequest(json_encode($open_request));
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alibaba.homestyler.apartment.search' \
-d 'partner_id=apidoc' \
-d 'sign=56E055540BD92B3E0C4896E1CCB55C6D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-14+17%3A53%3A09' \
-d 'v=2.0' \
-d 'open_request=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.AlibabaHomestylerApartmentSearchRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.open_request="数据结构示例JSON格式"
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"alibaba.homestyler.apartment.search");
add_param(pRequest,"open_request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.homestyler.apartment.search', {
	'open_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_homestyler_apartment_search_response>
    <result>
        <message_flag>true</message_flag>
        <message_info>success</message_info>
        <message_code>0</message_code>
        <data>
            <paging_data>
                <total>64</total>
            </paging_data>
            <list>
                <apartment_search_top_response>
                    <id>a80f46f2-8e3e-4ccd-8c96-830488780950</id>
                    <name>玉兰香苑</name>
                    <neighbor>玉兰香苑</neighbor>
                    <province_id>340000</province_id>
                    <province_name>安徽省</province_name>
                    <city_id>340100</city_id>
                    <city_name>合肥市</city_name>
                    <district_id>340122</district_id>
                    <district_name>肥西县</district_name>
                    <area>110.23</area>
                    <gross_area>132.57</gross_area>
                    <meta>
                        <image_2d_url>https://hxt.shejijia.com/Ast_wm/1dd85a44328d7d6e00a83fdadf2e889c.png</image_2d_url>
                    </meta>
                    <bedroom_num>3</bedroom_num>
                    <living_room_num>2</living_room_num>
                    <bathroom_num>1</bathroom_num>
                </apartment_search_top_response>
            </list>
        </data>
    </result>
</alibaba_homestyler_apartment_search_response>

{
    "alibaba_homestyler_apartment_search_response":{
        "result":{
            "message_flag":true,
            "message_info":"success",
            "message_code":0,
            "data":{
                "paging_data":{
                    "total":64
                },
                "list":{
                    "apartment_search_top_response":[
                        {
                            "id":"a80f46f2-8e3e-4ccd-8c96-830488780950",
                            "name":"玉兰香苑",
                            "neighbor":"玉兰香苑",
                            "province_id":340000,
                            "province_name":"安徽省",
                            "city_id":340100,
                            "city_name":"合肥市",
                            "district_id":340122,
                            "district_name":"肥西县",
                            "area":"110.23",
                            "gross_area":"132.57",
                            "meta":{
                                "image_2d_url":"https:\/\/hxt.shejijia.com\/Ast_wm\/1dd85a44328d7d6e00a83fdadf2e889c.png"
                            },
                            "bedroom_num":3,
                            "living_room_num":2,
                            "bathroom_num":1
                        }
                    ]
                }
            }
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

装企端

alibaba.homestyler.apartment.search (户型库小区小区名称联想)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ