Tudou API v2 说明文档

概述

常规参数说明

apikey 必选。分发给合作方的ID,无效apikey将返回错误(详见状态码说明)
format 必选。指定返回格式(json、xml)。部分接口只支持json,详见个接口参数说明
fields 可选。指定所需返回的字段名,多个字段名之间逗号分隔,默认返回全字段(详见字段说明)

编码格式

所有输入参数和输出结果均为 UTF-8 编码

Http状态码

403 认证错误,检查apikey是否正确
405 版本错误,检查版本信息是否正确
415 格式错误,检查接口定义是否支持该格式(xml,json)
500 服务器错误

结果状态码

2000 结果正常
4048 参数错误,结果中包含错误原因说明
5000 其他错误

返回格式说明

  • 认证、版本、格式、服务器错误,将直接返回对应的Http状态码
  • json(分页):[内容状态码,[总页数,[{model1},{model2},...]]]
  • json(不分页):[内容状态码,[{model1},{model2},...]]
  • json(错误):[错误状态码,“原因说明”]
  • xml(多个):<models><model><field1>value1</field1>,<field1>value1</field1></model>...</models>
  • xml(单个):<model><field>value</field></model>
  • xml(错误):<error code="error-code">原因说明</error>

视频搜索查询

URL

http://api.tudou.com/v2/i/search?channelId=&inDays=&sort=&page=&kw=&format=&apikey=&fields=

说明

根据关键字和其他参数条件搜索视频

参数

参数名 取值 是否必选 说明
channelId 频道Id 必选 搜索指定频道中的视频(详见土豆频道信息接口)。

频道Id如:0、1、3、5、9、10、12、14、15、21、22、23、99

0表示所有频道

inDays 7、30、all 必选 搜索指定时间内发布的视频

7:一周内发布的。30:一月内发布的。all:不限时间

sort s、t、v、d 必选 指定排序方法

s:匹配度排序

t:发布时间排序

v:播放次数排序

d:节目时长排序

ttlevel 3、5、10、20 可选 视频时长过滤,默认返回全部

3:三分钟内的视频

5:五分钟内的视频

10:十分钟内的视频

20:二十分钟内的视频

media vi、au 可选 音、视频类型过滤,默认返回全部

vi:只返回视频节目

au:只返回音频节目

page 页码 必选 页码从1开始
kw 搜索关键字 必选 搜索关键字,须UTF8编码
format json 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID
fields 视频字段 可选 需要查询的视频字段(详见视频字段定义)。

示例

http://api.tudou.com/v2/i/search?channelId=0&sort=s&inDays=7&page=1&kw=jay&format=json&apikey=yourapikey

视频信息查询

URL

http://api.tudou.com/v2/i/info?ids=&format=&apikey=&fields=

说明

根据视频ID查询视频信息

参数

参数名 取值 是否必选 说明
ids 视频Id 必选 指定的视频ID,多个ID之间逗号分割
format json 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID
fields 视频字段 可选 需要查询的视频字段(详见视频字段定义)。

示例

http://api.tudou.com/v2/i/info?ids=768,10221&format=json&apikey=yourapikey

视频排行查询

URL

http://api.tudou.com/v2/i/rankingList?channelId=&inDays=&sort=&page=&format=&apikey=&fields=

说明

获取视频排行榜中的视频信息

参数

参数名 取值 是否必选 说明
channelId 频道Id 必选 搜索指定频道中的视频(详见土豆频道信息接口)。

频道Id如:0、1、3、5、9、10、12、14、15、21、22、23、99

0表示所有频道

inDays 3、7、30、all 必选 搜索指定时间内发布的视频

3: 最新发布的。7:一周内发布的。30:一月内发布的。all:不限时间

sort t、v、f、r、c、m、h 必选 指定排序方法

t:最新发布的

v:人气最旺的

f:收藏最多的

r:打分最高的

c:评论最狠的

m:土豆推荐的

h:清晰视频序

page 页码 必选 页码从1开始
format json 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID
fields 视频字段 可选 需要查询的视频字段(详见视频字段定义)。

示例

http://api.tudou.com/v2/i/rankingList?channelId=0&sort=v&inDays=7&page=1&format=json&apikey=yourapikey

用户视频查询

URL

http://api.tudou.com/v2/i/userItems?userName=&page=&format=&apikey=&fields=

