淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
cat_ids	Number []	可选	123,456	最大列表长度：20	标的物类目id
court_city	String	可选	杭州市		法院所在城市
court_name	String	可选	北京市第二中级人民法院		法院名称
court_prov	String	可选	浙江		法院所在省份。注意：浙江省要输入浙江
current_page	Number	可选	1	默认值：1	分页页码
item_city	String	可选	杭州		标的物所在城市。注意：杭州市要输入杭州
item_prov	String	可选	北京		标的物所在省份。注意：浙江省要输入浙江
page_size	Number	可选	20	默认值：20	分页的每页条数
sort	Number	可选	0		排序条件，可选：价格低到高=0，价格高到低=1，出价次数高到低=2
status	Number []	可选	1,2	最大列表长度：20	标的物状态，可选：正在进行=0，即将开始=1，已结束=2
start_time_from	Date	可选	2015-01-01 00:00:00		标的物开始时间范围查询：在start_time_from及之后开始的标的物
start_time_to	Date	可选	2015-01-01 00:00:00		标的物开始时间范围查询：在start_time_to及之前开始的标的物
end_time_from	Date	可选	2015-01-01 00:00:00		标的物结束时间范围查询：在end_time_from及之后结束的标的物
end_time_to	Date	可选	2015-01-01 00:00:00		标的物结束时间范围查询：在end_time_to及之前结束的标的物
key_words	String	可选	房子		关键字搜索
pub_time_from	Date	可选	2015-01-01 00:00:00		标的物发布开始时间范围查询：在pub_time_from及之后发布的标的物
pub_time_to	Date	可选	2015-01-01 00:00:00		标的物发布结束时间范围查询：在pub_time_to及之前发布的标的物

