淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
fields	String []	必须	nick,type,sex,location	最大列表长度：999	需返回的字段列表，可选值为返回值中看得到的所有字段。
nick	String	可选	helloworld		用户昵称，session和nick必须传其中一个（其中nick优先），传入nick只能获取用户公开信息，传入session可以获取用户隐私信息
top_mix_params	String	可选	nick		指定哪个入参是混淆入参

名称	类型	示例值	描述
user	User		用户
└ user_id Number 10001 用户数字ID └ uid String 1001 用户字符串ID └ nick String hz0799 用户昵称 └ sex String m 性别。可选值:m(男),f(女) buyer_credit UserCredit 买家信用 └ level Number 1 信用等级（是根据score生成的），信用等级：淘宝会员在淘宝网上的信用度，分为20个级别，级别如：level = 1 时，表示一心；level = 2 时，表示二心 └ score Number 1 信用总分（“好评”加一分，“中评”不加分，“差评”扣一分。分越高，等级越高） └ total_num Number 1 收到的评价总条数。取值范围:大于零的整数 └ good_num Number 1 收到的好评总条数。取值范围:大于零的整数 seller_credit UserCredit 卖家信用 └ level Number 1 信用等级（是根据score生成的），信用等级：淘宝会员在淘宝网上的信用度，分为20个级别，级别如：level = 1 时，表示一心；level = 2 时，表示二心 └ score Number 1 信用总分（“好评”加一分，“中评”不加分，“差评”扣一分。分越高，等级越高） └ total_num Number 1 收到的评价总条数。取值范围:大于零的整数 └ good_num Number 1 收到的好评总条数。取值范围:大于零的整数 location Location 用户当前居住地公开信息。如：location.city获取其中的city数据 └ zip String 310000 邮政编码 └ city String 杭州所在城市（中文名称） └ state String 浙江所在省份（中文名称） └ country String 中国国家名称 └ district String 西湖区区/县（只适用于物流API） └ created Date 2000-01-01 00:00:00 用户注册时间。格式:yyyy-MM-dd HH:mm:ss └ last_visit Date 2000-01-01 00:00:00 最近登陆时间。格式:yyyy-MM-dd HH:mm:ss └ birthday Date 2000-01-01 00:00:00 生日 └ type String B 用户类型。可选值:B(B商家),C(C商家) └ has_more_pic Boolean true 是否购买多图服务。可选值:true(是),false(否) └ item_img_num Number 5 可上传商品图片数量 └ item_img_size Number 1024 单张商品图片最大容量(商品主图大小)。单位:k └ prop_img_num Number 5 可上传属性图片数量 └ prop_img_size Number 1024 单张销售属性图片最大容量（非主图的商品图片和商品属性图片）。单位:k └ auto_repost String unlimited 是否受限制。可选值:limited(受限制),unlimited(不受限) └ promoted_type String authentication 有无实名认证。可选值:authentication(实名认证),not authentication(没有认证) └ status String normal 状态。可选值:normal(正常),inactive(未激活),delete(删除),reeze(冻结),supervise(监管) └ alipay_bind String bind 有无绑定。可选值:bind(绑定),notbind(未绑定) └ consumer_protection Boolean true 是否参加消保 └ sign_consumer_protection Boolean true 用户是否签署消保协议（因为加入基本消保的用户未必签署了消保协议） └ vip_info String v1 用户的全站vip信息，可取值如下：c(普通会员),asso_vip(荣誉会员)，vip1,vip2,vip3,vip4,vip5,vip6(六个等级的正式vip会员)，共8种取值，其中asso_vip是由vip会员衰退而成，与主站上的vip0对应。 └ alipay_account String hz0799@163.com 支付宝账户 └ alipay_no String 10001 支付宝ID └ magazine_subscribe Boolean true 是否订阅了淘宝天下杂志 └ vertical_market String 3C,shoes 用户参与垂直市场类型。shoes表示鞋城垂直市场用户，3C表示3C垂直市场用户。多个类型之间用","分隔。如：一个用户既是3C用户又是鞋城用户，那么这个字段返回就是"3C,shoes"。如果用户不是垂直市场用户，此字段返回为""。 └ email String xiaoming@taobao.com 联系人email └ manage_book Boolean true 是否可以经营图书，true or false └ avatar String http://assets.taobaocdn.com/app/sns/img/default/avatar-120.png 用户头像地址 └ online_gaming Boolean true 用户是否为网游用户，属于隐私信息，需要登陆才能查看自己的。目前仅供taobao.user.get使用 └ liangpin Boolean true 是否是无名良品用户，true or false └ sign_food_seller_promise Boolean true 卖家是否签署食品卖家承诺协议 └ has_shop Boolean true 用户作为卖家是否开过店 └ is_lightning_consignment Boolean true 是否24小时闪电发货(实物类) └ has_sub_stock Boolean true 表示用户是否具备修改商品减库存逻辑的权限（一共有拍下减库存和付款减库存两种逻辑）值含义： 1）true：是 2）false：否。 └ is_golden_seller Boolean true 用户是否是金牌卖家 └ vip_level Number 0 用户等级身份：20 apass；10 超级会员；0 普通会员 └ open_uid String AAHULelzAF5F4XkqJWwAhq84 用户openId

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UserGetRequest req = new UserGetRequest();
req.setFields("nick,type,sex,location");
req.setNick("helloworld");
req.setTopMixParams("nick");
UserGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
UserGetRequest req = new UserGetRequest();
req.Fields = "nick,type,sex,location";
req.Nick = "helloworld";
req.TopMixParams = "nick";
UserGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UserGetRequest;
$req->setFields("nick,type,sex,location");
$req->setNick("helloworld");
$req->setTopMixParams("nick");
$resp = $c->execute($req, $sessionKey);

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.user.get' \
-d 'partner_id=apidoc' \
-d 'session=dba4f6bc-96b8-4e8d-a7ef-c58e5ff29ee7' \
-d 'sign=9E477984F6556EEBA179BC59FFABB04C' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-02-21+07%3A41%3A54' \
-d 'v=2.0' \
-d 'fields=nick%2Ctype%2Csex%2Clocation' \
-d 'nick=helloworld' \
-d 'top_mix_params=nick'

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

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

