API 文档

BASE URLhttps://redfox.hk

暂无可用的 API 平台

搜索关键词获取小红书作品 (优质库)

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

文章信息

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

POSThttps://redfox.hk/story/api/xhsUser/searchArticle

API 密钥获取与配置

获取密钥

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

获取步骤

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

API说明

Method：POST

Host：https://redfox.hk

Path：/story/api/xhsUser/searchArticle

请求头

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

请求参数

参数	类型	必填	说明	示例
keyword	String	是	关键词	美食
offset	Integer	否	偏移量，从0开始，每页+20	0
sortType	String	否	排序方式： _0: 默认（相关性排序）_2: 最新（按发布时间排序）_4: 最热（按互动数排序）	_0
exactMatch	Boolean	否	是否精准匹配（默认false） * false: 模糊匹配，关键词分词后部分匹配即可召回 * true: 精准匹配，关键词作为完整短语必须包含在文章标题、摘要或作者中	false

返回值与结构

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

响应字段

字段	类型	说明	示例
code	Integer	状态码（2000=成功）	2000
msg	String	提示信息	成功
data	Object	返回数据
hasMore	Integer	hasMore	true
list	Array	数据列表
accountNickname	String	作者昵称	大白萝不怪
accountType	String	account类型	100
accountUserid	String	作者小红书id	565b17dc0bf90c754d6615b4
coverUrl	String	图片地址	https://sns-i10.rednotecdn.com/notes_pre_post/1040g3k031k6lpmg43q2043gri3bto5dk2u1p6eg?imageView2/2/w/576/format/webp/q/87%7CimageMogr2/strip&redImage/frame/0&ap=1&sc=PREVIEW&sign=b670a0755ba8943337e700df1b2f702d&t=6a05685d&src=A
workCollectedCount	Integer	收藏数	175
workCommentsCount	Integer	评论数	45
workDesc	String	作品内容	做了十多年建筑设计标准化设计是硬性要求\n难得自己当甲方不想把设计模版套在自己的家\n自己的房子总算能随心所欲\n家里的布置随着时间调整越住越舒适~\n以舒适健康为居是我们理想中高智感的家\n\t\n特别满意我的开放式厨房洗切炒一气呵成\n要说不满意就是用水问题\n武汉自来水氯味重得吓人\n做饭都闻到异味污染事件更是频发\n拖了很久决定装净水器\n闺蜜家装的RO反渗透净水器虽然过滤效果好\n但每次制水要产生大量废水\n在业主群里咨询
workId	String	作品id	687df3a1000000000d0184a4
workLikedCount	Integer	点赞数	210
workPublishTime	String	发布时间	2025-07-21 17:09:42
workSharedCount	Integer	转发数	28
workTitle	String	作品标题	建筑师的选择｜厨下净水器终于装好了！
workType	String	分类（视频/图文）	主要描述：视频 or 图文等 {"normal": "normal", "video": "video"}
workUrl	String	作品链接	https://www.xiaohongshu.com/explore/687df3a1000000000d0184a4
total	Long	总数	100

请求示例

curl -X POST "https://redfox.hk/story/api/xhsUser/searchArticle"
  -H "Content-Type: application/json"
  -H "REDFOX_API_KEY: your_api_key"
  -d '{"keyword": "示例关键词", "offset": 0, "sortType": "_0"}'

响应示例

{
  "code": 2000,
  "msg": "成功",
  "data": {
    "total": 100,
    "hasMore": true,
    "list": [
      "workId": "687df3a1000000000d0184a4",
      "workTitle": "建筑师的选择｜厨下净水器终于装好了！",
      "workDesc": "做了十多年建筑设计 标准化设计是硬性要求\n难得自己当甲方 不想把设计模版套在自己的家\n自己的房子总算能随心所欲\n家里的布置随着时间调整 越住越舒适~\n以舒适健康为居 是我们理想中高智感的家\n\t\n特别满意我的开放式厨房 洗切炒一气呵成\n要说不满意 就是用水问题\n武汉自来水氯味重得吓人\n做饭都闻到异味 污染事件更是频发\n拖了很久决定装净水器\n闺蜜家装的RO反渗透净水器虽然过滤效果好\n但每次制水要产生大量废水\n在业主群里咨询",
      "coverUrl": "https://sns-i10.rednotecdn.com/notes_pre_post/1040g3k031k6lpmg43q2043gri3bto5dk2u1p6eg?imageView2/2/w/576/format/webp/q/87%7CimageMogr2/strip&redImage/frame/0&ap=1&sc=PREVIEW&sign=b670a0755ba8943337e700df1b2f702d&t=6a05685d&src=A",
      "workUrl": "https://www.xiaohongshu.com/explore/687df3a1000000000d0184a4",
      "workPublishTime": "2025-07-21 17:09:42",
      "accountNickname": "大白萝不怪",
      "accountUserid": "565b17dc0bf90c754d6615b4",
      "workLikedCount": 210,
      "workCommentsCount": 45,
      "workCollectedCount": 175,
      "workReadedCount": 980,
      "workSharedCount": 28,
      "workType": "主要描述：视频 or 图文 等 {"normal": "normal", "video": "video"}",
      "accountType": "100"
    ]
  }
}

常见状态码说明

调用接口时，响应体中的 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/xhsUser/searchArticle" \
  -H "REDFOX_API_KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "keyword": "美食",
  "offset": 0,
  "sortType": "_0",
  "exactMatch": false
}'

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

json

{
  "code": 2000,
  "msg": "成功",
  "data": {
    "total": 100,
    "hasMore": true,
    "list": [
      "workId": "687df3a1000000000d0184a4",
      "workTitle": "建筑师的选择｜厨下净水器终于装好了！",
      "workDesc": "做了十多年建筑设计 标准化设计是硬性要求\n难得自己当甲方 不想把设计模版套在自己的家\n自己的房子总算能随心所欲\n家里的布置随着时间调整 越住越舒适~\n以舒适健康为居 是我们理想中高智感的家\n\t\n特别满意我的开放式厨房 洗切炒一气呵成\n要说不满意 就是用水问题\n武汉自来水氯味重得吓人\n做饭都闻到异味 污染事件更是频发\n拖了很久决定装净水器\n闺蜜家装的RO反渗透净水器虽然过滤效果好\n但每次制水要产生大量废水\n在业主群里咨询",
      "coverUrl": "https://sns-i10.rednotecdn.com/notes_pre_post/1040g3k031k6lpmg43q2043gri3bto5dk2u1p6eg?imageView2/2/w/576/format/webp/q/87%7CimageMogr2/strip&redImage/frame/0&ap=1&sc=PREVIEW&sign=b670a0755ba8943337e700df1b2f702d&t=6a05685d&src=A",
      "workUrl": "https://www.xiaohongshu.com/explore/687df3a1000000000d0184a4",
      "workPublishTime": "2025-07-21 17:09:42",
      "accountNickname": "大白萝不怪",
      "accountUserid": "565b17dc0bf90c754d6615b4",
      "workLikedCount": 210,
      "workCommentsCount": 45,
      "workCollectedCount": 175,
      "workReadedCount": 980,
      "workSharedCount": 28,
      "workType": "主要描述：视频 or 图文 等 {"normal": "normal", "video": "video"}",
      "accountType": "100"
    ]
  }
}