API REFERENCE
Check Shops API
POST
/v1/monitor/check-monitor-siteFree·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 POST 'https://api.etshop.ai/open-api/v1/monitor/check-monitor-site' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}' \
--data-raw '{
"urls": [
"https://www.etsy.com/shop/PrintPalaceStudio",
"NordicCanvasCo",
"https://www.etsy.com/shop/OldVintageFinds"
]
}' Request parameters
Pass each parameter in its specified location.
| Parameter | Type | Description |
|---|---|---|
| body
body · required
| object | Request body (JSON) |
| » urls
body · required
| [string] | Shop names or shop URLs, e.g. PrintPalaceStudio or https://www.etsy.com/shop/PrintPalaceStudio. Up to 50. |
Response example
Response · JSON
{
"code": 200,
"message": "success",
"data": {
"total": 3,
"added_count": 1,
"removed_count": 2,
"details": [
{
"url": "https://www.etsy.com/shop/PrintPalaceStudio",
"code": 200,
"message": "success"
},
{
"url": "NordicCanvasCo",
"code": 409,
"message": "Your store has already been added, no need to submit again."
},
{
"url": "https://www.etsy.com/shop/OldVintageFinds",
"code": 400,
"message": "Store closed"
}
]
},
"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 |
| »» total | integer | true | none | Number of submitted shops |
| »» added_count | integer | true | none | Number of shops that can be monitored |
| »» removed_count | integer | true | none | Number of shops that cannot be monitored |
| »» details | [object] | true | none | Check result of each shop |
| »»» url | string | true | none | Submitted shop name or URL |
| »»» code | integer | true | none | Result: 200 = can be monitored; 409 = already being monitored; 400 = cannot be monitored for other reasons (URL cannot be parsed, shop closed, shop temporarily unavailable, etc.), see message |
| »»» message | string | true | none | Result message |
| » 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 |
