EtshopAPI Platform
EN / 中文
API REFERENCE

Category List API

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

Request parameters 1 fields

Pass each parameter in its specified location.

Parameter Type Description
shop_id
query · optional
integer Shop ID. If provided, only categories in which this shop has products are returned; otherwise all categories are returned.

Response example

Response · JSON
{
    "code": 200,
    "message": "success",
    "data": {
        "data": [
            {
                "id": 66,
                "name": "Home & Living",
                "children": [
                    {
                        "id": 891,
                        "name": "Home Decor",
                        "children": [
                            {
                                "id": 1028,
                                "name": "Wall Decor",
                                "children": null
                            },
                            {
                                "id": 1035,
                                "name": "Candles & Holders",
                                "children": null
                            }
                        ]
                    },
                    {
                        "id": 1002,
                        "name": "Kitchen & Dining",
                        "children": [
                            {
                                "id": 1107,
                                "name": "Drink & Barware",
                                "children": null
                            }
                        ]
                    }
                ]
            },
            {
                "id": 68887494,
                "name": "Jewelry",
                "children": [
                    {
                        "id": 68887420,
                        "name": "Necklaces",
                        "children": null
                    }
                ]
            }
        ]
    },
    "credits": {
        "type": "default",
        "remaining_credits": 196540,
        "consumed_credits": 0,
        "total_credits": 196540
    }
}
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
»» data [object] true none Top-level categories
»»» id integer true none Category ID
»»» name string true none Category name
»»» children [object] | null true none Second-level categories; null if there are none
»»»» id integer true none Category ID
»»»» name string true none Category name
»»»» children [object] | null true none Third-level categories; null if there are none
»»»»» id integer true none Category ID
»»»»» name string true none Category name
»»»»» children null true none Always null
» credits object true none Credits information of this request. See Billing Rules.
»» type string true none Credits type. default for this endpoint.
»» remaining_credits integer true none Remaining Credits after this request
»» consumed_credits integer true none Credits consumed by this request (0 for this endpoint)
»» total_credits integer true none Credits balance before this request (remaining_credits + consumed_credits)
Search the existing endpoint names and paths