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 |
Code example
{
"marketplace": "US",
"maxGoodsCrn": 0.4,
"minAvgRevenue": 10000,
"month": "nearly",
"orderDesc": true,
"orderField": "total_amount",
"page": 1,
"size": 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
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | required | 0 means accepted or successful; nonzero is a platform error. |
cost | string | required | Elapsed milliseconds, never credits; -1 outside web requests. |
data | any | required | Data value used by this API operation. |
msg | string | null | required | Msg value used by this API operation. |
time | string | required | Server local time: yyyy-MM-dd HH:mm:ss. |
traceId | string | null | required | Trace id value used by this API operation. |
ts | string | required | Epoch milliseconds. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | Data value used by this API operation. |
data.amazonSelfProportion | any | optional | Amazon self proportion value used by this API operation. |
data.asin | any | optional | Asin value used by this API operation. |
data.avgBsr | any | optional | Avg bsr value used by this API operation. |
data.avgPrice | any | optional | Avg price value used by this API operation. |
data.avgProfit | any | optional | Avg profit value used by this API operation. |
data.avgRating | any | optional | Avg rating value used by this API operation. |
data.avgRatings | any | optional | Avg ratings value used by this API operation. |
data.avgReturnRatio | any | optional | Avg return ratio value used by this API operation. |
data.avgRevenue | any | optional | Avg revenue value used by this API operation. |
data.avgSellers | any | optional | Avg sellers value used by this API operation. |
data.avgUnits | any | optional | Avg units value used by this API operation. |
data.avgVolume | any | optional | Avg volume value used by this API operation. |
data.avgWeight | any | optional | Avg weight value used by this API operation. |
data.baseAvgVolume | any | optional | Base avg volume value used by this API operation. |
data.baseAvgWeight | any | optional | Base avg weight value used by this API operation. |
data.brands | any | optional | Brands value used by this API operation. |
data.columns | any | optional | Columns value used by this API operation. |
data.costTime | any | optional | Cost time value used by this API operation. |
data.costToken | any | optional | Cost token value used by this API operation. |
data.currency | any | optional | Currency value used by this API operation. |
data.data | any | optional | Data value used by this API operation. |
data.dataSnapshotMonth | any | optional | Data snapshot month value used by this API operation. |
data.ebcProportion | any | optional | Ebc proportion value used by this API operation. |
data.fbaProportion | any | optional | Fba proportion value used by this API operation. |
data.fbmProportion | any | optional | Fbm proportion value used by this API operation. |
data.image | any | optional | Image value used by this API operation. |
data.marketplace | any | optional | Marketplace value used by this API operation. |
data.nodeId | any | optional | Node id value used by this API operation. |
data.nodeIdPath | any | optional | Node id path value used by this API operation. |
data.nodeLabelLocale | any | optional | Node label locale value used by this API operation. |
data.nodeLabelName | any | optional | Node label name value used by this API operation. |
data.nodeLabelPath | any | optional | Node label path value used by this API operation. |
data.nodeLabelPathLocale | any | optional | Node label path locale value used by this API operation. |
data.page | any | optional | Page value used by this API operation. |
data.pageItemCount | any | optional | Page item count value used by this API operation. |
data.pageSize | any | optional | Page size value used by this API operation. |
data.ranking | any | optional | Ranking value used by this API operation. |
data.returnRatio | any | optional | Return ratio value used by this API operation. |
data.searchToPurchaseRatio | any | optional | Search to purchase ratio value used by this API operation. |
data.sellerNation | any | optional | Seller nation value used by this API operation. |
data.sellerNationLabel | any | optional | Seller nation label value used by this API operation. |
data.sellerProportion | any | optional | Seller proportion value used by this API operation. |
data.sellers | any | optional | Sellers value used by this API operation. |
data.sourceTool | any | optional | Source tool value used by this API operation. |
data.sourceType | any | optional | Source type value used by this API operation. |
data.title | any | optional | Title value used by this API operation. |
data.top10Images | any | optional | Top10 images value used by this API operation. |
data.topProducts | any | optional | Top products value used by this API operation. |
data.total | any | optional | Total value used by this API operation. |
data.totalPage | any | optional | Total page value used by this API operation. |
data.totalProducts | any | optional | Total products value used by this API operation. |
data.totalRevenue | any | optional | Total revenue value used by this API operation. |
data.totalUnits | any | optional | Total units value used by this API operation. |
data.type | any | optional | Type value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.amazonSelfProportion | number | optional | Amazon’s self-operated share (%) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.amazonSelfProportion | null | optional | Amazon self proportion value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.asin | string | optional | ASIN Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.asin | null | optional | Asin value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.avgBsr | integer | optional | Average BSR Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.avgBsr | null | optional | Avg bsr value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.avgPrice | number | optional | average price Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.avgPrice | null | optional | Avg price value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.avgProfit | number | optional | Average profit margin (%) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.avgProfit | null | optional | Avg profit value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.avgRating | number | optional | average rating Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.avgRating | null | optional | Avg rating value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.avgRatings | integer | optional | average rating Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.avgRatings | null | optional | Avg ratings value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.avgReturnRatio | number | optional | Return rate category average (%) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.avgReturnRatio | null | optional | Avg return ratio value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.avgRevenue | number | optional | average monthly sales Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.avgRevenue | null | optional | Avg revenue value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.avgSellers | number | optional | Average number of sellers Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.avgSellers | null | optional | Avg sellers value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.avgUnits | integer | optional | average monthly sales Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.avgUnits | null | optional | Avg units value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.avgVolume | number | optional | Average volume (in³) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.avgVolume | null | optional | Avg volume value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.avgWeight | number | optional | Average weight (pound) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.avgWeight | null | optional | Avg weight value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.baseAvgVolume | number | optional | Average volume (cm³) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.baseAvgVolume | null | optional | Base avg volume value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.baseAvgWeight | number | optional | Average weight (g) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.baseAvgWeight | null | optional | Base avg weight value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.brands | integer | optional | Number of brands Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.brands | null | optional | Brands value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.columns | array | optional | Rendered columns Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.columns | null | optional | Columns value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.costTime | integer | optional | Execution time reported by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.costTime | null | optional | Cost time value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.costToken | integer | optional | Consume token Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.costToken | null | optional | Cost token value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.currency | string | optional | The currency type of this market Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.currency | null | optional | Currency value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data | array | optional | Category market list (corresponding to third-party `data.items`) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data | null | optional | Data value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.dataSnapshotMonth | null | optional | Data snapshot month value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.ebcProportion | number | optional | A+ product proportion (%) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.ebcProportion | null | optional | Ebc proportion value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.fbaProportion | number | optional | FBA proportion (%) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.fbaProportion | null | optional | Fba proportion value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.fbmProportion | number | optional | FBM proportion (%) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.fbmProportion | null | optional | Fbm proportion value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.image | string | optional | Image link Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.image | null | optional | Image value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.marketplace | any | optional | Marketplace value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.marketplace | string | optional | market sign Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.marketplace | null | optional | Marketplace value used by this API operation. |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.marketplace | null | optional | Marketplace value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeId | string | optional | Node ID Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeId | null | optional | Node id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeIdPath | string | optional | Node ID path Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeIdPath | null | optional | Node id path value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeLabelLocale | string | optional | Node name translation Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeLabelLocale | null | optional | Node label locale value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeLabelName | string | optional | Node name Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeLabelName | null | optional | Node label name value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeLabelPath | string | optional | Node name path Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeLabelPath | null | optional | Node label path value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeLabelPathLocale | string | optional | Node name path translation Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeLabelPathLocale | null | optional | Node label path locale value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.page | integer | optional | Current page returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.page | null | optional | Page value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.pageItemCount | null | optional | Page item count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.pageSize | integer | optional | Page size returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.pageSize | null | optional | Page size value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.ranking | integer | optional | Ranking Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.ranking | null | optional | Ranking value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.returnRatio | number | optional | Return rate (%) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.returnRatio | null | optional | Return ratio value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.searchToPurchaseRatio | number | optional | Search to purchase ratio (per thousand) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.searchToPurchaseRatio | null | optional | Search to purchase ratio value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sellerNation | string | optional | Most sellers’ code Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sellerNation | null | optional | Seller nation value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sellerNationLabel | string | optional | Label with the most sellers’ locations Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sellerNationLabel | null | optional | Seller nation label value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sellerProportion | number | optional | Proportion of where the most sellers belong (%) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sellerProportion | null | optional | Seller proportion value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sellers | integer | optional | Number of sellers Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sellers | null | optional | Sellers value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceTool | string | optional | Provider-specific source tool name. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceTool | null | optional | Source tool value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceType | string | optional | Provider-specific source platform type. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceType | null | optional | Source type value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.title | string | optional | Provider-specific response title. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.title | null | optional | Title value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.top10Images | array | optional | The top 10 product pictures, the elements are shown in the table below Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.top10Images | null | optional | Top10 images value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.topProducts | integer | optional | sample size Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.topProducts | null | optional | Top products value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.total | integer | optional | Total number of items Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.total | null | optional | Total value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.totalPage | integer | optional | Total page count returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalPage | null | optional | Total page value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.totalProducts | integer | optional | Total number of items Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalProducts | null | optional | Total products value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.totalRevenue | number | optional | total monthly sales Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalRevenue | null | optional | Total revenue value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.totalUnits | integer | optional | Total monthly sales Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalUnits | null | optional | Total units value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.type | string | optional | rendering style Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.type | null | optional | Type value used by this API operation. |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data | null | required | Data value used by this API operation. |
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.