https://api.nexscope.ai/etsy/product/detailRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/etsy/product/detail |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
productUrl | string | required | Etsy products HTTPS direct link. Userinfo must not be included; Host must be `etsy.com` or its subdomain, port must be omitted or `443`; path must be `/listing/<numeric ID>`, with at most one non-empty title slug, and can have trailing slashes and query parameters |
Code example
{
"productUrl": "https://www.etsy.com/listing/1710567856/its-okay-to-make-some-mistakes-shirt"
}Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "-1",
"data": {},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": null,
"ts": "0"
}Response fields
Response field reference (34 fields)
| Name | Type | Required | Description |
|---|---|---|---|
errcode | integer | optional | Business status code; `200` indicates success |
errmsg | string | optional | Business status message; `ok` on success |
data | array | optional | Array of product objects; fixed to 1 item when successful |
total | integer | optional | Fixed to `1` when successful |
costToken | integer | optional | Consume token |
type | string | optional | Fixed to `tableListWorkbenches` |
columns | array | optional | Rendering column definition generated based on product top-level fields |
productId | string | optional | Etsy listing ID |
shopId | string | optional | Store ID |
shopUrl | string | optional | Store URL; it may be empty or misidentified when the page is abnormal. |
shopSales | string | optional | Store public sales text |
shopName | string | optional | Store name; it may be empty or misidentified when the page is abnormal. |
productUrl | string | optional | Product URL |
searchPosition | string | optional | Source search location; usually empty for direct queries |
image | string | optional | Main image URL |
images | array | optional | Image URL list |
maxQuantity | integer | optional | Maximum available quantity reported on the page |
variants | array | optional | Product variations; empty array if no variations |
title | string | optional | Product title |
description | array | optional | list of description paragraphs |
shopReviews | integer | optional | Number of store reviews |
reviews | integer | optional | Current number of listing comments |
star | string | optional | Current rating, may be an empty string |
highlightsTags | array | optional | Buyer Feedback Highlights Tag |
reviewsTags | array | optional | Comment tags and frequency objects |
yearsOnEtsy | string | optional | How long your store has been public on Etsy |
hasRatingsBadge | boolean | optional | Is there a rating badge? |
hasConvosBadge | boolean | optional | Is there a communication badge? |
hasShippingBadge | boolean | optional | Is there a delivery badge? |
reviewsScores | object | optional | Dynamic review itemization; keys and values change from page to page |
category | string | optional | Category breadcrumbs |
countryShippingFrom | string | optional | Shipping country/region |
currency | string | optional | currency code |
moreLikeUrl | string | optional | Similar recommendation link, may be empty |
Responses
| Code | Description |
|---|---|
| 200 | HTTP request completed. Check JSON code; only 0 indicates business success or acceptance. |
| 400 | Request JSON or required API parameters are invalid. |
| 401 | API key is missing, invalid, or cannot be matched to a user. |
| 5xx | API execution or upstream service failed. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.