EtshopAPI Platform
EN / 中文
API REFERENCE

Monitor List API

GET/v1/monitor/list
Free·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 GET 'https://api.etshop.ai/open-api/v1/monitor/list?group_id=3f9c2a7e5b1d4c8e9a6f0b2d7e4c1a95&page=1&per_page=10&order_by=sold_count_7&direction=desc' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}'

Request parameters 6 fields

Pass each parameter in its specified location.

Parameter Type Description
shop_name
query · optional
string Shop name or shop URL (fuzzy match)
group_id
query · optional
string Group ID (32-character string). See Group List. Omit it to return all. 400 is returned if the group does not exist.
page
query · optional
integer Page number (min: 1, default: 1).
per_page
query · optional
integer Items per page (range: 1-100, default: 10).
order_by
query · optional
string Sort field. Valid options: sold_count, sold_count_1, sold_count_7, sold_count_total, product_count, product_count_1, product_count_7, product_count_total, favorites_count, favorites_count_1, favorites_count_7, favorites_count_total, total_rating_count, total_rating_count_1, total_rating_count_7, total_rating_count_total. Default: sold_count.
direction
query · optional
string Sort direction. Valid options: desc (descending, default), asc (ascending).

Response example

Response · JSON
{
    "code": 200,
    "message": "success",
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 1024,
                "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",
                "additional_customization": 1,
                "is_open": 1,
                "have_sold_page": 1,
                "group_id": "3f9c2a7e5b1d4c8e9a6f0b2d7e4c1a95",
                "sold_count": 37,
                "sold_count_1": 142,
                "sold_count_7": 968,
                "sold_count_total": 1385,
                "product_count": 0,
                "product_count_1": 3,
                "product_count_7": 11,
                "product_count_total": 16,
                "total_rating_count": 4,
                "total_rating_count_1": 19,
                "total_rating_count_7": 121,
                "total_rating_count_total": 176,
                "favorites_count": 58,
                "favorites_count_1": 233,
                "favorites_count_7": 1504,
                "favorites_count_total": 2187,
                "ended_at": 1796113800
            },
            {
                "id": 1025,
                "shop_id": 19832746,
                "name": "NordicCanvasCo",
                "image": "https://i.etsystatic.com/isla/2b7d90/41728365/isla_500x500.41728365_m7q2fz8c.jpg",
                "url": "https://www.etsy.com/shop/NordicCanvasCo",
                "headline": "Framed canvas prints inspired by Scandinavian landscapes",
                "country_code": "GB",
                "currency_code": "GBP",
                "additional_customization": 0,
                "is_open": 1,
                "have_sold_page": 0,
                "group_id": "3f9c2a7e5b1d4c8e9a6f0b2d7e4c1a95",
                "sold_count": 6,
                "sold_count_1": 21,
                "sold_count_7": 147,
                "sold_count_total": 452,
                "product_count": 1,
                "product_count_1": 0,
                "product_count_7": 4,
                "product_count_total": 9,
                "total_rating_count": 1,
                "total_rating_count_1": 3,
                "total_rating_count_7": 18,
                "total_rating_count_total": 57,
                "favorites_count": 12,
                "favorites_count_1": 47,
                "favorites_count_7": 309,
                "favorites_count_total": 988,
                "ended_at": 1795050000
            }
        ],
        "first_page_url": "https://api.etshop.ai/open-api/v1/monitor/list?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "https://api.etshop.ai/open-api/v1/monitor/list?page=1",
        "next_page_url": null,
        "path": "https://api.etshop.ai/open-api/v1/monitor/list",
        "per_page": 10,
        "prev_page_url": null,
        "to": 2,
        "total": 2
    },
    "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
»» current_page integer true none Current page number
»» data [object] true none Monitors
»»» id integer true none Monitor ID, used by Stop Monitors, Move to Group, etc.
»»» shop_id integer true none Shop ID
»»» name string true none Shop name; use it as the shop_name parameter of Monitor Details and related endpoints
»»» 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
»»» 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 (real sales per product can be tracked), 0 = no
»»» group_id string | null true none Group ID; null if ungrouped
»»» sold_count integer true none Sales growth today
»»» sold_count_1 integer true none Sales growth yesterday
»»» sold_count_7 integer true none Sales growth in the last 7 days (including today)
»»» sold_count_total integer true none Sales growth since monitoring started
»»» product_count integer true none Listing count growth today
»»» product_count_1 integer true none Listing count growth yesterday
»»» product_count_7 integer true none Listing count growth in the last 7 days
»»» product_count_total integer true none Listing count growth since monitoring started
»»» total_rating_count integer true none Review growth today
»»» total_rating_count_1 integer true none Review growth yesterday
»»» total_rating_count_7 integer true none Review growth in the last 7 days
»»» total_rating_count_total integer true none Review growth since monitoring started
»»» favorites_count integer true none Favorite growth today
»»» favorites_count_1 integer true none Favorite growth yesterday
»»» favorites_count_7 integer true none Favorite growth in the last 7 days
»»» favorites_count_total integer true none Favorite growth since monitoring started
»»» ended_at integer true none Expiry time (Unix timestamp, seconds); the monitor stops automatically at this time
»» first_page_url string true none URL of the first page
»» from integer | null true none Index of the first item on this page
»» last_page integer true none Last page number
»» last_page_url string true none URL of the last page
»» next_page_url string | null true none URL of the next page
»» path string true none Endpoint URL
»» per_page integer true none Items per page
»» prev_page_url string | null true none URL of the previous page
»» to integer | null true none Index of the last item on this page
»» total integer true none Total records
» 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
Search the existing endpoint names and paths