https://api.nexscope.ai/api/skill-api/v1/skills/etsy-category-search/runRun 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-category-search/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
keyword | string | required | Keyword: matches category name, category id, or parentIds fields (substring) Example: phone case |
page | integer | optional | Page number (starting from 1) Example: 1 |
pageSize | integer | optional | Items per page, max 200 Example: 1 |
Request example
{
"pageSize": 1,
"keyword": "phone case",
"page": 1
}Response body
| 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 | string | required | Elapsed milliseconds, never credits; -1 outside web requests. |
traceId | string | null | required | Trace id value used by this API operation. |
Any of option 1
| 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.title | string | optional | Title Example: null |
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.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 |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data | null | required | Data value used by this API operation. |
Response example
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
}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.