名称	类型	示例值	描述
auctions	AuctionVo []		司法拍卖标的物信息
└ apply_count Number 2 报名人数 └ auction_status String 正在进行拍品状态：正在进行\|即将开始\|中止\|撤回\|流拍\|已结束 └ bail String 1.00 保证金 └ bid_count Number 3 出价次数 └ cat_id Number 123 类目id └ consult_price String 11.00 评估价 └ court_name String 北京市第二中级人民法院法院名称 └ current_price String 10.00 当前价 └ end_time Number 1434517024485 结束时间 └ has_reserve Boolean false 是否有保留价 └ item_id Number 1324344322 标的物id └ now_time Number 1434517025000 系统当前时间 └ pic_url String img.alicdn.com/bao/uploaded/i1/TB1JvALHVXXXXXcXpXXyq.mFpXX 图片地址 └ start_time Number 1434516024000 开始时间 └ starting_price String 1.00 起拍价 └ title String 北京市海淀区马连洼竹园35号楼2单元2018号房产标的物标题 └ pv_count Number 123 围观数
total	Number	10	记录条数

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AuctionGovAuctionsGetRequest req = new AuctionGovAuctionsGetRequest();
req.setCatIds("123,456");
req.setCourtCity("杭州市");
req.setCourtName("北京市第二中级人民法院");
req.setCourtProv("浙江");
req.setCurrentPage(1L);
req.setItemCity("杭州");
req.setItemProv("北京");
req.setPageSize(20L);
req.setSort(0L);
req.setStatus("1,2");
req.setStartTimeFrom(StringUtils.parseDateTime("2015-01-01 00:00:00"));
req.setStartTimeTo(StringUtils.parseDateTime("2015-01-01 00:00:00"));
req.setEndTimeFrom(StringUtils.parseDateTime("2015-01-01 00:00:00"));
req.setEndTimeTo(StringUtils.parseDateTime("2015-01-01 00:00:00"));
req.setKeyWords("房子");
req.setPubTimeFrom(StringUtils.parseDateTime("2015-01-01 00:00:00"));
req.setPubTimeTo(StringUtils.parseDateTime("2015-01-01 00:00:00"));
AuctionGovAuctionsGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AuctionGovAuctionsGetRequest req = new AuctionGovAuctionsGetRequest();
req.CatIds = "123,456";
req.CourtCity = "杭州市";
req.CourtName = "北京市第二中级人民法院";
req.CourtProv = "浙江";
req.CurrentPage = 1L;
req.ItemCity = "杭州";
req.ItemProv = "北京";
req.PageSize = 20L;
req.Sort = 0L;
req.Status = "1,2";
req.StartTimeFrom = DateTime.Parse("2015-01-01 00:00:00");
req.StartTimeTo = DateTime.Parse("2015-01-01 00:00:00");
req.EndTimeFrom = DateTime.Parse("2015-01-01 00:00:00");
req.EndTimeTo = DateTime.Parse("2015-01-01 00:00:00");
req.KeyWords = "房子";
req.PubTimeFrom = DateTime.Parse("2015-01-01 00:00:00");
req.PubTimeTo = DateTime.Parse("2015-01-01 00:00:00");
AuctionGovAuctionsGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AuctionGovAuctionsGetRequest;
$req->setCatIds("123,456");
$req->setCourtCity("杭州市");
$req->setCourtName("北京市第二中级人民法院");
$req->setCourtProv("浙江");
$req->setCurrentPage("1");
$req->setItemCity("杭州");
$req->setItemProv("北京");
$req->setPageSize("20");
$req->setSort("0");
$req->setStatus("1,2");
$req->setStartTimeFrom("2015-01-01 00:00:00");
$req->setStartTimeTo("2015-01-01 00:00:00");
$req->setEndTimeFrom("2015-01-01 00:00:00");
$req->setEndTimeTo("2015-01-01 00:00:00");
$req->setKeyWords("房子");
$req->setPubTimeFrom("2015-01-01 00:00:00");
$req->setPubTimeTo("2015-01-01 00:00:00");
$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.gov.auctions.get' \
-d 'partner_id=apidoc' \
-d 'sign=838C654B12A59CA3FAA07436D330BA29' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-20+14%3A19%3A44' \
-d 'v=2.0' \
-d 'cat_ids=123%2C456' \
-d 'court_city=%E6%9D%AD%E5%B7%9E%E5%B8%82' \
-d 'court_name=%E5%8C%97%E4%BA%AC%E5%B8%82%E7%AC%AC%E4%BA%8C%E4%B8%AD%E7%BA%A7%E4%BA%BA%E6%B0%91%E6%B3%95%E9%99%A2' \
-d 'court_prov=%E6%B5%99%E6%B1%9F' \
-d 'current_page=1' \
-d 'end_time_from=2015-01-01+00%3A00%3A00' \
-d 'end_time_to=2015-01-01+00%3A00%3A00' \
-d 'item_city=%E6%9D%AD%E5%B7%9E' \
-d 'item_prov=%E5%8C%97%E4%BA%AC' \
-d 'key_words=%E6%88%BF%E5%AD%90' \
-d 'page_size=20' \
-d 'pub_time_from=2015-01-01+00%3A00%3A00' \
-d 'pub_time_to=2015-01-01+00%3A00%3A00' \
-d 'sort=0' \
-d 'start_time_from=2015-01-01+00%3A00%3A00' \
-d 'start_time_to=2015-01-01+00%3A00%3A00' \
-d 'status=1%2C2'

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

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

