POST
https://api.nexscope.ai/eh/etsy/etsyCategorySearchRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/eh/etsy/etsyCategorySearch |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
keyword | string | required | Keywords: Match category name, category id, parentIds field (substring) |
page | integer | optional | Page number (starting from 1) |
pageSize | integer | optional | Number of items per page, maximum 200 |
Code example
{
"keyword": "jewelry",
"page": 1,
"pageSize": 50
}Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "-1",
"data": {},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": null,
"ts": "0"
}Response fields
Response field reference (9 fields)
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | optional | Number of items returned on this page |
costToken | integer | optional | Consume tokens (local retrieval is not billed) |
categories | array | optional | Matching category list |
title | string | optional | Title |
categoryLevel | integer | optional | Category level |
id | string | optional | category id |
name | string | optional | Category name |
parentId | string | optional | Canonical main parent category id |
parentIds | string | optional | All non-empty parent category ids (comma separated) |
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.