API REFERENCE
Monitor Details API
GET
/v1/monitor/detailFree·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/monitor/detail?shop_name=PrintPalaceStudio' \
--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 |
|---|---|---|
| shop_name
query · required
| string | Shop name (exact match), i.e. the name returned by Monitor List |
Response example
Response · JSON
{
"code": 200,
"message": "success",
"data": {
"shop": {
"id": 1024,
"monitor_task_started_at": 1793521800,
"monitor_task_reported_at": 1794380400,
"shop_id": 27403561,
"name": "PrintPalaceStudio",
"image": "https://i.etsystatic.com/isla/8c1f2a/58213947/isla_500x500.58213947_d3k9xw1p.jpg",
"url": "https://www.etsy.com/shop/PrintPalaceStudio",
"headline": "Printable wall art & modern digital prints",
"country_code": "US",
"currency_code": "USD",
"create_date": 1514764800,
"open_day": 3237,
"additional_customization": 1,
"is_open": 1,
"have_sold_page": 1,
"sold_count": 48263,
"avg_price": 9.85,
"revenue": 475390.55,
"active_listing_count": 1268,
"total_rating_count": 9734,
"total_share_count": 21456
}
},
"credits": {
"type": "monitor_credits",
"remaining_credits": 98,
"consumed_credits": 0,
"total_credits": 100
}
}
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 |
| »» shop | object | true | none | Shop and monitor information |
| »»» id | integer | true | none | Monitor ID |
| »»» monitor_task_started_at | integer | true | none | Start time of the current monitoring period (Unix timestamp, seconds) |
| »»» monitor_task_reported_at | integer | null | true | none | Last time the monitoring data was updated (Unix timestamp, seconds) |
| »»» shop_id | integer | true | none | Shop ID |
| »»» name | string | true | none | Shop name |
| »»» image | string | true | none | Shop icon |
| »»» url | string | true | none | Shop URL |
| »»» headline | string | true | none | Shop headline |
| »»» country_code | string | true | none | Shop country/region code |
| »»» currency_code | string | true | none | Shop currency |
| »»» create_date | integer | true | none | Shop opening date (Unix timestamp, seconds) |
| »»» open_day | integer | true | none | Days since the shop opened |
| »»» additional_customization | integer | true | none | Supports personalization: 1 = yes, 0 = no |
| »»» is_open | integer | true | none | Shop status: 1 = open, 0 = closed |
| »»» have_sold_page | integer | true | none | Whether the shop has a public sold page: 1 = yes, 0 = no |
| »»» sold_count | integer | true | none | Total shop sales |
| »»» avg_price | number | true | none | Average listing price (USD) |
| »»» revenue | number | true | none | Estimated total revenue (avg_price × sold_count, USD) |
| »»» active_listing_count | integer | true | none | Number of active listings |
| »»» total_rating_count | integer | true | none | Total shop reviews |
| »»» total_share_count | integer | true | none | Shop favorites |
| » credits | object | true | none | Credits information of this request. See Billing Rules. |
| »» type | string | true | none | Credits type. monitor_credits for this endpoint. |
| »» remaining_credits | integer | true | none | Remaining Monitor Credits after this request |
| »» consumed_credits | integer | true | none | Monitor Credits consumed by this request (0 for this endpoint) |
| »» total_credits | integer | true | none | Total Monitor Credits |