说明

查询指定用户的视频信息

参数

参数名 取值 是否必选 说明
userName userName 必选 用户名
format json 必选 指定返回格式
page 页码 必选 页码从1开始
apikey apikey 必选 分发给合作方的ID
fields 视频字段 可选 需要查询的视频字段(详见视频字段定义)。

示例

http://api.tudou.com/v2/i/userItems?userName=gary&page=1&format=json&apikey=yourapikey

豆单视频查询

URL

http://api.tudou.com/v2/i/playlistItems?playlistId=&format=&apikey=&fields=

说明

查询指定豆单下的视频信息

参数

参数名 取值 是否必选 说明
playlistId playlistId 必选 豆单ID
format json 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID
fields 视频字段 可选 需要查询的视频字段(详见视频字段定义)。

示例

http://api.tudou.com/v2/i/playlistItems?playlistId=4&format=json&apikey=yourapikey

视频状态查询

URL

http://api.tudou.com/v2/i/status?status=&page=&format=&apikey=

说明

查询24小时内状态变化视频ID

参数

参数名 取值 是否必选 说明
status deleted、normal、unavailable 必选 deleted:最近24小时内被删除的视频ID

normal:最近24小时内处于状态正常的视频ID

unavailable:最近24小时内处于审查状态的视频ID

page 页码 必选 页码从1开始
format json 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID

示例

http://api.tudou.com/v2/i/status?status=deleted&page=1&format=json&apikey=yourapikey

视频播放次数查询

URL

http://api.tudou.com/v2/i/playtimes?ids=&format=&apikey=

说明

根据视频ID查询视频播放次数

参数

参数名 取值 是否必选 说明
ids 视频Id 必选 指定的视频ID,多个ID之间逗号分割
format json 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID

示例

http://api.tudou.com/v2/i/playtimes?ids=768,10221&format=json&apikey=yourapikey

豆单搜索查询

URL

http://api.tudou.com/v2/l/search?channelId=&inDays=&sort=&page=&kw=&format=&apikey=&fields=

说明

根据关键字和其他参数条件搜索豆单

参数

参数名 取值 是否必选 说明
channelId 频道Id 必选 搜索指定频道中的视频(详见土豆频道信息接口)。

频道Id如:0、1、3、5、9、10、12、14、15、21、22、23、99

0表示所有频道

inDays 7、30、all 必选 搜索指定时间内发布的视频

7:一周内发布的。30:一月内发布的。all:不限时间

sort s、t、v、n 必选 指定排序方法

s:匹配度排序

t:修改时间排序

v:播放总次数排序

n:视频数目排序

page 页码 必选 页码从1开始
kw 搜索关键字 必选 搜索关键字,须UTF8编码
format json 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID
fields 视频字段 可选 需要查询的豆单字段(详见豆单字段定义)。

示例

http://api.tudou.com/v2/l/search?channelId=0&sort=s&inDays=7&page=1&kw=jay&format=json&apikey=yourapikey

豆单信息查询

URL

http://api.tudou.com/v2/l/info?ids=&format=&apikey=&fields=

说明

根据豆单ID查询豆单信息

参数

参数名 取值 是否必选 说明
ids 豆单Id 必选 指定的豆单ID,多个ID之间逗号分割
format json 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID
fields 视频字段 可选 需要查询的豆单字段(详见豆单字段定义)。

示例

http://api.tudou.com/v2/l/info?ids=768,10221&format=json&apikey=yourapikey

豆单排行查询

URL

http://api.tudou.com/v2/l/rankingList?channelId=&inDays=&sort=&page=&format=&apikey=&fields=

说明

获取豆单排行榜中的豆单信息

参数

参数名 取值 是否必选 说明
channelId 频道Id 必选 搜索指定频道中的视频(详见土豆频道信息接口)。

频道Id如:0、1、3、5、9、10、12、14、15、21、22、23、99

0表示所有频道

inDays 3、7、30、all 必选 搜索指定时间内发布的视频

3: 最新发布的。7:一周内发布的。30:一月内发布的。all:不限时间

sort t、v、f、c 必选 指定排序方法

t:最近更新的

v:人气最旺的

f:订阅最多的

c:评论最狠的

注意:当sort=t,inDays=3有效,其他值无效

