EtshopAPI Platform
EN / 中文
API REFERENCE

Shop Details API

GET/v1/shop/{id}
2 Credits per call. If the shop does not exist, 404 is returned and nothing is charged.·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/shop/21475836' \
--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
id
path · required
integer Shop ID

Response example

Response · JSON
{
    "code": 200,
    "message": "success",
    "data": {
        "id": 21475836,
        "image": "https://i.etsystatic.com/isla/7a1c3e/58213467/isla_fullxfull.58213467_k2m9x0qa.jpg",
        "name": "LunaLinenStudio",
        "store_ratings": 4.9,
        "star_seller": 1,
        "reviews": 15830,
        "views": 2903417,
        "sale": 86214,
        "collect": 48270,
        "avg_price": 68.4,
        "country_code": "LT",
        "currency_code": "EUR",
        "product_on_sale": 398,
        "headline": "Handmade linen bedding & table linens from Lithuania",
        "url": "https://www.etsy.com/shop/LunaLinenStudio",
        "product_type": ["Handmade", "Customizable"],
        "create_date": 1462147200,
        "location": "Vilnius, Lithuania",
        "shop_languages": ["en-US", "de"],
        "close_time": 0,
        "open_day": 0,
        "sold_count_30": 5216,
        "is_real_sale": 1,
        "popular_category_arr": [
            {
                "category_arr": ["Home & Living", "Bedding", "Duvet Covers"],
                "percentage": "0.38"
            },
            {
                "category_arr": ["Home & Living", "Kitchen & Dining", "Kitchen & Table Linens"],
                "percentage": "0.27"
            },
            {
                "category_arr": ["Clothing", "Women's Clothing", "Dresses"],
                "percentage": "0.12"
            }
        ],
        "product_type_arr": [
            {
                "product_type": "Handmade",
                "percentage": "0.81"
            },
            {
                "product_type": "Customizable",
                "percentage": "0.44"
            },
            {
                "product_type": "Other",
                "percentage": "0.06"
            }
        ]
    },
    "credits": {
        "type": "default",
        "remaining_credits": 196533,
        "consumed_credits": 2,
        "total_credits": 196535
    }
}
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 Shop details
»» id integer true none Shop ID
»» image string true none Shop icon
»» name string true none Shop name
»» store_ratings number true none Shop rating (0–5)
»» star_seller integer true none Star Seller: 1 yes, 0 no
»» reviews integer true none Total reviews
»» views integer true none Total views
»» sale integer true none Total sales
»» collect integer true none Total favorites
»» avg_price number true none Average product price (USD)
»» country_code string true none Shop country/region code
»» currency_code string true none Shop currency
»» product_on_sale integer true none Number of active listings
»» headline string true none Shop headline
»» url string true none Shop URL
»» product_type [string] true none Product types: Handmade, Digital, Vintage, Customizable, Others
»» create_date integer true none Shop opening time (Unix timestamp, seconds)
»» location string true none Shop location
»» shop_languages [string] true none Shop languages
»» close_time integer true none Shop closing time (Unix timestamp, seconds); 0 for open shops
»» open_day integer true none Days in business (from opening to closing); only meaningful for closed shops (close_time > 0), 0 for open shops
»» sold_count_30 integer true none Sales in the last 30 days; for closed shops, sales in the 30 days before closing
»» is_real_sale integer true none Whether the shop has real sales data: 1 yes, 0 no
»» popular_category_arr [object] true none Popular categories (up to 5), sorted by share in descending order
»»» category_arr [string] true none Category path, from the top-level category down to this category
»»» percentage string true none Share of the shop's products in this category, 0–1, 2 decimal places
»» product_type_arr [object] true none Product type distribution
»»» product_type string true none Product type; products without a type are grouped as Other
»»» percentage string true none Share of products of this type, 0–1, 2 decimal places
» 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 (2 for this endpoint)
»» total_credits integer true none Credits balance before this request (remaining_credits + consumed_credits)
Search the existing endpoint names and paths