https://api.nexscope.ai/ss/market/researchRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/ss/market/research |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
marketplace | string | required | Site encoding, see marketplace optional values |
nodeIdPath | string | optional | Category node ID path, for example `172282:281407` |
departmentKeyword | string | optional | Category keyword path, such as `Electronics:Accessories & Supplies` |
sellerLocation | string | optional | Seller's location, multiple values separated by commas |
newProduct | integer | optional | New product definition (month) |
topNum | integer | optional | Header Listing quantity |
month | string | optional | Filter date |
page | integer | optional | Page number, starting from 1 |
size | integer | optional | Number of items per page |
orderField | string | optional | Ordering field, see orderField optional value |
orderDesc | boolean | optional | `true` descending order, `false` ascending order |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
No response example is published for this API. Refer to the response fields below.
Response fields
Response field reference (46 fields)
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | optional | Total number of items |
marketplace | string | optional | Site encoding |
data | array | optional | Category market list (corresponding to third-party `data.items`) |
columns | array | optional | Rendered columns |
costToken | integer | optional | Consume token |
type | string | optional | rendering style |
nodeId | string | optional | Node ID |
nodeIdPath | string | optional | Node ID path |
nodeLabelName | string | optional | Node name |
nodeLabelPath | string | optional | Node name path |
nodeLabelLocale | string | optional | Node name translation |
nodeLabelPathLocale | string | optional | Node name path translation |
marketplace | string | optional | market sign |
currency | string | optional | The currency type of this market |
ranking | integer | optional | Ranking |
totalProducts | integer | optional | Total number of items |
topProducts | integer | optional | sample size |
sellers | integer | optional | Number of sellers |
brands | integer | optional | Number of brands |
avgSellers | number | optional | Average number of sellers |
avgUnits | integer | optional | average monthly sales |
totalUnits | integer | optional | Total monthly sales |
avgRevenue | number | optional | average monthly sales |
totalRevenue | number | optional | total monthly sales |
avgPrice | number | optional | average price |
avgRating | number | optional | average rating |
avgRatings | integer | optional | average rating |
avgBsr | integer | optional | Average BSR |
avgProfit | number | optional | Average profit margin (%) |
fbaProportion | number | optional | FBA proportion (%) |
fbmProportion | number | optional | FBM proportion (%) |
amazonSelfProportion | number | optional | Amazon’s self-operated share (%) |
ebcProportion | number | optional | A+ product proportion (%) |
returnRatio | number | optional | Return rate (%) |
avgReturnRatio | number | optional | Return rate category average (%) |
searchToPurchaseRatio | number | optional | Search to purchase ratio (per thousand) |
sellerNation | string | optional | Most sellers’ code |
sellerNationLabel | string | optional | Label with the most sellers’ locations |
sellerProportion | number | optional | Proportion of where the most sellers belong (%) |
avgWeight | number | optional | Average weight (pound) |
baseAvgWeight | number | optional | Average weight (g) |
avgVolume | number | optional | Average volume (in³) |
baseAvgVolume | number | optional | Average volume (cm³) |
top10Images | array | optional | The top 10 product pictures, the elements are shown in the table below |
image | string | optional | Image link |
asin | string | optional | ASIN |
Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
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.