淘宝开放平台 - 文档中心

请求地址：

环境	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。

名称	类型	是否必须	示例值	描述
nick	String	必须	测试	测试nick
city_code	String	可选	410100	城市编码
community_name	String	可选	阳光城	小区名

名称	类型	示例值	描述
result	TopResult		结果
└ error_code String param_invalid 错误编码 value CommunityInfo [] 小区列表 └ source Number 1 来源 └ id String 1 小区id └ name String 小区小区名称 └ error_msg String 参数无效错误描述

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AuctionTitanGetCommunitylistRequest req = new AuctionTitanGetCommunitylistRequest();
req.setNick("测试");
req.setCityCode("410100");
req.setCommunityName("阳光城");
AuctionTitanGetCommunitylistResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AuctionTitanGetCommunitylistRequest req = new AuctionTitanGetCommunitylistRequest();
req.Nick = "测试";
req.CityCode = "410100";
req.CommunityName = "阳光城";
AuctionTitanGetCommunitylistResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AuctionTitanGetCommunitylistRequest;
$req->setNick("测试");
$req->setCityCode("410100");
$req->setCommunityName("阳光城");
$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=taobao.auction.titan.get.communitylist' \
-d 'partner_id=apidoc' \
-d 'sign=5063F513E14D3618C76273E6DDF2DA0B' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-03+23%3A41%3A01' \
-d 'v=2.0' \
-d 'city_code=410100' \
-d 'community_name=%E9%98%B3%E5%85%89%E5%9F%8E' \
-d 'nick=%E6%B5%8B%E8%AF%95'

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

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

req.nick="测试"
req.city_code="410100"
req.community_name="阳光城"
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,"taobao.auction.titan.get.communitylist");
add_param(pRequest,"nick","测试");
add_param(pRequest,"city_code","410100");
add_param(pRequest,"community_name","阳光城");
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('taobao.auction.titan.get.communitylist', {
	'nick':'测试',
	'city_code':'410100',
	'community_name':'阳光城'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<auction_titan_get_communitylist_response>
    <result>
        <error_code>param_invalid</error_code>
        <value>
            <community_info>
                <source>1</source>
                <id>1</id>
                <name>小区</name>
            </community_info>
        </value>
        <error_msg>参数无效</error_msg>
    </result>
</auction_titan_get_communitylist_response>

{
    "auction_titan_get_communitylist_response":{
        "result":{
            "error_code":"param_invalid",
            "value":{
                "community_info":[
                    {
                        "source":1,
                        "id":"1",
                        "name":"小区"
                    }
                ]
            },
            "error_msg":"参数无效"
        }
    }
}

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下载

开放平台

拍卖API

taobao.auction.titan.get.communitylist (获取小区列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