虎牙开放平台文档

开放API 协议说明

1.根据房间号获取主播基础信息

GET https://open-apiext.huya.com/api/getStreamerInfo?appId=xxx&roomId=xxx&iat=xxx&exp=xxx&sToken=xxx

1.1.接口参数

参数名称	类型	描述
appId	string	开发者的appId
roomId	int	房间号
iat	int	jwt签发时间（unix时间戳），即生成sToken的当前unix时间戳
exp	int	jwt过期时间（unix时间戳），通常exp=iat+600，注意不少于当前时间且不超过当前时间60分钟
sToken	string	jwt鉴权生成的token

1.2.返回（JSON）

返回字段

字段名称	类型	描述
code	int	参考下面的接口返回码
message	string	消息提示
data["streamerNick"]	string	主播昵称
data["streamerAvatarUrl"]	string	主播头像地址
data["streamerRoomId"]	string	房间Id
data["streamerLevel"]	string	主播等级
data["streamerUnionId"]	string	主播unionId

接口返回码

返回码	描述
200	成功
407	鉴权失败
500	查不到对应信息
其他	失败

1.3.调用例子

curl "https://open-apiext.huya.com/api/getStreamerInfo?roomId=10011857&appId=xxxxxxxxxxxx&iat=1695205311&exp=1695208857&sToken=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHBJZCI6ImI5YjI4NWY3ZDkxMTM1NTgiLCJleHAiOjE2OTUyMDg4NTcsImlhdCI6MTY5NTIwNTMxMX0.ZDe2XSyzpeSwwob5YNLhBtNahXHEMhP1zp1YarG3-vE"

1.4.接口返回JSON

成功返回

{
    "code": 200,
    "message": "success",
    "data": {
        "streamerNick": "测试直播间",
        "streamerAvatarUrl": "https://huyaimg.msstatic.com/avatar/1057/1e/d8ab535bcaf54ad16170c95b4dd6b5_180_135.jpg",
        "streamerRoomId": "10011857",
        "streamerLevel": "23",
        "streamerUnionId": "unl1DuHDCjUZVVI9Vyqbd9to0KBfD5T123"
    }
}

失败返回

{
    "code": 602,
    "message": "无该房间号对应的主播信息！",
    "data": null
}

开放API