API REFERENCE
Closed Shop List API
GET
/v1/shop/close-shop-list1 Credit per returned record. If your balance is insufficient, only as many records as your remaining Credits cover are returned (partial deduction); with a zero balance, 403001 is returned. Empty results are free.·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/shop/close-shop-list?close_time_start=2026-08-01&close_time_end=2026-10-31&order_by=sold_count_30&direction=desc¤t_page=1&page_size=1' \
--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 |
|---|---|---|
| name
query · optional
| string | Keywords matched against shop name or headline (fuzzy). Multiple values should be comma-separated; all must match. |
| sold_count_start
query · optional
| integer | Minimum total sales. |
| sold_count_end
query · optional
| integer | Maximum total sales. |
| sold_count_30_start
query · optional
| integer | Minimum sales in the 30 days before closing. |
| sold_count_30_end
query · optional
| integer | Maximum sales in the 30 days before closing. |
| total_rating_count_start
query · optional
| integer | Minimum total reviews. |
| total_rating_count_end
query · optional
| integer | Maximum total reviews. |
| favorites_count_start
query · optional
| integer | Minimum total favorites. |
| favorites_count_end
query · optional
| integer | Maximum total favorites. |
| avg_price_start
query · optional
| number | Minimum average product price (USD). |
| avg_price_end
query · optional
| number | Maximum average product price (USD). |
| total_product_num_start
query · optional
| integer | Minimum number of products in the shop. |
| total_product_num_end
query · optional
| integer | Maximum number of products in the shop. |
| mysql_product_num_start
query · optional
| integer | Minimum number of indexed products. |
| mysql_product_num_end
query · optional
| integer | Maximum number of indexed products. |
| average_rating_start
query · optional
| number | Minimum shop rating (0–5). |
| average_rating_end
query · optional
| number | Maximum shop rating (0–5). |
| country_code
query · optional
| string | Shop country/region code(s). Multiple values should be comma-separated. |
| product_type
query · optional
| string | Product type(s). Multiple values should be comma-separated. Valid options: Handmade, Digital, Vintage, Customizable, Others. |
| create_date_start
query · optional
| string | Shop opening date (from). Format: Y-m-d, e.g. 2023-01-01. |
| create_date_end
query · optional
| string | Shop opening date (to). Format: Y-m-d, e.g. 2023-12-31. |
| close_time_start
query · optional
| string | Shop closing date (from). Format: Y-m-d, e.g. 2026-08-01. |
| close_time_end
query · optional
| string | Shop closing date (to). Format: Y-m-d, e.g. 2026-10-31. |
| is_real_sale
query · optional
| integer | Whether the shop has real sales data: 1 yes, 0 no. |
| 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: sold_count_30 (sales in the 30 days before closing), close_time (closing time), total_sale (total sales), total_collection (total favorites), total_review (total reviews), create_date (opening time), total_product_num (products in the shop), mysql_product_num (indexed products). Defaults to sold_count_30. |
| direction
query · optional
| string | Sort direction. Valid options: desc (descending, default), asc (ascending). |
Response example
Response · JSON
{
"code": 200,
"message": "success",
"data": {
"data": [
{
"id": 27304519,
"image": "https://i.etsystatic.com/isla/5e9a07/64019283/isla_fullxfull.64019283_p3t8w1zr.jpg",
"name": "CozyKnitCorner",
"url": "https://www.etsy.com/shop/CozyKnitCorner",
"star_seller": 1,
"headline": "Chunky knit blankets, scarves and baby wraps",
"total_product_num": 186,
"mysql_product_num": 179,
"create_date": 1585267200,
"close_time": 1789920000,
"sold_count_30": 864,
"open_day": 2369,
"currency_code": "GBP",
"sold_count": 23517,
"total_rating_count": 4820,
"favorites_count": 12931,
"views": 1084526,
"avg_price": 42.9,
"country_code": "GB",
"best_selling_product": [
{
"id": 1023894571,
"images": ["https://i.etsystatic.com/27304519/r/il/3b6f20/3876543210/il_fullxfull.3876543210_gh78.jpg"]
}
]
}
],
"page": {
"page_count": 3127,
"current_page": 1,
"total_count": 3127,
"page_size": 1
}
},
"credits": {
"type": "default",
"remaining_credits": 196535,
"consumed_credits": 1,
"total_credits": 196536
}
}
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 | Shop list |
| »»» id | integer | true | none | Shop ID |
| »»» image | string | true | none | Shop icon |
| »»» name | string | true | none | Shop name |
| »»» url | string | true | none | Shop URL |
| »»» star_seller | integer | true | none | Star Seller: 1 yes, 0 no |
| »»» headline | string | true | none | Shop headline |
| »»» total_product_num | integer | true | none | Number of products in the shop |
| »»» mysql_product_num | integer | true | none | Number of indexed products |
| »»» create_date | integer | true | none | Shop opening time (Unix timestamp, seconds) |
| »»» close_time | integer | true | none | Shop closing time (Unix timestamp, seconds) |
| »»» sold_count_30 | integer | true | none | Sales in the 30 days before closing |
| »»» open_day | integer | true | none | Days in business (from opening to closing) |
| »»» currency_code | string | true | none | Shop currency |
| »»» sold_count | integer | true | none | Total sales |
| »»» total_rating_count | integer | true | none | Total reviews |
| »»» favorites_count | integer | true | none | Total favorites |
| »»» views | integer | true | none | Total views |
| »»» avg_price | number | true | none | Average product price (USD) |
| »»» country_code | string | true | none | Shop country/region code |
| »»» best_selling_product | [object] | true | none | Best-selling products (up to 3) |
| »»»» id | integer | true | none | Product ID |
| »»»» images | [string] | true | none | Main product image |
| »» 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. default for this endpoint. |
| »» remaining_credits | integer | true | none | Remaining Credits after this request |
| »» consumed_credits | integer | true | none | Credits consumed by this request, equal to the number of records returned |
| »» total_credits | integer | true | none | Credits balance before this request (remaining_credits + consumed_credits) |
