EtshopAPI Platform
EN / 中文
API REFERENCE

Add Shop Monitors API

POST/v1/monitor/add-monitor-site
Each successfully added shop deducts 1 Monitor Credit and is monitored for 30 days·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 POST 'https://api.etshop.ai/open-api/v1/monitor/add-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"
    ],
    "group_id": "3f9c2a7e5b1d4c8e9a6f0b2d7e4c1a95"
}'

Request parameters 3 fields

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.
» group_id
body · optional
string | null Group ID (32-character string). See Group List. Omit it to leave the shops ungrouped. If the group does not exist, the whole request returns 400 and nothing is charged.

Response example

Response · JSON
{
    "code": 200,
    "message": "success",
    "data": {
        "total": 3,
        "added_count": 2,
        "removed_count": 1,
        "details": [
            {
                "url": "https://www.etsy.com/shop/PrintPalaceStudio",
                "code": 200,
                "message": "success"
            },
            {
                "url": "NordicCanvasCo",
                "code": 200,
                "message": "success"
            },
            {
                "url": "https://www.etsy.com/shop/OldVintageFinds",
                "code": 400,
                "message": "Store closed"
            }
        ]
    },
    "credits": {
        "type": "monitor_credits",
        "remaining_credits": 98,
        "consumed_credits": 2,
        "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 successfully added
»» removed_count integer true none Number of shops that failed to be added
»» details [object] true none Result of each shop
»»» url string true none Submitted shop name or URL
»»» code integer true none Result: 200 = added; 409 = already being monitored; 400 = failed 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 actually consumed by this request (= number of shops added)
»» total_credits integer true none Total Monitor Credits
Search the existing endpoint names and paths