API 文档

BASE URLhttps://redfox.hk

暂无可用的 API 平台

快手账号搜索（广域库）

广域库T+1最低 ¥0.02/次起即将上线需配置 API Key

功能说明：通过快手账号名称（profile.userName）模糊包含匹配搜索账号，支持分页请求参数示例： { "accountName": "人民日报", // 快手账号名称（模糊搜索关键词，必填） "page": 1, // 页码，从1开始（可选，默认1） "pageSize": 20 // 每页条数（可选，默认20，最大50） } 返回数据字段： - total: 搜索结果总数 - page: 当前页码 - pageSize: 每页条数 - list: 搜索结果列表 - nickname: 账号昵称 - kwaiId: 账号平台展示id（用于queryWorkList接口查询作品） - signature: 账号简介 - headUrl: 头像URL - coverImgUrl: 背景图URL

单价随接口累计调用量阶梯调整

POSThttps://redfox.hk/story/api/ksAllData/searchUser

API 密钥获取与配置

获取密钥

调用 API 前，请先在控制台生成 API 密钥并完成配置。在 HTTP 请求头中添加API Key 字段，密钥用于身份校验与额度计费。

获取步骤

前往控制台页面，进入 API 密钥管理模块。
若无已生成的密钥，点击生成新密钥，复制并妥善保存密钥。
在请求头中添加 REDFOX_API_KEY或X-API-KEY字段并填入密钥后即可调用。

API说明

Method：POST

Host：https://redfox.hk

Path：/story/api/ksAllData/searchUser

请求头

名称	类型	必填	说明	示例
REDFOX_API_KEY	string	是	平台鉴权令牌，每次请求必填	ak_xxxxxx
Content-Type	string	是	请求体数据类型	application/json

请求参数

参数	类型	必填	说明	示例
accountName	String	是	快手账号名称（模糊搜索关键词，必填）	人民日报
page	Integer	是	页码，从1开始（可选，默认1）	1
pageSize	Integer	是	每页条数（可选，默认20，最大50）	20

返回值与结构

统一包装一般为 `code`、`message`/`msg`、`data`（以实际服务为准）。

响应字段

字段	类型	说明	示例
code	Integer	响应码	2000
msg	String	响应消息	成功
data	Object
list	Array	搜索结果列表
coverImgUrl	String	背景图URL	http://p23.a.yximgs.com/uhead/AC/2022/12/07/19/BMjAyMjEyMDcxOTEyMzFfMTA5NjYzNzQwMV8wX2Jn.jpg
headUrl	String	头像URL	http://p23.a.yximgs.com/uhead/AB/2022/12/07/19/BMjAyMjEyMDcxOTEyMzFfMTA5NjYzNzQwMV8yX2hkMjU1Xzc4OQ==_b.jpg
kwaiId	String	账号平台展示id	rmrbxmtzx
nickname	String	账号昵称	人民日报
signature	String	账号简介	参与、沟通、记录时代。
page	Integer	当前页码	1
pageSize	Integer	每页条数	10
total	Integer	搜索结果总数	4

请求示例

请求参数：
{
  "accountName": "人民日报",
  "page": 1,
  "pageSize": 20
}

响应示例

{
  "code": 2000,
  "data": {
    "list": [
      {
        "coverImgUrl": "http://p23.a.yximgs.com/uhead/AC/2022/12/07/19/BMjAyMjEyMDcxOTEyMzFfMTA5NjYzNzQwMV8wX2Jn.jpg",
        "headUrl": "http://p23.a.yximgs.com/uhead/AB/2022/12/07/19/BMjAyMjEyMDcxOTEyMzFfMTA5NjYzNzQwMV8yX2hkMjU1Xzc4OQ==_b.jpg",
        "kwaiId": "rmrbxmtzx",
        "nickname": "人民日报",
        "signature": "参与、沟通、记录时代。"
      },
      {
        "coverImgUrl": "https://p66-pro.a.yximgs.com/uhead/AC/2022/12/08/04/BMjAyMjEyMDgwNDA4MjhfMTU0NjM4MjgzMl8wX2Jn.jpg",
        "headUrl": "https://p66-pro.a.yximgs.com/uhead/AB/2022/12/08/04/BMjAyMjEyMDgwNDA4MjhfMTU0NjM4MjgzMl8yX2hkMTg3XzEwMg==_s.jpg",
        "kwaiId": "lingshichapd",
        "nickname": "人民日报国际",
        "signature": "敬请关注“人民日报国际”快手、vx公号：rmrbgjbd，精彩世界不容错过。投稿邮箱lingshichapd@163.com。"
      },
      {
        "coverImgUrl": "http://p4.a.yximgs.com/uhead/AC/2024/10/28/11/BMjAyNDEwMjgxMTAwMTBfMTM5NTM3MjU0N18wX2Jn.jpg",
        "headUrl": "http://p4.a.yximgs.com/uhead/AB/2024/05/09/10/BMjAyNDA1MDkxMDA4MThfMTM5NTM3MjU0N18yX2hkNjhfMTU3_b.jpg",
        "kwaiId": null,
        "nickname": "人民日报健康客户端",
        "signature": "《健康时报》社有限责任公司官方账号。面向全网征集医生、医院、就医等视频素材，人民日报健康客户端、健康时报全媒体平台等你来拍！"
      },
      {
        "coverImgUrl": "https://p2-pro.a.yximgs.com/uhead/AC/2023/10/11/14/BMjAyMzEwMTExNDMwNTJfMjY5Nzk5NjI4M18wX2Jn.jpg",
        "headUrl": "https://p2-pro.a.yximgs.com/uhead/AB/2023/10/12/10/BMjAyMzEwMTIxMDA1MTNfMjY5Nzk5NjI4M18yX2hkMTkzXzUwNw==_s.jpg",
        "kwaiId": null,
        "nickname": "人民日报出版社",
        "signature": "坚持出版治国理政图书\n坚持出版文化传承图书\n坚持出版读者枕边图书"
      }
    ],
    "page": 1,
    "pageSize": 10,
    "total": 4
  },
  "msg": "成功"
}

常见状态码说明

调用接口时，响应体中的 code 字段对应以下状态码。完整列表请查看 API 状态码说明页。

状态码	说明	排查建议
`400`	请求参数错误	检查请求体、Query 参数是否与文档一致，必填项是否齐全。
`401`	鉴权失败	确认请求头已添加 REDFOX_API_KEY 或 X-API-KEY，且密钥有效、未禁用。
`403`	无权限访问	当前密钥或账号无权调用该接口，请检查密钥状态与接口权限。
`500`	系统内部错误	服务端异常，请稍后重试；持续出现请联系技术支持。
`503`	服务暂不可用	服务维护或短暂过载，请间隔一段时间后重试。
`1001`	缺少必要参数	对照「请求参数」表，补全必填字段。
`1002`	参数格式不正确	检查字段类型与格式（如 URL、日期、枚举值）是否符合说明。
`1003`	参数类型错误	确认 JSON 中数字、字符串、布尔等类型与文档定义一致。
`3103`	密钥不存在	密钥可能已删除或填写错误，请前往控制台核对并重新复制。
`3105`	API Key 已禁用	在控制台启用该密钥，或创建新密钥后替换请求头中的值。
`3201`	积分不足	账户余额不足以支付本次调用，请前往控制台充值后再试。
`3202`	积分账户不存在	账号积分账户异常，请登录控制台确认账户状态。
`4004`	操作过于频繁，请稍后再试	触发频率限制，降低请求频率或增加调用间隔后重试。

调用步骤

在请求头配置REDFOX_API_KEY或X-API-KEY
按 API 说明示例构造请求参数或请求体。
发起请求。
解析 JSON 响应中的 code、message 与 data 字段。

Request（示例代码，仅供参考）

bash

curl -X POST "https://redfox.hk/story/api/ksAllData/searchUser" \
  -H "REDFOX_API_KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "accountName": "人民日报",
  "page": 1,
  "pageSize": 20
}'