page 页码 必选 页码从1开始
format json 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID
fields 豆单字段 可选 需要查询的豆单字段(详见豆单字段定义)。

示例

http://api.tudou.com/v2/l/rankingList?channelId=0&sort=v&inDays=7&page=1&format=json&apikey=yourapikey

土豆频道定义查询

URL

http://api.tudou.com/v2/c/list?format=&apikey=

说明

查询土豆频道定义信息

参数

参数名 取值 是否必选 说明
format json、xml 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID

示例

http://api.tudou.com/v2/c/list?format=json&apikey=yourapikey

黑豆视频信息查询

URL

http://api.tudou.com/v2/hd/video?ids=&format=&apikey=&fields=

说明

根据黑豆视频ID查询视频信息

参数

参数名 取值 是否必选 说明
ids 视频Id 必选 指定的视频ID,多个ID之间逗号分割
format json 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID
fields 视频字段 可选 需要查询的黑豆视频字段(详见黑豆视频字段定义)。

示例

http://api.tudou.com/v2/hd/video?ids=768,10221&format=json&apikey=yourapikey

黑豆剧集信息查询

URL

http://api.tudou.com/v2/hd/album?ids=&format=&apikey=&fields=

说明

根据黑豆剧集ID查询剧集信息

参数

参数名 取值 是否必选 说明
ids 视频Id 必选 指定的剧集ID,多个ID之间逗号分割
format json 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID
fields 剧集字段 可选 需要查询的黑豆剧集字段(详见黑豆剧集字段定义)。

示例

http://api.tudou.com/v2/hd/album?ids=768,10221&format=json&apikey=yourapikey

分类剧集列表查询

URL

http://api.tudou.com/v2/hd/list?category=&format=&apikey=&fields=

说明

根据分类ID查询该分类下的黑豆剧集列表

参数

参数名 取值 是否必选 说明
category 分类Id 必选 指定的分类ID
format json 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID
page 页码 可选 页码从1开始
fields 剧集字段 可选 需要查询的黑豆剧集字段(详见黑豆剧集字段定义)。

示例

http://api.tudou.com/v2/hd/list?category=10101&format=json&apikey=yourapikey

黑豆热门视频查询

URL

http://api.tudou.com/v2/hd/hot?format=&apikey=&fields=

说明

查询黑豆热门视频列表

参数

参数名 取值 是否必选 说明
format json、xml 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID
fields 视频字段 可选 需要查询的黑豆视频字段(详见黑豆视频字段定义)。

示例

http://api.tudou.com/v2/hd/hot?format=json&apikey=yourapikey

黑豆推荐视频查询

URL

http://api.tudou.com/v2/hd/rec?format=&apikey=&fields=

说明

查询黑豆推荐视频列表

参数

参数名 取值 是否必选 说明
format json、xml 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID
fields 视频字段 可选 需要查询的黑豆视频字段(详见黑豆视频字段定义)。

示例

http://api.tudou.com/v2/hd/rec?format=json&apikey=yourapikey

黑豆正在看视频查询

URL

http://api.tudou.com/v2/hd/watching?format=&apikey=&fields=

说明

查询黑豆正在看的视频列表

参数

参数名 取值 是否必选 说明
format json、xml 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID
fields 视频字段 可选 需要查询的黑豆视频字段(详见黑豆视频字段定义)。

示例

http://api.tudou.com/v2/hd/watching?format=json&apikey=yourapikey

黑豆视频搜索查询

URL

http://api.tudou.com/v2/hd/search?kw=&page=&format=&fields=&apikey=

说明

根据关键字搜索黑豆视频

参数

参数名 取值 是否必选 说明
format json、xml 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID
kw 搜索关键字 必选 搜索关键字,须UTF8编码
page 页码 必选 页码从1开始
fields 视频字段 可选 需要查询的黑豆视频字段(详见黑豆视频字段定义)。

示例

http://api.tudou.com/v2/hd/search?kw=jay&page=1&format=xml&apikey=yourapikey

黑豆频道定义查询

URL

http://api.tudou.com/v2/hd/channel?format=&apikey=

说明

根据分类ID查询该分类下的黑豆剧集列表

参数

参数名 取值 是否必选 说明
format json 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID

示例

