接口参考
关键词搜索 API
GET
/v1/keyword/search每个关键词消耗
1 Keyword Credit;30 天内再次搜索同一个关键词不重复扣费(返回 is_deductions = false);关键词未收录时返回空数据,不扣费·api.etshop.ai/open-apiCredits 消耗规则
计费规则:店铺/商品列表与热销榜每返回 1 条扣 1 Credit,店铺详情每次扣 2 Credits;详情、趋势、每日数据、评论免费(需 3 天内在列表或详情中返回过)。关键词搜索每个词扣 1 Keyword Credit,30 天内同一个词免费。店铺监控每个店铺扣 1 Monitor Credit,监控 30 天,停止后不退还。空结果不扣费,服务器错误自动退还。
请求头
AUTHORIZATION
Authorization: {API Key}CONTENT-TYPE
application/jsonACCEPT
application/json请求示例
cURL
curl --location --request GET 'https://api.etshop.ai/open-api/v1/keyword/search?keyword=wall%20art&country=US' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}' 请求参数
按参数标注的位置传入请求。
| 参数 | 类型 | 说明 |
|---|---|---|
| keyword
query · 必填
| string | 关键词,例如 wall art。需要 URL 编码 |
| country
query · 可选
| string | Google 关键词数据的国家/地区代码,例如 US,不区分大小写;不传或传 ALL 表示全球数据。只影响 google_monthly_search、google_cpc、google_pd 三个字段,该国家/地区没有数据时返回 0 |
返回示例
返回示例 · JSON
{
"code": 200,
"message": "success",
"data": {
"tag": "wall art",
"listing_reviews": 1873420,
"favorites": 9264315,
"competition": 412876,
"shop_competition": 98342,
"real_sales": 256731,
"google_monthly_search": 165000,
"google_cpc": 0.42,
"google_pd": 87,
"is_deductions": true
},
"credits": {
"type": "keyword_credits",
"remaining_credits": 49871,
"consumed_credits": 1,
"total_credits": 50000
}
}
文档中的示例数据
返回数据结构
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
| » code | integer | true | none | 业务状态码 |
| » message | string | true | none | 响应消息 |
| » data | object | true | none | 关键词数据;关键词未收录时为空对象 {} |
| »» tag | string | true | none | 关键词(与请求参数一致) |
| »» listing_reviews | integer | true | none | 使用该关键词的商品的评论总数 |
| »» favorites | integer | true | none | 使用该关键词的商品的收藏总数 |
| »» competition | integer | true | none | 竞争度:使用该关键词(标签)的商品数量 |
| »» shop_competition | integer | true | none | 店铺竞争度:使用该关键词的店铺数量 |
| »» real_sales | integer | true | none | 使用该关键词的商品的真实销量总数 |
| »» google_monthly_search | number | true | none | Google 月搜索量 |
| »» google_cpc | number | true | none | Google 广告单次点击费用(CPC,美元) |
| »» google_pd | number | true | none | Google 广告竞争度(Paid Difficulty) |
| »» is_deductions | boolean | true | none | 本次是否扣费:true 本次扣了 1 Keyword Credit;false 30 天内已搜索过该关键词,本次免费 |
| » credits | object | true | none | 本次请求的 Credits 信息,见计费规则 |
| »» type | string | true | none | Credits 类型,本接口为 keyword_credits |
| »» remaining_credits | integer | true | none | 本次请求后剩余的 Keyword Credits |
| »» consumed_credits | integer | true | none | 本次请求消耗的 Keyword Credits |
| »» total_credits | integer | true | none | Keyword Credits 总数量 |
