POSThttps://api.nexscope.ai/api/skill-api/v1/skills/etsy-store-query/run

Run this API

Send a JSON request to execute this API and receive the documented response payload.

Endpoint

Method	`POST`
Path	`https://api.nexscope.ai/api/skill-api/v1/skills/etsy-store-query/run`
Auth	`Bearer API key`
Content-Type	`application/json`

Request parameters

Name	Type	Required	Description
`searchKey`	`string`	optional	Store name, keyword, or Etsy store URL. Example: Lewshop1
`category`	`string`	optional	Primary store category. Example: Jewelry
`country`	`string`	optional	Store country or region. Example: US
`status`	`integer`	optional	Store status: 1 active, 0 inactive. Example: 1
`isRaving`	`integer`

Code example

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

Response example

Platform response envelope. code 0 indicates success or acceptance; data contains the business result.

{
  "data": {
    "total": 1,
    "storeNum": 1,
    "stores": [
      {
        "storeId": "123456",
        "storeName": "Lewshop1",
        "storeUrl": "https://www.etsy.com/shop/Lewshop1",
        "country": [],
        "category": [],
        "salesTotal": 1,
        "salesWeekly": 1,
        "reviews": 1,
        "favorites": 1,
        "rating": 4.8,
        "status": 1
      }
    ],
    "columns": [],
    "costToken": 3600
  },
  "code": 0,
  "msg": null,
  "ts": "0",
  "time": "2026-01-01 00:00:00",
  "cost": "-1",
  "traceId": null
}

Response fields

Name	Type	Required	Description
`data`	`any`	required	Data value used by this API operation.
`code`	`integer`	required	0 means accepted or successful; nonzero is a platform error.
`msg`	`string \| null`	required	Msg value used by this API operation.
`ts`	`string`	required	Epoch milliseconds.
`time`	`string`	required	Server local time: yyyy-MM-dd HH:mm:ss.
`cost`

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.

Name

Type

Required

Description

data

object

required

Data value used by this API operation.

data.total

integer

optional

Records returned on the current page.

Example: 1

data.storeNum

integer

optional

Total matching stores.

Example: 1

data.stores

array

optional

Etsy stores.

Example: []

data.stores[]

object

required

Item in data stores.

data.stores[].storeId

string

optional

Store identifier.

Example: 123456

data.stores[].storeName

string

optional

Store name.

Example: Lewshop1

data.stores[].storeUrl

string

optional

Etsy store URL.

Example: https://www.etsy.com/shop/Lewshop1

data.stores[].logoUrl

string

optional

Store avatar URL.

Example: null

data.stores[].shopWebsite

string

optional

Store website or external link.

Example: null

data.stores[].startAt

string

optional

Store opening date.

Example: null

data.stores[].country

array

optional

Store countries or regions.

Example: []

data.stores[].category

array

optional

Primary categories.

Example: []

data.stores[].productCount

integer

optional

Store product count.

Example: null

data.stores[].salesTotal

integer

optional

Total sales.

Example: 1

data.stores[].salesWeekly

integer

optional

Weekly sales.

Example: 1

data.stores[].reviews

integer

optional

Review count.

Example: 1

data.stores[].reviewsWeekly

integer

optional

Weekly new review count.

Example: null

data.stores[].favorites

integer

optional

Favorite count.

Example: 1

data.stores[].favoritesWeekly

integer

optional

Weekly new favorite count.

Example: null

data.stores[].rating

number

optional

Store rating.

Example: 4.8

data.stores[].isRaving

integer

optional

Raving store indicator: 1 means yes.

Example: null

data.stores[].isStar

integer

optional

Star store indicator: 1 means yes.

Example: null

data.stores[].status

integer

optional

Store status.

Example: 1

data.sourceTool

string

optional

Tool type: ehunt.

Example: null

data.sourceType

string

optional

Source type: etsy.

Example: null

data.title

string

optional

Response title.

Example: null

data.type

string

optional

Render style.

Example: null

data.columns

array

optional

Provider rendering columns.

Example: []

data.costToken

integer

optional

Provider-reported token cost.

Example: 3600

data.costTime

integer

optional

Execution time reported by the upstream provider.

Example: null

data.page

integer

optional

Current page returned by the upstream provider.

Example: null

data.pageSize

integer

optional

Page size returned by the upstream provider.

Example: null

data.pageItemCount

integer

optional

Item count on the current page returned by the upstream provider.

Example: null

data.totalPage

integer

optional

Total page count returned by the upstream provider.

Example: null

data.dataSnapshotMonth

string

optional

Data snapshot month returned by the upstream provider.

Example: null

Name

Type

Required

Description

data

null

required

Data value used by this API operation.

Etsy Store Query

What this API does

Etsy Store Query

What this API does

Authentication

Run an API

Example request

Check the response

HTTP status codes

Run this API

Endpoint

Request parameters

Code example

Response example

Response fields

Responses

Data source, freshness, and limitations

MCP

Call a tool

Legacy MCP v1

Online test

Try it

Related APIs

Any of option 1

Any of option 2