Billing Rules
Etshop API deducts credits per call. There are 3 types of credits, matching the 3 quotas of the web app. Each type is purchased, deducted and tracked separately. All credits never expire and are not reset monthly.
Etshop API deducts credits per call. There are 3 types of credits, matching the 3 quotas of the web app. Each type is purchased, deducted and tracked separately. All credits never expire and are not reset monthly.
Credits Types
| Credits | credits.type |
Web app quota | Used by | Unit price | Minimum purchase | Maximum per order |
|---|---|---|---|---|---|---|
| Credits | default |
Search & filter times | Shop and product endpoints | $0.001 each | 100,000 ($100) | 20,000,000 |
| Keyword Credits | keyword_credits |
Keyword searches | Keyword Search | $0.004 each | 25,000 ($100) | 5,000,000 |
| Monitor Credits | monitor_credits |
Monitored shops | Add Shop Monitors | $1 each (1 = one shop monitored for 30 days) | 10 ($10) | 100,000 |
Volume discounts for Credits: 500,000 Credits for $450 (10% off) and 2,000,000 Credits for $1,600 (20% off).
Credits are purchased in the developer center. Use Current Credits to check the balance of all 3 types at once.
Cost per Endpoint
| Endpoint | Cost |
|---|---|
| Shop List, Top Selling Shops, Closed Shop List, Product List | 1 Credit per record returned; returned shops/products are marked as "requested" for 3 days |
| Shop Details | 2 Credits per call; the shop is marked as "requested" |
| Product Details, daily data and data trends of shops/products, Product Reviews | Free; the shop/product must have been requested within 3 days, otherwise 403002 is returned |
| Keyword Search | 1 Keyword Credit per keyword; searching the same keyword again within 30 days is free |
| Keyword Analytics, Related Keywords, Keyword Product List | Free; the keyword must have been searched via Keyword Search within 30 days, otherwise 403002 is returned (when querying Related Keywords by shop_id / product_id, the shop/product must have been requested within 3 days instead) |
| Add Shop Monitors | 1 Monitor Credit per successfully added shop, monitored for 30 days |
| Other shop monitor endpoints (groups, lists, overview, details, stop, delete, etc.) | Free |
| Current Credits, Category List | Free |
Billing Details
- Lists are charged by records returned: List endpoints deduct 1 Credit per record returned. If your balance cannot cover a full page, as many records as your remaining balance allows are returned (you get what you pay for); if the balance is 0, 403001 is returned.
- Empty results are free: Nothing is deducted when the result is empty or the keyword is not indexed.
- Automatic refunds on failure: If a request fails because of a server error (500) or another exception, the credits deducted by that request are refunded automatically.
- "Requested" rule (3 days): Shops and products returned by list endpoints, and shops queried via Shop Details, are marked as "requested" for 3 days; for products returned by a list, their shops are marked as well. The free details, daily data, trend and review endpoints only accept requested records. After expiry, get them again from a list or details endpoint.
- Keyword 30-day rule: Searching the same keyword (case-insensitive) again within 30 days after it was charged is free, and the response returns
is_deductions = false. During this period, Keyword Analytics, Related Keywords and Keyword Product List are free for that keyword. Searching it after 30 days is charged again. - Monitors run for a fixed 30 days: Each shop monitor costs 1 Monitor Credit and runs for a fixed 30 days, then stops automatically. Credits are pre-deducted by the number of submitted shops (the whole request returns 403001 if the balance is insufficient), and shops that fail to be added are refunded within the same request. Stopping a monitor early does not refund credits; re-adding a stopped shop is charged again.
Credits Information in Responses
Every response contains a top-level credits object describing the credits type and the deduction of this request (except responses for authentication failures 401, rate limiting 429 and request parameter validation failures 400):
{
"code": 200,
"message": "success",
"data": { },
"credits": {
"type": "default",
"remaining_credits": 199980,
"consumed_credits": 20,
"total_credits": 200000
}
}
| Field | Description |
|---|---|
type |
Credits type: default (Credits), keyword_credits (Keyword Credits), monitor_credits (Monitor Credits) |
remaining_credits |
Remaining credits of this type after the request |
consumed_credits |
Credits actually consumed by this request (after any refund; 0 for free endpoints) |
total_credits |
Total credits of this type |
Rate Limit
By default each account can send up to 200 requests per minute (all API keys of the account combined). Requests beyond the limit return 429. Contact us if you need a higher limit.
