API REFERENCE
Monitored Product Real Sales API
GET
/v1/monitor/real-sale-listFree·api.etshop.ai/open-apiCredits 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
AUTHORIZATION
Authorization: {API Key}CONTENT-TYPE
application/jsonACCEPT
application/jsonRequest example
cURL
curl --location --request GET 'https://api.etshop.ai/open-api/v1/monitor/real-sale-list?shop_name=PrintPalaceStudio&page=1&per_page=10&order_by=real_sale&direction=desc' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}' Request parameters
Pass each parameter in its specified location.
| Parameter | Type | Description |
|---|---|---|
| shop_name
query · required
| string | Shop name (exact match), i.e. the name returned by Monitor List |
| 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: real_sale (real sales), real_revenue (real revenue), product_created_at (listing date). Records are sorted by creation order if omitted. |
| 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": [
{
"product_id": 1188235614,
"shop_id": 27403561,
"name": "Abstract Boho Wall Art Set of 3, Neutral Printable Wall Art, Mid Century Modern Prints",
"image": "https://i.etsystatic.com/27403561/r/il/5c7e1a/3952184720/il_794xN.3952184720_k2m8.jpg",
"url": "https://www.etsy.com/listing/1188235614/abstract-boho-wall-art-set-of-3-neutral",
"bestseller": 1,
"currency_code": "USD",
"price": 9.6,
"real_sale": 214,
"real_revenue": 2054.4,
"product_created_at": 1645512331
},
{
"product_id": 1402776358,
"shop_id": 27403561,
"name": "Sage Green Botanical Prints, Set of 6 Printable Wall Art, Vintage Leaf Illustrations",
"image": "https://i.etsystatic.com/27403561/r/il/9d03be/4615827390/il_794xN.4615827390_x7cq.jpg",
"url": "https://www.etsy.com/listing/1402776358/sage-green-botanical-prints-set-of-6",
"bestseller": 0,
"currency_code": "USD",
"price": 11.4,
"real_sale": 87,
"real_revenue": 991.8,
"product_created_at": 1676893450
}
],
"first_page_url": "https://api.etshop.ai/open-api/v1/monitor/real-sale-list?page=1",
"from": 1,
"last_page": 27,
"last_page_url": "https://api.etshop.ai/open-api/v1/monitor/real-sale-list?page=27",
"next_page_url": "https://api.etshop.ai/open-api/v1/monitor/real-sale-list?page=2",
"path": "https://api.etshop.ai/open-api/v1/monitor/real-sale-list",
"per_page": 10,
"prev_page_url": null,
"to": 10,
"total": 263
},
"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 | Products |
| »»» product_id | integer | true | none | Product ID |
| »»» shop_id | integer | true | none | Shop ID |
| »»» name | string | true | none | Product title |
| »»» image | string | true | none | Main image |
| »»» url | string | true | none | Product URL |
| »»» bestseller | integer | true | none | Bestseller: 1 = yes, 0 = no |
| »»» currency_code | string | true | none | Price currency |
| »»» price | number | true | none | Price |
| »»» real_sale | integer | true | none | Real sales during the monitoring period |
| »»» real_revenue | number | true | none | Real revenue during the monitoring period (price × real_sale) |
| »»» product_created_at | integer | true | none | Listing date (Unix timestamp, seconds) |
| »» 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 |
