EtshopAPI Platform
EN / 中文
API REFERENCE

Related Keywords API

GET/v1/keyword/keyword-list
Free·api.etshop.ai/open-api
Credits 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

AUTHORIZATIONAuthorization: {API Key}
CONTENT-TYPEapplication/json
ACCEPTapplication/json

Request example

cURL
curl --location --request GET 'https://api.etshop.ai/open-api/v1/keyword/keyword-list?keyword=wall%20art&type=3&country=US' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}'

Request parameters 5 fields

Pass each parameter in its specified location.

Parameter Type Description
type
query · required
integer Query type: 1 = product-related keywords (other tags used by top listings with this keyword); 2 = similar keywords (keywords with similar names); 3 = all keywords (union of 1 and 2); 4 = shop keywords (tags used by the shop's listings); 5 = product keywords (tags used by the listing)
keyword
query · optional
string Keyword, case-insensitive. Required when type is 1, 2 or 3.
shop_id
query · optional
integer Shop ID. Required when type is 4.
product_id
query · optional
integer Product ID. Required when type is 5.
country
query · optional
string Country/region code for Google keyword data, e.g. US. Only applies when type is 1, 2 or 3; case-insensitive; omit it or pass ALL for global data. Google fields are null when there is no data for that country/region.

Response example

Response · JSON
{
    "code": 200,
    "message": "success",
    "data": {
        "list": [
            {
                "tag": "wall art",
                "listing_reviews": 1873420,
                "favorites": 9264315,
                "competition": 412876,
                "shop_competition": 98342,
                "real_sales": 256731,
                "google_monthly_search": 165000,
                "google_pd": 87,
                "google_cpc": 0.42
            },
            {
                "tag": "wall decor",
                "listing_reviews": 1520384,
                "favorites": 7811920,
                "competition": 356120,
                "shop_competition": 87215,
                "real_sales": 198452,
                "google_monthly_search": 74000,
                "google_pd": 100,
                "google_cpc": 0.55
            },
            {
                "tag": "boho wall art",
                "listing_reviews": 286103,
                "favorites": 1502388,
                "competition": 64510,
                "shop_competition": 21873,
                "real_sales": 41296,
                "google_monthly_search": null,
                "google_pd": null,
                "google_cpc": null
            }
        ]
    },
    "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 list, sorted by competition (descending). Empty array if there is no data.
»»» tag string true none Keyword
»»» 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 | null true none Google monthly search volume
»»» google_pd number | null true none Google Ads paid difficulty
»»» google_cpc number | null true none Google Ads cost per click (CPC, USD)
» 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
Search the existing endpoint names and paths