API REFERENCE
Keyword Analytics API
GET
/v1/keyword/analyticsFree·api.etshop.ai/open-apiCredits usage rules
Billing: shop/product lists and top sellers cost 1 Credit per returned record; shop details cost 2 Credits per call. Details, trends, daily data and reviews are free (the record must have been returned by a list or details call within 3 days). Keyword search costs 1 Keyword Credit per keyword, and the same keyword is free for 30 days. Shop monitoring costs 1 Monitor Credit per shop for 30 days and is not refunded when stopped. Empty results are free and server errors are refunded automatically.
Request headers
AUTHORIZATION
Authorization: {API Key}CONTENT-TYPE
application/jsonACCEPT
application/jsonRequest example
cURL
curl --location --request GET 'https://api.etshop.ai/open-api/v1/keyword/analytics?keyword=wall%20art' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}' Request parameters
Pass each parameter in its specified location.
| Parameter | Type | Description |
|---|---|---|
| keyword
query · required
| string | Keyword, case-insensitive. Must be URL-encoded. |
Response example
Response · JSON
{
"code": 200,
"message": "success",
"data": {
"list": {
"tag": "wall art",
"competition": 412876,
"avg_real_sales": "0.62",
"avg_price_total": "28.47",
"avg_favorites": "22.44",
"avg_listing_reviews": "4.54",
"most_popular_tags": [
{
"tag": "wall art",
"competition": 412876
},
{
"tag": "wall decor",
"competition": 356120
},
{
"tag": "printable wall art",
"competition": 118934
}
],
"most_popular_categories": [
{
"category_arr": ["Art & Collectibles", "Prints", "Digital Prints"],
"percentage": "0.46"
},
{
"category_arr": ["Art & Collectibles", "Painting", "Acrylic"],
"percentage": "0.18"
},
{
"category_arr": ["Home & Living", "Home Decor", "Wall Decor", "Wall Hangings"],
"percentage": "0.12"
}
],
"price_range": [
{
"price": "3.99",
"num": 12
},
{
"price": "5.20",
"num": 9
},
{
"price": "24.00",
"num": 4
}
],
"processing_times": [
{
"day": "1 days - 1 days",
"num": "0.41"
},
{
"day": "1 days - 3 days",
"num": "0.27"
},
{
"day": "3 days - 5 days",
"num": "0.19"
}
]
}
},
"credits": {
"type": "keyword_credits",
"remaining_credits": 49871,
"consumed_credits": 0,
"total_credits": 50000
}
}
Example data from the existing documentation
Response structure
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
| » code | integer | true | none | Status Code |
| » message | string | true | none | Response message |
| » data | object | true | none | Response data |
| »» list | object | true | none | Keyword analytics. An empty array [] if the keyword is not indexed. |
| »»» tag | string | true | none | Keyword |
| »»» competition | integer | true | none | Competition: number of listings using this keyword (tag) |
| »»» avg_real_sales | string | true | none | Average real sales (total real sales ÷ number of listings, 2 decimals) |
| »»» avg_price_total | string | true | none | Average price (USD, 2 decimals) |
| »»» avg_favorites | string | true | none | Average favorites (2 decimals) |
| »»» avg_listing_reviews | string | true | none | Average reviews (2 decimals) |
| »»» most_popular_tags | [object] | true | none | Most popular related tags, up to 80, sorted by competition (descending) |
| »»»» tag | string | true | none | Tag |
| »»»» competition | integer | true | none | Number of listings using this tag |
| »»» most_popular_categories | [object] | true | none | Most popular categories, up to 5 |
| »»»» category_arr | [string] | true | none | Category path, from top-level to leaf category |
| »»»» percentage | string | true | none | Share, 0.42 means 42% |
| »»» price_range | [object] | true | none | Price distribution of the 100 listings with the highest real sales (USD), sorted by price (ascending) |
| »»»» price | string | true | none | Price (USD) |
| »»»» num | integer | true | none | Number of listings at this price |
| »»» processing_times | [object] | true | none | Processing time distribution |
| »»»» day | string | true | none | Processing time range, e.g. 1 days - 3 days |
| »»»» num | string | true | none | Share, 0.35 means 35% |
| » credits | object | true | none | Credits information of this request. See Billing Rules. |
| »» type | string | true | none | Credits type. keyword_credits for this endpoint. |
| »» remaining_credits | integer | true | none | Remaining Keyword Credits after this request |
| »» consumed_credits | integer | true | none | Keyword Credits consumed by this request (0 for this endpoint) |
| »» total_credits | integer | true | none | Total Keyword Credits |
