Shopee关键词搜索 API

POST

接口健康状态

24h 健康值
正常
24h 平均耗时
—
  • 健康 / 正常
  • 可用
  • 少量可用
  • 基本不可用
正常

关键词搜索:返回列表,默认 20 条、单次最多 100 条;主要字段 shop_id、item_id、name、url、image_url、price。

单价 $1.39 / 千次(每次 $0.001389),失败与空结果不扣费。 同步返回;慢任务可在请求体加 "mode": "async",先拿 job_id 再轮询。

AI 提示词

复制下面这段给你常用的 AI 助手:里面写好了这个接口的参数、返回字段和示例请求,它会先问清你的需求,再帮你写采集脚本。

请帮我用 EveryInfra 的「Shopee 关键词搜索」接口(shopee/search)写一个数据采集脚本。

接口约定:
- 请求:POST https://api.everyinfra.com/api/v1/social,请求头 Authorization: Bearer <API Key>;Key 从环境变量 EVERYINFRA_API_KEY 读取,不要写进代码。
- 请求体里 platform 填 shopee,action 填 search,参数放在 params 里。
- 必填参数:
  - keyword:商品关键词;搜索哪个地区商城由 country 决定。
- 可选参数:
  - country:商城地区代码,支持 id/sg/my/th/ph/vn/br/tw/mx/co/cl,未指定时默认 id(印度尼西亚)。这是商城选择,不保证每个地区都有结果。(可选值:br / cl / co / id / mx / my / ph / sg)
  - max_price:最高商品价格,按目标商城使用的币种填写;与 min_price 配合使用。
  - min_price:最低商品价格,按目标商城使用的币种填写;不要跨地区把数值当成同一币种,也不是 API 计费金额。
  - sort:商品排序:relevance 相关性、popular 销量相关排序、newest 最新、price_asc 价格升序、price_desc 价格降序。(可选值:newest / popular / price_asc / price_desc / relevance)
  - limit:这次调用最多返回的条数,整数,1–100;不传按默认值,实际返回可能少于这个数。超过上限会在扣费前返回 422。(默认 20)
- 返回一组记录,每条记录的主要字段:shop_id(店铺 ID)、item_id(商品 ID)、name、url、image_url、price、original_price(原价)、discount_pct(折扣百分比)、currency、rating、rating_scale、rating_count;一共 15 个字段,完整列表见 https://api.everyinfra.com/api/v1/social/catalog?platform=shopee。
- 示例请求体:
{
  "platform": "shopee",
  "action": "search",
  "params": {
    "keyword": "wireless mouse"
  }
}
- 计费:$1.39 / 千次;失败和空结果不扣费。
- 一次要采几十上百个时,在请求体加 "mode": "async":先拿到 job_id,再轮询 GET https://api.everyinfra.com/api/v1/jobs/{job_id} 取结果。
- 返回 422 时,按错误信息里的候选参数和允许值修正;返回 429 或 503 时,按 Retry-After 等待后重试。

写代码前,先问清楚我要采哪些对象、一共多少个、需要哪些字段、结果存成什么格式,再把方案和大概花费讲给我确认。

请求参数

参数名位置类型必填默认值说明
Authorizationheaderstring是-Bearer 加你的 API Key。在控制台创建;不要放进网址或代码仓库。
platformbodystring是shopee平台标识,固定值。
actionbodystring是search能力标识,固定值。
keywordbody.params未声明是-商品关键词;搜索哪个地区商城由 country 决定。
countrybody.paramsenum否-商城地区代码,支持 id/sg/my/th/ph/vn/br/tw/mx/co/cl,未指定时默认 id(印度尼西亚)。这是商城选择,不保证每个地区都有结果。允许值brclcoidmxmyphsgthtwvn
max_pricebody.params未声明否-最高商品价格,按目标商城使用的币种填写;与 min_price 配合使用。
min_pricebody.params未声明否-最低商品价格,按目标商城使用的币种填写;不要跨地区把数值当成同一币种,也不是 API 计费金额。
sortbody.paramsenum否-商品排序:relevance 相关性、popular 销量相关排序、newest 最新、price_asc 价格升序、price_desc 价格降序。允许值newestpopularprice_ascprice_descrelevance
limitbody.paramsinteger (1–100)否20这次调用最多返回的条数,整数,1–100;不传按默认值,实际返回可能少于这个数。超过上限会在扣费前返回 422。

代码示例

bash
curl -X POST 'https://api.everyinfra.com/api/v1/social' \
  -H "Authorization: Bearer $EVERYINFRA_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "platform": "shopee",
  "action": "search",
  "params": {
    "keyword": "wireless mouse"
  }
}'

