https://api.nexscope.ai/api/skill-api/v1/skills/amazon-market-research/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/amazon-market-research/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
marketplace | string | required | Site code, see [marketplace](#marketplace-options) Example: US |
nodeIdPath | string | optional | Category node ID path, e.g. 172282:281407 |
departmentKeyword | string | optional | Category keyword path, e.g. Electronics:Accessories & Supplies Example: phone case |
sellerLocation | string | optional | Seller location, multiple values comma-separated; see Seller Sprite table 1.3 for values |
newProduct | integer | optional | New product definition (months) Example: 1 |
topNum | integer | optional | Top Listing count Example: 1 |
month | string | optional | Filter date: nearly or yyyyMM |
page | integer | optional | Page number, starting from 1 Example: 1 |
size | integer | optional | Results per page Example: 1 |
orderField | string | optional | Sort field, see [orderField](#orderfield-options) |
orderDesc | boolean | optional | true descending, false ascending Example: false |
minAvgRevenue/maxAvgRevenue | number | optional | Minimum / maximum average monthly sales revenue Example: 1 |
minAvgUnits/maxAvgUnits | integer | optional | Minimum / maximum average monthly sales volume Example: 1 |
minGoodsCount/maxGoodsCount | integer | optional | Minimum / maximum product count Example: 1 |
minSellers/maxSellers | integer | optional | Minimum / maximum seller count Example: 1 |
minBrands/maxBrands | integer | optional | Minimum / maximum brand count Example: 1 |
minAvgSellers/maxAvgSellers | number | optional | Minimum / maximum average seller count Example: 1 |
minGoodsCrn/maxGoodsCrn | number | optional | Minimum / maximum product concentration (decimal 0-1) Example: 1 |
minSellerCrn/maxSellerCrn | number | optional | Minimum / maximum seller concentration (decimal 0-1) Example: 1 |
minBrandCrn/maxBrandCrn | number | optional | Minimum / maximum brand concentration (decimal 0-1) Example: 1 |
minAmazonSelfProportion/maxAmazonSelfProportion | number | optional | Minimum / maximum Amazon self-operated share (decimal 0-1) Example: 1 |
minFbaProportion/maxFbaProportion | number | optional | Minimum / maximum FBA share (decimal 0-1) Example: 1 |
minFbmProportion/maxFbmProportion | number | optional | Minimum / maximum FBM share (decimal 0-1) Example: 1 |
minEbcProportion/maxEbcProportion | number | optional | Minimum / maximum A+ share (decimal 0-1) Example: 1 |
minNewProportion/maxNewProportion | number | optional | Minimum / maximum new product share (scale may differ from other ratio fields; refer to tool schema / actual network behavior) Example: 1 |
minAvgPrice/maxAvgPrice | number | optional | Minimum / maximum average price Example: 1 |
minAvgRating/maxAvgRating | number | optional | Minimum / maximum average rating value Example: 1 |
minAvgRatings/maxAvgRatings | integer | optional | Minimum / maximum average review count Example: 1 |
minAvgProfit/maxAvgProfit | number | optional | Minimum / maximum average gross margin (input N means N%, 0-100) Example: 1 |
minAvgBsr/maxAvgBsr | integer | optional | Minimum / maximum average BSR rank Example: 1 |
minNewCount/maxNewCount | integer | optional | Minimum / maximum new product count Example: 1 |
minNewAvgPrice/maxNewAvgPrice | number | optional | Minimum / maximum new product average price Example: 1 |
minNewAvgRating/maxNewAvgRating | number | optional | Minimum / maximum new product average star rating Example: 1 |
minNewAvgRatings/maxNewAvgRatings | integer | optional | Minimum / maximum new product average review count Example: 1 |
minNewAvgUnits/maxNewAvgUnits | number | optional | Minimum / maximum new product average monthly sales Example: 1 |
minNewAvgRevenue/maxNewAvgRevenue | number | optional | Minimum / maximum new product average monthly revenue Example: 1 |
minTopAvgUnits/maxTopAvgUnits | integer | optional | Minimum / maximum top listing average monthly sales Example: 1 |
minTopAvgRevenue/maxTopAvgRevenue | number | optional | Minimum / maximum top listing average monthly revenue Example: 1 |
minTopAvgBsr/maxTopAvgBsr | integer | optional | Minimum / maximum top listing average BSR Example: 1 |
minWeight/maxWeight | number | optional | Minimum / maximum weight Example: 1 |
minVolume/maxVolume | number | optional | Minimum / maximum volume Example: 1 |
Request example
{
"page": 1,
"departmentKeyword": "phone case",
"newProduct": 1,
"size": 1,
"marketplace": "US",
"topNum": 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 | Total record count Example: 1 |
data.marketplace | string | optional | Site code Example: US |
data.data | array | optional | Category market list (corresponds to third-party data.items) Example: [] |
data.columns | array | optional | Render columns Example: [] |
data.costToken | integer | optional | Tokens consumed Example: 1 |
data.type | string | optional | Render style Example: null |
data.data[].nodeId | string | optional | Node ID Example: example-id |
data.data[].nodeIdPath | string | optional | Node ID path Example: null |
data.data[].nodeLabelName | string | optional | Node name Example: null |
data.data[].nodeLabelPath | string | optional | Node name path Example: null |
data.data[].nodeLabelLocale | string | optional | Node name translation Example: null |
data.data[].nodeLabelPathLocale | string | optional | Node name path translation Example: null |
data.data[].marketplace | string | optional | Market identifier Example: US |
data.data[].currency | string | optional | Currency type for this market Example: null |
data.data[].ranking | integer | optional | Rank Example: 1 |
data.data[].totalProducts | integer | optional | Total product count Example: 1 |
data.data[].topProducts | integer | optional | Sample count Example: 1 |
data.data[].sellers | integer | optional | Seller count Example: 1 |
data.data[].brands | integer | optional | Brand count Example: 1 |
data.data[].avgSellers | number | optional | Average seller count Example: 1 |
data.data[].avgUnits | integer | optional | Average monthly sales volume Example: 1 |
data.data[].totalUnits | integer | optional | Total monthly sales volume Example: 1 |
data.data[].avgRevenue | number | optional | Average monthly sales revenue Example: 1 |
data.data[].totalRevenue | number | optional | Total monthly sales revenue Example: 1 |
data.data[].avgPrice | number | optional | Average price Example: 1 |
data.data[].avgRating | number | optional | Average rating value Example: 1 |
data.data[].avgRatings | integer | optional | Average review count Example: 1 |
data.data[].avgBsr | integer | optional | Average BSR Example: 1 |
data.data[].avgProfit | number | optional | Average profit margin (%) Example: 1 |
data.data[].fbaProportion | number | optional | FBA share (%) Example: 1 |
data.data[].fbmProportion | number | optional | FBM share (%) Example: 1 |
data.data[].amazonSelfProportion | number | optional | Amazon self-operated share (%) Example: 1 |
data.data[].ebcProportion | number | optional | A+ product share (%) Example: 1 |
data.data[].returnRatio | number | optional | Return rate (%) Example: 1 |
data.data[].avgReturnRatio | number | optional | Category average return rate (%) Example: 1 |
data.data[].searchToPurchaseRatio | number | optional | Search-to-purchase ratio (per mille) Example: 1 |
data.data[].sellerNation | string | optional | Most common seller location code Example: null |
data.data[].sellerNationLabel | string | optional | Most common seller location label Example: null |
data.data[].sellerProportion | number | optional | Most common seller location share (%) Example: 1 |
data.data[].avgWeight | number | optional | Average weight (pound) Example: 1 |
data.data[].baseAvgWeight | number | optional | Average weight (g) Example: 1 |
data.data[].avgVolume | number | optional | Average volume (in³) Example: 1 |
data.data[].baseAvgVolume | number | optional | Average volume (cm³) Example: 1 |
data.data[].top10Images | array | optional | Top 10 product images, elements see table below Example: [] |
data.top10images[].image | string | optional | Image link Example: https://example.com/image.jpg |
data.top10images[].asin | string | optional | ASIN Example: B072MQ5BRX |
data.title | string | optional | Provider-specific response title. 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,
"marketplace": "US",
"data": [
{
"nodeId": "example-id",
"marketplace": "US",
"ranking": 1,
"totalProducts": 1,
"topProducts": 1,
"sellers": 1,
"brands": 1,
"avgSellers": 1,
"avgUnits": 1,
"totalUnits": 1,
"avgRevenue": 1,
"totalRevenue": 1,
"avgPrice": 1,
"avgRating": 1,
"avgRatings": 1,
"avgBsr": 1,
"avgProfit": 1,
"fbaProportion": 1,
"fbmProportion": 1,
"amazonSelfProportion": 1,
"ebcProportion": 1,
"returnRatio": 1,
"avgReturnRatio": 1,
"searchToPurchaseRatio": 1,
"sellerProportion": 1,
"avgWeight": 1,
"baseAvgWeight": 1,
"avgVolume": 1,
"baseAvgVolume": 1,
"top10Images": []
}
],
"columns": [],
"costToken": 1,
"top10images": [
{
"image": "https://example.com/image.jpg",
"asin": "B072MQ5BRX"
}
]
},
"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.