req.fields="nick,type,sex,location"
req.nick="helloworld"
req.top_mix_params="nick"
try:
	resp= req.getResponse(sessionkey)
	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.user.get");
add_param(pRequest,"fields","nick,type,sex,location");
add_param(pRequest,"nick","helloworld");
add_param(pRequest,"top_mix_params","nick");
pResponse = top_execute(pClient,pRequest,sessionKey);
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.user.get', {
	'fields':'nick,type,sex,location',
	'nick':'helloworld',
	'top_mix_params':'nick'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<user_get_response>
    <user>
        <user_id>10001</user_id>
        <uid>1001</uid>
        <nick>hz0799</nick>
        <sex>m</sex>
        <buyer_credit>
            <level>1</level>
            <score>1</score>
            <total_num>1</total_num>
            <good_num>1</good_num>
        </buyer_credit>
        <seller_credit>
            <level>1</level>
            <score>1</score>
            <total_num>1</total_num>
            <good_num>1</good_num>
        </seller_credit>
        <location>
            <zip>310000</zip>
            <city>杭州</city>
            <state>浙江</state>
            <country>中国</country>
            <district>西湖区</district>
        </location>
        <created>2000-01-01 00:00:00</created>
        <last_visit>2000-01-01 00:00:00</last_visit>
        <birthday>2000-01-01 00:00:00</birthday>
        <type>B</type>
        <has_more_pic>true</has_more_pic>
        <item_img_num>5</item_img_num>
        <item_img_size>1024</item_img_size>
        <prop_img_num>5</prop_img_num>
        <prop_img_size>1024</prop_img_size>
        <auto_repost>unlimited</auto_repost>
        <promoted_type>authentication</promoted_type>
        <status>normal</status>
        <alipay_bind>bind</alipay_bind>
        <consumer_protection>true</consumer_protection>
        <sign_consumer_protection>true</sign_consumer_protection>
        <vip_info>v1</vip_info>
        <alipay_account>hz0799@163.com</alipay_account>
        <alipay_no>10001</alipay_no>
        <magazine_subscribe>true</magazine_subscribe>
        <vertical_market>3C,shoes</vertical_market>
        <email>xiaoming@taobao.com</email>
        <manage_book>true</manage_book>
        <avatar>http://assets.taobaocdn.com/app/sns/img/default/avatar-120.png</avatar>
        <online_gaming>true</online_gaming>
        <liangpin>true</liangpin>
        <sign_food_seller_promise>true</sign_food_seller_promise>
        <has_shop>true</has_shop>
        <is_lightning_consignment>true</is_lightning_consignment>
        <has_sub_stock>true</has_sub_stock>
        <is_golden_seller>true</is_golden_seller>
        <vip_level>0</vip_level>
        <open_uid>AAHULelzAF5F4XkqJWwAhq84</open_uid>
    </user>
</user_get_response>

{
    "user_get_response":{
        "user":{
            "user_id":10001,
            "uid":"1001",
            "nick":"hz0799",
            "sex":"m",
            "buyer_credit":{
                "level":1,
                "score":1,
                "total_num":1,
                "good_num":1
            },
            "seller_credit":{
                "level":1,
                "score":1,
                "total_num":1,
                "good_num":1
            },
            "location":{
                "zip":"310000",
                "city":"杭州",
                "state":"浙江",
                "country":"中国",
                "district":"西湖区"
            },
            "created":"2000-01-01 00:00:00",
            "last_visit":"2000-01-01 00:00:00",
            "birthday":"2000-01-01 00:00:00",
            "type":"B",
            "has_more_pic":true,
            "item_img_num":5,
            "item_img_size":1024,
            "prop_img_num":5,
            "prop_img_size":1024,
            "auto_repost":"unlimited",
            "promoted_type":"authentication",
            "status":"normal",
            "alipay_bind":"bind",
            "consumer_protection":true,
            "sign_consumer_protection":true,
            "vip_info":"v1",
            "alipay_account":"hz0799@163.com",
            "alipay_no":"10001",
            "magazine_subscribe":true,
            "vertical_market":"3C,shoes",
            "email":"xiaoming@taobao.com",
            "manage_book":true,
            "avatar":"http:\/\/assets.taobaocdn.com\/app\/sns\/img\/default\/avatar-120.png",
            "online_gaming":true,
            "liangpin":true,
            "sign_food_seller_promise":true,
            "has_shop":true,
            "is_lightning_consignment":true,
            "has_sub_stock":true,
            "is_golden_seller":true,
            "vip_level":0,
            "open_uid":"AAHULelzAF5F4XkqJWwAhq84"
        }
    }
}

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"
	}
}

错误码	错误描述	解决方案
isv.user-not-exist:invalid-nick	传入的nick不存在	发生错误不要重试,清除本地数据库该用户资料，或者使用其他接口（如：taobao.item.get）来更新用户资料
isv.missing-parameter:nick-or-session	用户没有传入系统参数session也没有传入nick	传入nick或者session
错误码：40，子错误码：null	缺少必要的传入参数
isv.user-not-exist:invalid-nick:UIC service flow controlled	12	2

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

开放平台

测试类目树

taobao.user.get (获取单个用户信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