POST
https://api.nexscope.ai/eh/etsy/storeQueryRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/eh/etsy/storeQuery |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
beginFavorites | integer | optional | The number of store collections (starting), and the ending value form the upstream favorites |
beginFavoritesWeekly | integer | optional | The store adds new favorites in the week (start), which together with the end value form the upstream favorites_weekly |
beginReviews | integer | optional | The number of store reviews (starting), which together with the ending value form the upstream reviews |
beginReviewsWeekly | integer | optional | Added reviews for the store week (start), which together with the end value form the upstream reviews_weekly |
beginSales | integer | optional | The total sales volume of the store (starting), and the ending value form the upstream sales |
beginSalesWeekly | integer | optional | Store weekly sales (start), which together with the end value form the upstream sales_weekly, such as 10,100 |
beginStoreOpenedAt | string | optional | The start of the store opening time interval (YYYY-MM-DD), and the end date form the upstream start_at, such as 2020-01-01~2023-01-01 |
category | string | optional | Store main categories |
country | string | optional | Store country |
endFavorites | integer | optional | Number of store collections (end) |
endFavoritesWeekly | integer | optional | Store Weekly Added Favorites (Ended) |
endReviews | integer | optional | Number of store reviews (end) |
endReviewsWeekly | integer | optional | New comments for store week (end) |
endSales | integer | optional | Total store sales (end) |
endSalesWeekly | integer | optional | Store weekly sales (end) |
endStoreOpenedAt | string | optional | The store opening time interval ends (YYYY-MM-DD) |
isRaving | integer | optional | Whether Raving Shop: 1=Yes |
isStar | integer | optional | Whether to star the store: 1=Yes |
page | integer | optional | Page number (starting from 1) |
pageSize | integer | optional | Number of items per page, maximum 100 |
searchKey | string | optional | Search keywords or store name, store URL |
sortBy | integer | optional | Sorting field sort_by: 8=total sales, 9=weekly sales, 10=number of comments, 11=number of collections |
sortDesc | integer | optional | Sorting direction (corresponding to upstream desc): 1=descending order, 0=ascending order |
status | integer | optional | Store status: 1=active, 0=inactive |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
No response example is published for this API. Refer to the response fields below.
Response fields
Response field reference (27 fields)
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | optional | Number of records (number of records returned on this page) |
sourceType | string | optional | Source type: etsy |
stores | array | optional | Store list |
columns | array | optional | Rendered columns |
costToken | integer | optional | Token consumption (estimated based on the number of items returned on this page) |
storeNum | integer | optional | Total number of eligible stores (upstream store_num) |
title | string | optional | Title |
type | string | optional | Rendering style |
category | array | optional | List of main categories |
country | array | optional | Country list |
favorites | integer | optional | Number of collections |
favoritesWeekly | integer | optional | Number of new favorites per week |
isRaving | integer | optional | Whether Raving: 1=Yes |
isStar | integer | optional | Star or not: 1=Yes |
logoUrl | string | optional | Store avatar URL |
productCount | integer | optional | Store product quantity |
rating | number | optional | Rating |
reviews | integer | optional | Number of comments |
reviewsWeekly | integer | optional | New comments per week |
salesTotal | integer | optional | total sales |
salesWeekly | integer | optional | Weekly sales |
shopWebsite | string | optional | Store official website/external link |
startAt | string | optional | Store opening date |
status | integer | optional | Store status: 1=active, 0=inactive |
storeId | string | optional | Store ID |
storeName | string | optional | Store name |
storeUrl | string | optional | Store link |
Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
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.