Etsy Category Search API
REST API and MCP service documentation generated from server-side API definitions. Responses use the shared code, msg, and data envelope.
API selector
REST API and MCP service documentation generated from server-side API definitions. Responses use the shared code, msg, and data envelope.
Find Etsy category IDs by category name, ID, or parent ID for product and store filtering. Review request and response fields.
https://api.nexscope.ai/api/skill-api/v1/skills/etsy-category-search/runnexscope_etsy_category_searchAll run endpoints require a user API key. Send it as a bearer token in the Authorization header.
Authorization: Bearer nk-xxxxxxxxxxxxxxxxxhttps://api.nexscope.ai/api/skill-api/v1/skills/etsy-category-search/runRequest parameters documented by ecommerce.etsy-category-search.
| Slug | etsy-category-search |
| Headers | Authorization: Bearer nk-...Content-Type: application/json |
| Request body | API-specific JSON object. |
| Response body | Platform envelope: code, msg, data, ts, time, cost, traceId. Inspect data.status for asynchronous completion. |
| 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. |
Replace YOUR_API_KEY, then run this command in your terminal.
curl -X POST 'https://api.nexscope.ai/api/skill-api/v1/skills/etsy-category-search/run' \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"pageSize": 1,
"keyword": "phone case",
"page": 1
}'https://api.nexscope.ai/api/skill-api/v1/skills/etsy-category-search/runSend a JSON request to execute this API and receive the documented response payload.
| Method | POST |
| Path | https://api.nexscope.ai/api/skill-api/v1/skills/etsy-category-search/run |
| Auth | Bearer API key |
| Content-Type | application/json |
| Name | Type | Required | Description |
|---|---|---|---|
keyword | string | required | Keyword, at most 200 characters; matches category name, category ID, or parentIds by substring Example: phone case |
page | integer | optional | Page number, starting from 1; defaults to 1 Example: 1 |
pageSize |
{
"pageSize": 1,
"keyword": "phone case",
"page": 1
}Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"data": {
"total": 1,
"costToken": 1,
"categories": [
{
"categoryLevel": 1,
"id": "example-id",
"parentId": "example-id"
}
]
},
"code": 0,
"msg": null,
"ts": "0",
"time": "2026-01-01 00:00:00",
"cost": "-1",
"traceId": null
}| 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 |
| 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. |
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.
Connect remote agents through the standard MCP 2025-11-25 Streamable HTTP endpoint. Use OAuth 2.1 Authorization Code with PKCE, or an API key for compatibility.
POST https://api.nexscope.ai/api/skill-api/v2/mcp
MCP-Protocol-Version: 2025-11-25
Content-Type: application/jsonOAuth clients request the mcp:tools scope. The endpoint's 401 response advertises protected-resource metadata for authorization discovery.
{
"jsonrpc": "2.0",
"id": "tool-call-1",
"method": "tools/call",
"params": {
"name": "nexscope_etsy_category_search",
"arguments": {
"pageSize": 1,
"keyword": "phone case",
"page": 1
}
}
}Existing API-key clients can continue using the compatibility endpoint. New integrations should use MCP v2.
GET / POST /api/skill-api/v1/mcpExecute the current API with your API key and JSON payload.
Send a real request with the same contract shown in the reference.
https://api.nexscope.ai/api/skill-api/v1/skills/etsy-category-search/runnexscope_etsy_category_searchcurl -X POST \
https://api.nexscope.ai/api/skill-api/v1/skills/etsy-category-search/run \
-H "Authorization: Bearer nk-..." \
-H "Content-Type: application/json" \
-d '{ "pageSize": 1, "keyword": "phone case", "page": 1 }'No response yet. Run the request to see the response here.
Retrieve public Etsy listing details from a validated marketplace URL for product, pricing, shop, and competitive research workflows.
Filter Etsy products by keyword, URL, price, sales, favorites, reviews, listing date, category, product type, and marketplace badges.
Search Etsy stores by keyword, category, country, status, ratings, sales, favorites, reviews, and opening date with pagination and sorting.
integer |
| optional |
Items per page, from 1 to 200; defaults to 50 Example: 50 |
string |
| required |
Epoch milliseconds. |
time | string | required | Server local time: yyyy-MM-dd HH:mm:ss. |
cost | string | required | Elapsed milliseconds, never credits; -1 outside web requests. |
traceId | string | null | required | Trace id value used by this API operation. |
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | Data value used by this API operation. |
data.total | integer | optional | Number of records returned on this page Example: 1 |
data.costToken | integer | optional | Token consumption (local retrieval is free) Example: 1 |
data.categories | array | optional | List of matching categories Example: [] |
data.categories[] | object | required | Item in data categories. |
data.categories[].categoryLevel | integer | optional | Category level Example: 1 |
data.categories[].id | string | optional | Category ID Example: example-id |
data.categories[].name | string | optional | Category name Example: null |
data.categories[].parentId | string | optional | Canonical primary parent category ID Example: example-id |
data.categories[].parentIds | string | optional | All non-empty parent category IDs (comma-separated) Example: null |
data.title | string | optional | Title Example: null |
data.type | string | optional | Provider-specific render or payload type. Example: null |
data.sourceType | string | optional | Provider-specific source platform type. Example: null |
data.sourceTool | string | optional | Provider-specific source tool name. Example: null |
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. |