Etsy关键词搜索 API

POST

接口健康状态

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

关键词搜索:返回列表,默认 20 条、单次最多 50 条;主要字段 listing_id、title、url、price、list_price、currency。

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

AI 提示词

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

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

接口约定:
- 请求:POST https://api.everyinfra.com/api/v1/social,请求头 Authorization: Bearer <API Key>;Key 从环境变量 EVERYINFRA_API_KEY 读取,不要写进代码。
- 请求体里 platform 填 etsy,action 填 search,参数放在 params 里。
- 必填参数:
  - keyword:Etsy 商品搜索词,例如 ceramic mug。用于检索商品标题/列表,不是店铺名精确查询;店铺资料或评论使用 shop。
- 可选参数:
  - currency:搜索结果的商品价格币种,默认 USD,支持当前接口列出的币种代码。min_price 按此币种解释,不改变 API 调用扣费币种。(可选值:aud / brl / cad / chf / dkk / eur / gbp / hkd)
  - exclude_keywords:排除商品标题词,传字符串数组,例如 ["digital", "download"];标题包含任一词时排除,忽略大小写。不是排除卖家或扫描完整商品描述的保证。
  - min_price:商品搜索最低价格,非负数值,单位为 currency 所选币种;不是最小起订量、运费上限或调用预算。
  - sort:商品搜索排序:relevance 综合相关度(默认)、price_asc 价格升序、price_desc 价格降序、newest 最近上架。(可选值:newest / price_asc / price_desc / relevance)
  - limit:这次调用最多返回的条数,整数,1–50;不传按默认值,实际返回可能少于这个数。超过上限会在扣费前返回 422。(默认 20)
- 返回一组记录,每条记录的主要字段:listing_id(商品 ID)、title、url、price、list_price(标价)、currency、rating、rating_scale、shop_id(店铺 ID)、shop_name(店铺名)、shop_rating(店铺评分)、shop_review_count(店铺评价数);一共 16 个字段,完整列表见 https://api.everyinfra.com/api/v1/social/catalog?platform=etsy。
- 示例请求体:
{
  "platform": "etsy",
  "action": "search",
  "params": {
    "keyword": "ceramic mug"
  }
}
- 计费:$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是etsy平台标识,固定值。
actionbodystring是search能力标识,固定值。
keywordbody.params未声明是-Etsy 商品搜索词,例如 ceramic mug。用于检索商品标题/列表,不是店铺名精确查询;店铺资料或评论使用 shop。
currencybody.paramsenum否-搜索结果的商品价格币种,默认 USD,支持当前接口列出的币种代码。min_price 按此币种解释,不改变 API 调用扣费币种。允许值audbrlcadchfdkkeurgbphkdinrjpymxnnoknzdseksgdusd
exclude_keywordsbody.params未声明否-排除商品标题词,传字符串数组,例如 ["digital", "download"];标题包含任一词时排除,忽略大小写。不是排除卖家或扫描完整商品描述的保证。
min_pricebody.params未声明否-商品搜索最低价格,非负数值,单位为 currency 所选币种;不是最小起订量、运费上限或调用预算。
sortbody.paramsenum否-商品搜索排序:relevance 综合相关度(默认)、price_asc 价格升序、price_desc 价格降序、newest 最近上架;兼容旧值 most_relevant / lowest_price / highest_price / recently_listed。不是店铺评论时间排序。允许值newestprice_ascprice_descrelevance
limitbody.paramsinteger (1–50)否20这次调用最多返回的条数,整数,1–50;不传按默认值,实际返回可能少于这个数。超过上限会在扣费前返回 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": "etsy",
  "action": "search",
  "params": {
    "keyword": "ceramic mug"
  }
}'

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

检索手作商品;reviews 面向店铺,不能直接替换成商品搜索词。

响应示例

真实返回样例

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

json
{
  "id": "req_…",
  "platform": "etsy",
  "action": "search",
  "results": [
    {
      "listing_id": "(已隐去)",
      "title": "The Libby Travel Mug hand thrown ceramic mug cup Pottery Travel Mug Cup with attached lid fits in cup holder",
      "url": "https://www.etsy.com/listing/1510223855/the-libby-travel-mug-hand-thrown-ceramic",
      "price": "34.99",
      "currency": "USD",
      "rating": 5,
      "shop_id": "8740835",
      "shop_name": "StonehousePotteryOH",
      "on_sale": false,
      "free_shipping": false,
      "is_digital": false,
      "image_url": "https://i.etsystatic.com/8740835/r/il/d4f720/7239142492/il_fullxfull.7239142492_oym6.jpg",
      "platform": "etsy",
      "rating_scale": 5
    },
    {
      "listing_id": "(已隐去)",
      "title": "Personalized Engraved Mug – Custom Photo, Text or Logo Ceramic Coffee Cup, 12.8 oz",
      "url": "https://www.etsy.com/listing/4515619135/personalized-engraved-mug-custom-photo",
      "price": "11.14",
      "list_price": "14.85",
      "currency": "USD",
      "rating": 5,
      "shop_id": "65820773",
      "shop_name": "PCraftHandle",
      "on_sale": true,
      "free_shipping": false,
      "is_digital": false,
      "image_url": "https://i.etsystatic.com/65820773/r/il/c96314/8092105956/il_fullxfull.8092105956_4yao.jpg",
      "platform": "etsy",
      "rating_scale": 5
    }
  ],
  "count": 20,
  "billing": {
    "charged": …,
    "charged_usd": …,
    "balance_after_usd": …,
    …
  },
  "quota": { … }
}

返回字段

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

字段含义
listing_id商品 ID。
title标题。平台无标题概念时(如纯文本帖)为 null。
url该记录在原平台上的可访问链接。
price价格数值,不含货币符号;币种见 currency。
list_price标价。
currency价格币种代码(如 CNY、USD)。price 存在但 currency 为 null 时不要假定币种。
rating评分。分制随平台而异,同一行的 rating_scale 给出该平台满分 (多数是 5,Booking/豆瓣/爱奇艺/NAVER 是 10)。跨平台比较前必须先按 rating_scale 换算 —— 直接比数字会得出反的结论。
rating_scale上一列 rating 的满分。5 表示五星制、10 表示十分制。只在该行有 rating 时出现。
shop_id店铺 ID。
shop_name店铺名。
shop_rating店铺评分。
shop_review_count店铺评价数。
on_sale是否在促销。
free_shipping是否包邮。
is_digital是否为数字商品(下载类,无需物流)。
image_url图片链接。多图能力可能返回 image_urls 数组。
platform数据来源平台标识,与请求里的 platform 一致(如 xiaohongshu、tiktok)。

错误与计费

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