接口参考
计费规则
Etshop API 按调用扣除 Credits。Credits 分为 3 种,分别对应网页端的 3 种额度,各自独立购买、独立扣费、独立统计。所有 Credits 永久有效,不会过期,也不按月清零。
Etshop API 按调用扣除 Credits。Credits 分为 3 种,分别对应网页端的 3 种额度,各自独立购买、独立扣费、独立统计。所有 Credits 永久有效,不会过期,也不按月清零。
Credits 类型
| Credits | credits.type |
对应网页端额度 | 用于 | 单价 | 最小起购 | 单笔最多 |
|---|---|---|---|---|---|---|
| Credits | default |
搜索&筛选次数 | 店铺、商品相关接口 | $0.001 / 个 | 100,000($100) | 20,000,000 |
| Keyword Credits | keyword_credits |
关键词搜索次数 | 关键词搜索 | $0.004 / 个 | 25,000($100) | 5,000,000 |
| Monitor Credits | monitor_credits |
监控店铺数 | 添加店铺监控 | $1 / 个(1 个 = 1 个店铺监控 30 天) | 10($10) | 100,000 |
Credits 一次购买得越多越便宜:500,000 Credits $450(9 折)、2,000,000 Credits $1,600(8 折)。
在开发者中心购买 Credits。可以通过查询 Credits 余额一次查看 3 种 Credits 的余额。
各接口扣费
| 接口 | 扣费 |
|---|---|
| 店铺列表、热销店铺榜、已关闭店铺列表、商品列表 | 每返回 1 条扣 1 Credit;返回的店铺/商品记为“已请求”,有效期 3 天 |
| 店铺详情 | 每次扣 2 Credits,并将该店铺记为“已请求” |
| 商品详情、店铺/商品的每日数据和数据趋势、商品评论列表 | 免费;要求该店铺/商品 3 天内已请求过,否则返回 403002 |
| 关键词搜索 | 每个关键词扣 1 Keyword Credit;30 天内再次搜索同一个关键词免费 |
| 关键词分析、相关关键词、关键词商品列表 | 免费;要求该关键词 30 天内通过关键词搜索查询过,否则返回 403002(按 shop_id / product_id 查询相关关键词时,改为要求该店铺/商品 3 天内已请求过) |
| 添加店铺监控 | 每成功添加 1 个店铺扣 1 Monitor Credit,监控 30 天 |
| 店铺监控的其它接口(分组、列表、看板、详情、停止、删除等) | 免费 |
| 查询 Credits 余额、分类列表 | 免费 |
扣费细则
- 列表按实际返回条数扣费:列表接口每返回 1 条扣 1 Credit。余额不足以支付整页时,按剩余余额返回对应条数(扣多少返回多少);余额为 0 时返回 403001。
- 结果为空不扣费:查询结果为空,或关键词未收录时,不扣费。
- 失败自动退还:服务器错误(500)等异常导致请求失败时,本次已扣的 Credits 会自动退还。
- “已请求”规则(3 天):列表接口返回的店铺和商品、店铺详情查询过的店铺,会记为“已请求”,有效期 3 天;列表返回的商品,其所属店铺也一并记为已请求。免费的详情、每日数据、趋势、评论接口只能查询已请求的记录,过期后重新从列表或详情获取即可。
- 关键词 30 天规则:同一个关键词(不区分大小写)在扣费后的 30 天内再次搜索不重复扣费,响应中的
is_deductions为false;在此期间,该关键词的关键词分析、相关关键词、关键词商品列表均可免费调用。超过 30 天后再次搜索会重新扣费。 - 监控固定 30 天:每个店铺监控扣 1 Monitor Credit,固定监控 30 天,到期自动停止。添加时按提交的店铺数预扣(余额不足时整个请求返回 403001),添加失败的店铺在同一次请求内自动退还;提前停止监控不退还;已停止的店铺重新添加会重新扣费。
响应中的 Credits 信息
每个接口的响应顶层都带有 credits 对象(鉴权失败 401、超过频率限制 429、请求参数校验失败 400 的响应除外),说明本次请求涉及的 Credits 类型和扣费情况:
{
"code": 200,
"message": "success",
"data": { },
"credits": {
"type": "default",
"remaining_credits": 199980,
"consumed_credits": 20,
"total_credits": 200000
}
}
| 字段 | 说明 |
|---|---|
type |
Credits 类型:default(Credits)、keyword_credits(Keyword Credits)、monitor_credits(Monitor Credits) |
remaining_credits |
本次请求后该类型 Credits 的剩余数量 |
consumed_credits |
本次请求实际消耗的数量(已扣除退还部分;免费接口为 0) |
total_credits |
该类型 Credits 的总数量 |
请求频率限制
每个账户默认每分钟最多 200 次请求(同一账户下的所有 API Key 合并计算),超出返回 429。如需更高的频率,请联系我们。
