Etsy Store Query API

REST API and MCP service documentation generated from server-side API definitions. Responses shown here are the direct payload returned by each API execution.

API selector

Etsy Marketplace

API overview

Search Etsy stores by keyword, category, country, status, ratings, sales, favorites, reviews, and opening date with pagination and sorting.

Try this API

Endpoint

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

MCP method

nexscope_etsy_store_query

Authentication

All run endpoints require a user API key. Send it as a bearer token in the Authorization header.

Authorization: Bearer nk_xxxxxxxxxxxxxxxxx

Missing or invalid API keys return an authentication error. Manage keys from .

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

Run an API

All filters are optional. Use searchKey to query a specific store name or URL.

Slug	`etsy-store-query`
Headers	`Authorization: Bearer nk_...` `Content-Type: application/json`
Request body	API-specific JSON object.
Response body	Direct API response payload. No data/result wrapper is added.

Status codes

Code	Description
200	API executed successfully. Body is the direct response payload.
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.

Example request

curl -X POST https://api.nexscope.ai/api/skill-api/v1/skills/etsy-store-query/run \
  -H "Authorization: Bearer nk_xxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{   "page": 1,   "pageSize": 20,   "searchKey": "Lewshop1" }'

All categories/ Etsy Marketplace

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 direct response payload.

Open tester

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 body

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`	optional	Raving store flag: 1 yes. Example: 1
`isStar`	`integer`	optional	Star store flag: 1 yes. Example: 1
`beginFavorites`	`integer`	optional	Minimum total favorites. Example: 0
`endFavorites`	`integer`	optional	Maximum total favorites. Example: 10000
`beginFavoritesWeekly`	`integer`	optional	Minimum weekly favorites. Example: 0
`endFavoritesWeekly`	`integer`	optional	Maximum weekly favorites. Example: 1000
`beginReviews`	`integer`	optional	Minimum total reviews. Example: 0
`endReviews`	`integer`	optional	Maximum total reviews. Example: 10000
`beginReviewsWeekly`	`integer`	optional	Minimum weekly reviews. Example: 0
`endReviewsWeekly`	`integer`	optional	Maximum weekly reviews. Example: 1000
`beginSales`	`integer`	optional	Minimum total sales. Example: 0
`endSales`	`integer`	optional	Maximum total sales. Example: 100000
`beginSalesWeekly`	`integer`	optional	Minimum weekly sales. Example: 0
`endSalesWeekly`	`integer`	optional	Maximum weekly sales. Example: 1000
`beginStoreOpenedAt`	`string`	optional	Opening date range start in YYYY-MM-DD format. Example: 2020-01-01
`endStoreOpenedAt`	`string`	optional	Opening date range end in YYYY-MM-DD format. Example: 2026-01-01
`sortBy`	`integer`	optional	Sort field: 8 total sales, 9 weekly sales, 10 reviews, 11 favorites. Example: 8
`sortDesc`	`integer`	optional	Sort direction: 1 descending, 0 ascending. Example: 1
`page`	`integer`	optional	Page number starting from 1. Example: 1
`pageSize`	`integer`	optional	Items per page from 1 to 100. Example: 20

Request example

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

Response body

Returns the Etsy store gateway payload directly.

Name	Type	Required	Description
`total`	`integer`	optional	Records returned on the current page. Example: 1
`storeNum`	`integer`	optional	Total matching stores. Example: 1
`stores`	`array`	optional	Etsy stores. Example: []
`stores[].storeId`	`string`	optional	Store identifier. Example: 123456
`stores[].storeName`	`string`	optional	Store name. Example: Lewshop1
`stores[].storeUrl`	`string`	optional	Etsy store URL. Example: https://www.etsy.com/shop/Lewshop1
`stores[].country`	`array`	optional	Store countries or regions. Example: []
`stores[].category`	`array`	optional	Primary categories. Example: []
`stores[].salesTotal`	`integer`	optional	Total sales. Example: 1
`stores[].salesWeekly`	`integer`	optional	Weekly sales. Example: 1
`stores[].reviews`	`integer`	optional	Review count. Example: 1
`stores[].favorites`	`integer`	optional	Favorite count. Example: 1
`stores[].rating`	`number`	optional	Store rating. Example: 4.8
`stores[].status`	`integer`	optional	Store status. Example: 1
`columns`	`array`	optional	Provider rendering columns. Example: []
`costToken`	`integer`	optional	Provider-reported token cost. Example: 3600
`errcode`	`integer`	optional	Upstream status code returned by the provider.
`errmsg`	`string`	optional	Upstream status message returned by the provider.
`code`	`string`	optional	Provider-specific status code.
`msg`	`string`	optional	Provider-specific status message.
`message`	`string`	optional	Provider-specific message.
`type`	`string`	optional	Provider-specific render or payload type.
`title`	`string`	optional	Provider-specific response title.
`sourceType`	`string`	optional	Provider-specific source platform type.
`sourceTool`	`string`	optional	Provider-specific source tool name.
`costTime`	`integer`	optional	Execution time reported by the upstream provider.
`page`	`integer`	optional	Current page returned by the upstream provider.
`pageSize`	`integer`	optional	Page size returned by the upstream provider.
`pageItemCount`	`integer`	optional	Item count on the current page returned by the upstream provider.
`totalPage`	`integer`	optional	Total page count returned by the upstream provider.
`dataSnapshotMonth`	`string`	optional	Data snapshot month returned by the upstream provider.

Response example

Direct response payload. No extra wrapper is added.

{
  "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
}

Responses

Code	Description
200	API executed successfully. Body is the direct response payload.
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.

Related APIs

Etsy Category Search API

Find Etsy category IDs by category name, ID, or parent ID for product and store filtering. Review request and response fields.

Etsy Product Query API

Filter Etsy products by keyword, URL, price, sales, favorites, reviews, listing date, category, product type, and marketplace badges.

MCP

Use the MCP endpoint when an agent needs to discover and call API tools with JSON-RPC.

GET /api/skill-api/v1/mcp

POST /api/skill-api/v1/mcp
Authorization: Bearer nk_xxxxxxxxxxxxxxxxx
Content-Type: application/json

Call a tool

{
  "jsonrpc": "2.0",
  "id": "tool-call-1",
  "method": "tools/call",
  "params": {
    "name": "nexscope_etsy_store_query",
    "arguments": {
      "page": 1,
      "pageSize": 20,
      "searchKey": "Lewshop1"
    }
  }
}

Online test

Execute the current API with your API key and JSON payload.

Try it

Send a real request with the same contract shown in the reference.

Endpoint

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

MCP method

nexscope_etsy_store_query

API key*

JSON payload*

cURL

curl -X POST \
  https://api.nexscope.ai/api/skill-api/v1/skills/etsy-store-query/run \
  -H "Authorization: Bearer nk-..." \
  -H "Content-Type: application/json" \
  -d '{ "page": 1, "pageSize": 20, "searchKey": "Lewshop1" }'

Response

No response yet. Run the request to see the response here.