API REFERENCE
Keyword Product List API
GET
/v1/keyword/keyword-product-listFree·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/keyword-product-list?tags=wall%20art¤t_page=1&page_size=2&order_by=total_review&direction=desc' \
--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 |
|---|---|---|
| tags
query · required
| string | Keyword, exactly matched against listing tags, case-insensitive. Must be URL-encoded. |
| name
query · optional
| string | Further filter the results: listing tags or titles containing these words. Multiple values should be comma-separated. |
| current_page
query · optional
| integer | Page number (min: 1, default: 1). |
| page_size
query · optional
| integer | Items per page (range: 1-100, default: 20). |
| order_by
query · optional
| string | Sort field. Valid options: review_growth (review growth in the last 7 days), collection_growth (favorite growth in the last 7 days), total_collection (total favorites), total_review (total reviews), create_date (listing date). Defaults to review_growth. |
| direction
query · optional
| string | Sort direction. Valid options: desc (descending, default), asc (ascending). |
Response example
Response · JSON
{
"code": 200,
"message": "success",
"data": {
"data": [
{
"id": 1188235614,
"image": "https://i.etsystatic.com/27403561/r/il/5c7e1a/3952184720/il_794xN.3952184720_k2m8.jpg",
"name": "Abstract Boho Wall Art Set of 3, Neutral Printable Wall Art, Mid Century Modern Prints",
"create_date": 1645512331,
"currency_code": "USD",
"country_code": "US",
"sale": 18342,
"sale_growth": 214,
"review": 3876,
"review_growth": 41,
"collect": 52310,
"collect_growth": 612,
"view": 0,
"view_growth": 0,
"real_sale": 18342,
"real_sale_growth": 214,
"bestseller": 1,
"etsy_pick": 0,
"product_type": ["Digital"],
"is_video": 0,
"price": 9.6,
"url": "https://www.etsy.com/listing/1188235614/abstract-boho-wall-art-set-of-3-neutral",
"store_name": "PrintPalaceStudio",
"shop_id": 27403561
},
{
"id": 963247815,
"image": "https://i.etsystatic.com/19832746/r/il/a81f02/2954187236/il_794xN.2954187236_p9xd.jpg",
"name": "Large Framed Canvas Wall Art, Mountain Landscape Painting, Living Room Decor",
"create_date": 1612843902,
"currency_code": "GBP",
"country_code": "GB",
"sale": 6420,
"sale_growth": 58,
"review": 1532,
"review_growth": 12,
"collect": 28764,
"collect_growth": 203,
"view": 0,
"view_growth": 0,
"real_sale": 6420,
"real_sale_growth": 58,
"bestseller": 0,
"etsy_pick": 1,
"product_type": ["Handmade"],
"is_video": 1,
"price": 64.5,
"url": "https://www.etsy.com/listing/963247815/large-framed-canvas-wall-art-mountain",
"store_name": "NordicCanvasCo",
"shop_id": 19832746
}
],
"page": {
"page_count": 206438,
"current_page": 1,
"total_count": 412876,
"page_size": 2
}
},
"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 |
| »» data | [object] | true | none | Product list |
| »»» id | integer | true | none | Product ID |
| »»» image | string | true | none | Main image |
| »»» name | string | true | none | Product title |
| »»» create_date | integer | true | none | Listing date (Unix timestamp, seconds) |
| »»» currency_code | string | true | none | Price currency |
| »»» country_code | string | true | none | Shop country/region code |
| »»» sale | integer | true | none | Total sales |
| »»» sale_growth | integer | true | none | Sales growth in the last 7 days |
| »»» review | integer | true | none | Total reviews |
| »»» review_growth | integer | true | none | Review growth in the last 7 days |
| »»» collect | integer | true | none | Total favorites |
| »»» collect_growth | integer | true | none | Favorite growth in the last 7 days |
| »»» view | integer | true | none | Total views |
| »»» view_growth | integer | true | none | View growth in the last 7 days |
| »»» real_sale | integer | true | none | Real sales |
| »»» real_sale_growth | integer | true | none | Real sales growth in the last 7 days |
| »»» bestseller | integer | true | none | Bestseller: 1 = yes, 0 = no |
| »»» etsy_pick | integer | true | none | Etsy's Pick: 1 = yes, 0 = no |
| »»» product_type | [string] | true | none | Product types: Digital, Handmade, Vintage, Customizable, Others |
| »»» is_video | integer | true | none | Has video: 1 = yes, 0 = no |
| »»» price | number | true | none | Price (in currency_code) |
| »»» url | string | true | none | Product URL |
| »»» store_name | string | true | none | Shop name |
| »»» shop_id | integer | true | none | Shop ID |
| »» page | object | true | none | Pagination |
| »»» page_count | integer | true | none | Total pages |
| »»» current_page | integer | true | none | Current page number |
| »»» total_count | integer | true | none | Total records |
| »»» page_size | integer | true | none | Items per page |
| » 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 |