Response（示例代码，仅供参考）

json

{
  "code": 2000,
  "data": {
    "list": [
      {
        "coverImgUrl": "http://p23.a.yximgs.com/uhead/AC/2022/12/07/19/BMjAyMjEyMDcxOTEyMzFfMTA5NjYzNzQwMV8wX2Jn.jpg",
        "headUrl": "http://p23.a.yximgs.com/uhead/AB/2022/12/07/19/BMjAyMjEyMDcxOTEyMzFfMTA5NjYzNzQwMV8yX2hkMjU1Xzc4OQ==_b.jpg",
        "kwaiId": "rmrbxmtzx",
        "nickname": "人民日报",
        "signature": "参与、沟通、记录时代。"
      },
      {
        "coverImgUrl": "https://p66-pro.a.yximgs.com/uhead/AC/2022/12/08/04/BMjAyMjEyMDgwNDA4MjhfMTU0NjM4MjgzMl8wX2Jn.jpg",
        "headUrl": "https://p66-pro.a.yximgs.com/uhead/AB/2022/12/08/04/BMjAyMjEyMDgwNDA4MjhfMTU0NjM4MjgzMl8yX2hkMTg3XzEwMg==_s.jpg",
        "kwaiId": "lingshichapd",
        "nickname": "人民日报国际",
        "signature": "敬请关注“人民日报国际”快手、vx公号：rmrbgjbd，精彩世界不容错过。投稿邮箱lingshichapd@163.com。"
      },
      {
        "coverImgUrl": "http://p4.a.yximgs.com/uhead/AC/2024/10/28/11/BMjAyNDEwMjgxMTAwMTBfMTM5NTM3MjU0N18wX2Jn.jpg",
        "headUrl": "http://p4.a.yximgs.com/uhead/AB/2024/05/09/10/BMjAyNDA1MDkxMDA4MThfMTM5NTM3MjU0N18yX2hkNjhfMTU3_b.jpg",
        "kwaiId": null,
        "nickname": "人民日报健康客户端",
        "signature": "《健康时报》社有限责任公司官方账号。面向全网征集医生、医院、就医等视频素材，人民日报健康客户端、健康时报全媒体平台等你来拍！"
      },
      {
        "coverImgUrl": "https://p2-pro.a.yximgs.com/uhead/AC/2023/10/11/14/BMjAyMzEwMTExNDMwNTJfMjY5Nzk5NjI4M18wX2Jn.jpg",
        "headUrl": "https://p2-pro.a.yximgs.com/uhead/AB/2023/10/12/10/BMjAyMzEwMTIxMDA1MTNfMjY5Nzk5NjI4M18yX2hkMTkzXzUwNw==_s.jpg",
        "kwaiId": null,
        "nickname": "人民日报出版社",
        "signature": "坚持出版治国理政图书\n坚持出版文化传承图书\n坚持出版读者枕边图书"
      }
    ],
    "page": 1,
    "pageSize": 10,
    "total": 4
  },
  "msg": "成功"
}