EtshopAPI Platform
EN / 中文
API REFERENCE

Group List API

GET/v1/monitor/group-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/group-list' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}'

Request parameters

Parameter Type Description
This endpoint does not require parameters.

Response example

Response · JSON
{
    "code": 200,
    "message": "success",
    "data": {
        "group_list": [
            {
                "id": "3f9c2a7e5b1d4c8e9a6f0b2d7e4c1a95",
                "group_name": "Wall Art Competitors",
                "shop_count": 2
            },
            {
                "id": "b84e1d03c7a259f6e0d2a7c4b913f58e",
                "group_name": "Jewelry",
                "shop_count": 0
            }
        ],
        "all_count": 3
    },
    "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
»» group_list [object] true none Groups
»»» id string true none Group ID (32-character string)
»»» group_name string true none Group name
»»» shop_count integer true none Number of shops currently monitored in this group
»» all_count integer true none Total number of shops currently monitored (including ungrouped ones)
» 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