Etsy Marketplace

Etsy Store Query

Returns Etsy store profiles and marketplace performance metrics.

post/api/skill-api/v1/skills/etsy-store-query/run

Request

  • Base URL: https://api.nexscope.ai
  • URL: https://api.nexscope.ai/api/skill-api/v1/skills/etsy-store-query/run
  • Auth: HTTP bearer

Headers

X-Nexscope-Http-Status'legacy' | 'semantic'

Use semantic for HTTP error statuses on run and task-result requests. Without this header v1 retains legacy status behavior. The JSON envelope is unchanged; code 0 means success or acceptance, not asynchronous completion.

Request body

searchKeystring

Store name, keyword, or Etsy store URL.

categorystring

Primary store category.

countrystring

Store country or region.

statusinteger

Store status: 1 active, 0 inactive.

isRavinginteger

Raving store flag: 1 yes.

isStarinteger

Star store flag: 1 yes.

beginFavoritesinteger

Minimum total favorites.

endFavoritesinteger

Maximum total favorites.

beginFavoritesWeeklyinteger

Minimum weekly favorites.

endFavoritesWeeklyinteger

Maximum weekly favorites.

beginReviewsinteger

Minimum total reviews.

endReviewsinteger

Maximum total reviews.

beginReviewsWeeklyinteger

Minimum weekly reviews.

endReviewsWeeklyinteger

Maximum weekly reviews.

beginSalesinteger

Minimum total sales.

endSalesinteger

Maximum total sales.

beginSalesWeeklyinteger

Minimum weekly sales.

endSalesWeeklyinteger

Maximum weekly sales.

beginStoreOpenedAtstring

Opening date range start in YYYY-MM-DD format.

endStoreOpenedAtstring

Opening date range end in YYYY-MM-DD format.

sortByinteger

Sort field: 8 total sales, 9 weekly sales, 10 reviews, 11 favorites.

sortDescinteger

Sort direction: 1 descending, 0 ascending.

pageinteger

Page number starting from 1.

pageSizeinteger

Items per page from 1 to 100.

Example request

{
  "page": 1,
  "searchKey": "Lewshop1",
  "pageSize": 20
}

Response

Successful response.

codeinteger required

0 means accepted or successful; nonzero is a platform error.

msgstring nullable required
tsstring required

Epoch milliseconds.

timestring required

Server local time: yyyy-MM-dd HH:mm:ss.

coststring required

Elapsed milliseconds, never credits; -1 outside web requests.

traceIdstring nullable required

Example response

{
  "data": {
    "total": 1,
    "storeNum": 1,
    "stores": [],
    "costToken": 3600
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.