req.cat_ids="123,456"
req.court_city="杭州市"
req.court_name="北京市第二中级人民法院"
req.court_prov="浙江"
req.current_page=1
req.item_city="杭州"
req.item_prov="北京"
req.page_size=20
req.sort=0
req.status="1,2"
req.start_time_from="2015-01-01 00:00:00"
req.start_time_to="2015-01-01 00:00:00"
req.end_time_from="2015-01-01 00:00:00"
req.end_time_to="2015-01-01 00:00:00"
req.key_words="房子"
req.pub_time_from="2015-01-01 00:00:00"
req.pub_time_to="2015-01-01 00:00:00"
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.gov.auctions.get");
add_param(pRequest,"cat_ids","123,456");
add_param(pRequest,"court_city","杭州市");
add_param(pRequest,"court_name","北京市第二中级人民法院");
add_param(pRequest,"court_prov","浙江");
add_param(pRequest,"current_page","1");
add_param(pRequest,"item_city","杭州");
add_param(pRequest,"item_prov","北京");
add_param(pRequest,"page_size","20");
add_param(pRequest,"sort","0");
add_param(pRequest,"status","1,2");
add_param(pRequest,"start_time_from","2015-01-01 00:00:00");
add_param(pRequest,"start_time_to","2015-01-01 00:00:00");
add_param(pRequest,"end_time_from","2015-01-01 00:00:00");
add_param(pRequest,"end_time_to","2015-01-01 00:00:00");
add_param(pRequest,"key_words","房子");
add_param(pRequest,"pub_time_from","2015-01-01 00:00:00");
add_param(pRequest,"pub_time_to","2015-01-01 00:00:00");
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.gov.auctions.get', {
	'cat_ids':'123,456',
	'court_city':'杭州市',
	'court_name':'北京市第二中级人民法院',
	'court_prov':'浙江',
	'current_page':'1',
	'item_city':'杭州',
	'item_prov':'北京',
	'page_size':'20',
	'sort':'0',
	'status':'1,2',
	'start_time_from':'2015-01-01 00:00:00',
	'start_time_to':'2015-01-01 00:00:00',
	'end_time_from':'2015-01-01 00:00:00',
	'end_time_to':'2015-01-01 00:00:00',
	'key_words':'房子',
	'pub_time_from':'2015-01-01 00:00:00',
	'pub_time_to':'2015-01-01 00:00:00'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<auction_gov_auctions_get_response>
    <auctions>
        <auction_vo>
            <apply_count>2</apply_count>
            <auction_status>正在进行</auction_status>
            <bail>1.00</bail>
            <bid_count>3</bid_count>
            <cat_id>123</cat_id>
            <consult_price>11.00</consult_price>
            <court_name>北京市第二中级人民法院</court_name>
            <current_price>10.00</current_price>
            <end_time>1434517024485</end_time>
            <has_reserve>false</has_reserve>
            <item_id>1324344322</item_id>
            <now_time>1434517025000</now_time>
            <pic_url>img.alicdn.com/bao/uploaded/i1/TB1JvALHVXXXXXcXpXXyq.mFpXX</pic_url>
            <start_time>1434516024000</start_time>
            <starting_price>1.00</starting_price>
            <title>北京市海淀区马连洼竹园35号楼2单元2018号房产</title>
            <pv_count>123</pv_count>
        </auction_vo>
    </auctions>
    <total>10</total>
</auction_gov_auctions_get_response>

{
    "auction_gov_auctions_get_response":{
        "auctions":{
            "auction_vo":[
                {
                    "apply_count":2,
                    "auction_status":"正在进行",
                    "bail":"1.00",
                    "bid_count":3,
                    "cat_id":123,
                    "consult_price":"11.00",
                    "court_name":"北京市第二中级人民法院",
                    "current_price":"10.00",
                    "end_time":1434517024485,
                    "has_reserve":false,
                    "item_id":1324344322,
                    "now_time":1434517025000,
                    "pic_url":"img.alicdn.com\/bao\/uploaded\/i1\/TB1JvALHVXXXXXcXpXXyq.mFpXX",
                    "start_time":1434516024000,
                    "starting_price":"1.00",
                    "title":"北京市海淀区马连洼竹园35号楼2单元2018号房产",
                    "pv_count":123
                }
            ]
        },
        "total":10
    }
}

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

司法拍卖

taobao.auction.gov.auctions.get (分页获取标的物信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