http://api.tudou.com/v2/hd/channel?format=json&apikey=yourapikey

黑豆分类定义查询

URL

http://api.tudou.com/v2/hd/category?format=&apikey=

说明

根据分类ID查询该分类下的黑豆剧集列表

参数

参数名 取值 是否必选 说明
format json 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID

示例

http://api.tudou.com/v2/hd/category?format=json&apikey=yourapikey

Mobile视频推荐列表

URL

http://api.tudou.com/v2/mobile/recommendItems?column=&format=&apikey=&fields=

说明

查询移动终端视频推荐列表

参数

参数名 取值 是否必选 说明
column wap、iphone 必选 指定终端类型
format json、xml 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID
fields 土豆视频字段 可选 需要查询的土豆视频字段(详见土豆视频字段定义)。

示例

http://api.tudou.com/v2/mobile/recommendItems?column=wap&format=json&apikey=yourapikey

按频道查询Mobile视频列表

URL

http://api.tudou.com/v2/mobile/channelItems?channel=&column=&page=&size=&format=&apikey=&fields=

说明

查询移动终端视频推荐列表

参数

参数名 取值 是否必选 说明
channel 频道Id 必选 搜索指定频道中的视频(详见土豆频道信息接口)。

频道Id如:0、1、3、5、9、10、12、14、15、21、22、23、99

0表示所有频道

column wap、iphone 必选 指定终端类型
page page 必选 页码(从1开始)
size size 必选 分页大小
format json、xml 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID
fields 土豆视频字段 可选 需要查询的土豆视频字段(详见土豆视频字段定义)。

示例

http://api.tudou.com/v2/mobile/channelItems?channel=99&column=iphone&page=1&size=20&format=xml&apikey=yourapikey

cdnV2代理

URL

http://api.tudou.com/v2/special/v2/cdn?id=&format=&apikey=

说明

V2 cdn代理

参数

参数名 取值 是否必选 说明
id id 必选 土豆节目ID
format xml 必选 指定返回格式
apikey apikey 必选 分发给合作方的ID

示例

http://api.tudou.com/v2/special/v2/cdn?id=789&format=xml&apikey=yourapikey

字段定义

土豆节目字段

字段名 说明
id 节目id
code 节目code
title 节目标题
totalTime 节目时长
ownerId 播客id
ownerName 播客名
ownerNickname 博客昵称
picUrl 视频截图
description 视频描述(前100字)
channel 所属频道ID
tags 视频标签(多个标签之间逗号分隔)
pubDate 发布时间
outerPlayerUrl 站外播放器Url
itemUrl 站内视频播放页面
mediaType 媒体类型:(au:音频、vi:视频)

土豆豆单字段

字段名 说明
id 豆单id
title 豆单标题
description 豆单简介(前100字)
createDate 创建时间
modifiedDate 编辑时间
ownerName 所有者Name
ownerNickname 所有者nickname
tags 标签(多个标签之间逗号分隔)
channel 所属频道
descriptionUrl 豆单简介Url
outerPlayerUrl 站外播放器地址
playlistUrl 站内播放地址
itemCount 节目个数
subCount 订阅个数
playCount 播放总数

土豆分类定义信息字段

字段名 说明
channelId 频道ID
channelName 频道名称
description 频道描述

黑豆节目字段

字段名 说明
id 节目Id
itemId 对应的土豆视频Id
title 节目标题
albumTitle 所在剧集标题
albumId 所在剧集Id
channel 频道
category 分类
picUrl 截图
totalTime 节目时长
playTimes 播放次数
outerPlayerUrl 站外播放器URL
videoUrl 节目播放页URL
compere 主持人
honoredGuest 嘉宾
showYear 上映年份
summary 简介

黑豆剧集字段

字段名 说明
albumId 剧集Id
albumTitle 剧集标题
videoCount 该剧集中的节目数
videos 节目列表(节目详细信息,具体说明见黑豆节目字段定义)
summary 剧集描述
directors 导演
playactors 演员
region 上映地区
channel 频道
category 分类
showDate 上映时间
tag 标签

黑豆频道定义信息字段

字段名 说明
channelId 频道ID
channelName 频道名称
description 频道描述
subCategorys 该频道下的分类

黑豆分类定义信息字段

字段名 说明
categoryId 分类ID
categroyName 分类名称
description 分类描述