EtshopAPI Platform
EN / 中文
API REFERENCE

Current Credits API

Query your Credits, Keyword Credits and Monitor Credits balances in one call.

GET/v1/credits
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/credits' \
--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": {
        "default": {
            "label": "Credits",
            "total_credits": 200000,
            "used_credits": 3460,
            "credits": 196540,
            "purchased_credits": 200000
        },
        "keyword_credits": {
            "label": "Keyword Credits",
            "total_credits": 50000,
            "used_credits": 129,
            "credits": 49871,
            "purchased_credits": 50000
        },
        "monitor_credits": {
            "label": "Monitor Credits",
            "total_credits": 20,
            "used_credits": 3,
            "credits": 17,
            "purchased_credits": 20
        }
    }
}
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, keyed by Credits type
»» default object true none Credits (used by shop and product endpoints)
»»» label string true none Type name, always Credits
»»» total_credits integer true none Total Credits ever received
»»» used_credits integer true none Credits used
»»» credits integer true none Credits currently remaining
»»» purchased_credits integer true none Credits obtained through purchases
»» keyword_credits object true none Keyword Credits (used by Keyword Search)
»»» label string true none Type name, always Keyword Credits
»»» total_credits integer true none Total Keyword Credits ever received
»»» used_credits integer true none Keyword Credits used
»»» credits integer true none Keyword Credits currently remaining
»»» purchased_credits integer true none Keyword Credits obtained through purchases
»» monitor_credits object true none Monitor Credits (used by Shop Monitor; 1 credit = 1 shop monitored for 30 days)
»»» label string true none Type name, always Monitor Credits
»»» total_credits integer true none Total Monitor Credits ever received
»»» used_credits integer true none Monitor Credits used
»»» credits integer true none Monitor Credits currently remaining
»»» purchased_credits integer true none Monitor Credits obtained through purchases
Search the existing endpoint names and paths