API REFERENCE
Keyword Search API
GET
/v1/keyword/searchEach keyword deducts
1 Keyword Credit. Searching the same keyword again within 30 days is free (the response returns is_deductions = false). If the keyword is not indexed, empty data is returned and nothing is deducted.·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/search?keyword=wall%20art&country=US' \
--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, e.g. wall art. Must be URL-encoded. |
| country
query · optional
| string | Country/region code for Google keyword data, e.g. US (case-insensitive). Omit it or pass ALL for global data. Only affects google_monthly_search, google_cpc and google_pd; returns 0 when there is no data for that country/region. |
Response example
Response · 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
}
}
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 | Keyword data. An empty object {} if the keyword is not indexed. |
| »» tag | string | true | none | Keyword (same as the request parameter) |
| »» listing_reviews | integer | true | none | Total reviews of listings using this keyword |
| »» favorites | integer | true | none | Total favorites of listings using this keyword |
| »» competition | integer | true | none | Competition: number of listings using this keyword (tag) |
| »» shop_competition | integer | true | none | Shop competition: number of shops using this keyword |
| »» real_sales | integer | true | none | Total real sales of listings using this keyword |
| »» google_monthly_search | number | true | none | Google monthly search volume |
| »» google_cpc | number | true | none | Google Ads cost per click (CPC, USD) |
| »» google_pd | number | true | none | Google Ads paid difficulty |
| »» is_deductions | boolean | true | none | Whether this request was charged: true = 1 Keyword Credit deducted; false = the keyword was already searched within 30 days, so this request is free |
| » 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 |
| »» total_credits | integer | true | none | Total Keyword Credits |