[OpenAPI 定义 (JSON)]示例从环境变量 EVERYINFRA_API_KEY 读取 Key,复制出去的代码不含你的 Key。

检索商品;站点市场决定商品价格语境,不等于 API 钱包币种。

响应示例

真实返回样例

2026年9月26日 16:56(北京时间)用上方代码示例的参数真实调用所得。results 与 count 是那次的真实返回,已隐去名字、账号、头像、主页链接、联系方式等个人信息,列表只保留前 2 条;id、billing、quota 每次调用都不同,只给结构。

json
{
  "id": "req_…",
  "platform": "shopee",
  "action": "search",
  "results": [
    {
      "shop_id": 487136590,
      "item_id": 23911735997,
      "name": "MOFii Mouse Wireless Gaming Rechargeable Baterai Type-C Fast Charging 1600DPI RGB Light P6",
      "url": "https://shopee.co.id/MOFii-Mouse-Wireless-Gaming-Rechargeable-Baterai-Type-C-Fast-Charging-1600DPI-RGB-Light-P6-i.487136590.23911735997",
      "image_url": "https://down-id.img.susercontent.com/file/id-11134207-7qul0-li9nrexr1rvb70",
      "price": 80000,
      "original_price": 299900,
      "currency": "IDR",
      "rating": 4.9,
      "location": "Tangerang",
      "is_mall": false,
      "platform": "shopee",
      "rating_scale": 5
    },
    {
      "shop_id": 992148841,
      "item_id": 25190075617,
      "name": "[COD] Mouse Bluetooth Dual-Mode Wireless 2.4G Silent Mouse USB Portable Charging Gaming Mouse For IPad Windows los",
      "url": "https://shopee.co.id/-COD-Mouse-Bluetooth-Dual-Mode-Wireless-2.4G-Silent-Mouse-USB-Portable-Charging-Gaming-Mouse-For-IPad-Windows-los-i.992148841.25190075617",
      "image_url": "https://down-id.img.susercontent.com/file/id-11134207-7rbke-m8vjok4qdvcr7f",
      "price": 30900,
      "original_price": 58000,
      "currency": "IDR",
      "rating": 4.9,
      "location": "Jakarta Barat",
      "is_mall": false,
      "platform": "shopee",
      "rating_scale": 5
    }
  ],
  "count": 20,
  "billing": {
    "charged": …,
    "charged_usd": …,
    "balance_after_usd": …,
    …
  },
  "quota": { … }
}

返回字段

业务数据在 results 里;下表是每条记录可能包含的字段,平台没有提供的值不会被补造。

字段含义
shop_id店铺 ID。
item_id商品 ID。
name名称。用于账号/商品/商家类能力,指该对象本身的名字。
url该记录在原平台上的可访问链接。
image_url图片链接。多图能力可能返回 image_urls 数组。
price价格数值,不含货币符号;币种见 currency。
original_price原价。
discount_pct折扣百分比。
currency价格币种代码(如 CNY、USD)。price 存在但 currency 为 null 时不要假定币种。
rating评分。分制随平台而异,同一行的 rating_scale 给出该平台满分 (多数是 5,Booking/豆瓣/爱奇艺/NAVER 是 10)。跨平台比较前必须先按 rating_scale 换算 —— 直接比数字会得出反的结论。
rating_scale上一列 rating 的满分。5 表示五星制、10 表示十分制。只在该行有 rating 时出现。
rating_count参与评分的人数。null 表示不公开,不等于 0。
sold_count销量。
location地理位置描述,原文透传,格式随平台而异。
is_mall是否为 Shopee Mall 官方店。东南亚电商里辨真假货的第一信号。
platform数据来源平台标识,与请求里的 platform 一致(如 xiaohongshu、tiktok)。

错误与计费

401
缺少 Key 或 Key 无效。先鉴权再校验参数,未鉴权的请求拿不到参数结构。
422
参数名或取值不对。错误信息会列出这项能力支持的参数、允许值和最接近的候选,按它改即可;发生在扣费之前。
402
余额不足,请先充值。
429
超过账户的每分钟请求上限(名下所有 Key 合计;Key 自设了更低上限时先按它算),按 Retry-After 等待后再试。需要更高上限可在控制台买提速包。
503
暂时无法完成。已预扣的费用按原账本退回;响应里的 billing 与 refund 写明实际结果,结果未知时会明确标出,不要直接重发。
200 空结果
请求完成但没有数据,不扣费(billing.reason = empty_result_refunded)。