搜索建议 API
按中文关键词获取小红书搜索框的建议词,可用游标翻页。每条只返回建议词,不是笔记正文。
按关键词取小红书搜索建议。用 cursor 翻页。每条只有 word。关键词用中文更容易出词条。
建议词不是笔记。笔记仍走笔记搜索。
请求地址 POST https://www.xmedi.cn/api/v1/xhs/search/suggestions。调用成功才扣费,参数错误、平台侧失败或超时不扣费。
成功响应的 meta 含数据血缘,说明见 鉴权与计费。
适用场景
- 扩词:输入产品名,收集用户会接着搜的词。
- 选题:把建议词交给编辑,而不是直接当笔记标题。
- 纠错:错别字先过一遍建议,再搜笔记。
请求参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
cursor |
string | 否 | 翻页游标,取上一页 next_cursor;首页留空。 |
keyword |
string | 是 | 搜索关键词。必填。 |
返回 data 字段
| 字段 | 类型 | 说明 |
|---|---|---|
has_more | boolean | 是否还有下一页。为 false 时停止翻页。 |
items | array<object> | 建议词列表。每条只有 word。 |
page | number | 页码,从 1 起。只认游标的接口里它是回显,改它不会换页。 |
page_size | number | 本页条数。平台不按请求条数返回时,以实际条数为准。 |
total | number | 总条数。平台没给总数时为 0,以 items 为准。 |
调用示例
curl -X POST https://www.xmedi.cn/api/v1/xhs/search/suggestions \
-H "X-XMEDI-Key: xm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"keyword":"cat"}'
返回示例
以下为 data 的字段结构示意,实际取值以调用结果为准。
{
"has_more": false,
"items": [
{
"word": "示例关键词"
}
],
"next_cursor": "",
"page": 1,
"page_size": 20,
"total": 1
}
注意事项
- 请用中文关键词。英文或空词经常没有词条。
- 返回的不是笔记正文。
常见错误码
| code | error_code | 含义与处理 |
|---|---|---|
| 40001 | VALIDATION_ERROR | 参数校验失败,按返回提示修改请求,不扣费 |
| 40100 | UNAUTHORIZED | API Key 缺失、错误或已吊销,到控制台检查 Key |
| 40200 | INSUFFICIENT_BALANCE | 余额不足,充值后重试 |
| 42900 | RATE_LIMITED | 超过每分钟 60 次上限,稍后重试 |
| 50000 | INTERNAL_ERROR | 服务异常,可稍后重试,不扣费 |
| 50300 | NOT_AVAILABLE | 接口暂不可用,不扣费 |
常见问题
- 为什么是空的?
- 先确认关键词是中文。空列表表示这次没有建议,若调用成功仍会计费。
- word 能直接搜笔记吗?
- 可以,把它当作笔记搜索的 keyword。
- 调用失败会扣费吗?
- 只有调用成功才扣费。参数错误、对象不存在或取数失败不扣费。
相关接口
需要接入这个接口?
免费注册
注册后创建 API Key,或留下联系方式获取方案