https://api.nexscope.ai/kp/productSeriesRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/kp/productSeries |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
asin | string | required | Amazon Standard Identification Number (ASIN), only supports a single ASIN, the maximum length is 1000. |
domain | string | required | amazon domain name ID: `1` (USA), `2` (UK), `3` (Germany), `4` (France), `5` (Japan), `6` (Canada), `8` (Italy), `9` (Spain), `10` (India), `11` (Mexico), `12` (Brazil). |
days | integer | optional | Limit the number of days of historical data to a maximum of `365`. Example: 90 |
showPrice | integer | optional | Set to `1` to return the lowest new product price curve in the market. |
showPriceList | integer | optional | Set to `1` to return the strike/mark curve. |
showPriceDeal | integer | optional | Set to `1` to return the flash sale price curve. |
showPricePrime | integer | optional | Set to `1` to return Prime exclusive new product price curve. |
showPriceFba | integer | optional | Set to `1` to return the third-party FBA new product price curve. |
showPriceFbm | integer | optional | Set to `1` to return the third-party FBM new product price curve. |
showPriceCoupon | integer | optional | Set to `1` Returns the post-coupon Buy Box price curve. |
showBsrMain | integer | optional | Set to `1` to return the large class of BSR curves. |
showSellerCount | integer | optional | Set to `1` to return the seller number curve. |
Code example
{
"asin": "B0DFRJ7WSX",
"days": 90,
"domain": "1",
"showBsrMain": 1,
"showPrice": 1,
"showSellerCount": 1
}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.asin | any | optional | Asin value used by this API operation. |
data.bsrMain | any | optional | Bsr main value used by this API operation. |
data.bsrSub | any | optional | Bsr sub value used by this API operation. |
data.buyboxPrice | any | optional | Buybox price value used by this API operation. |
data.categoryName | any | optional | Category name 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.dataSnapshotMonth | any | optional | Data snapshot month value used by this API operation. |
data.monthlySold | any | optional | Monthly sold 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.points | any | optional | Points value used by this API operation. |
data.price | any | optional | Price value used by this API operation. |
data.priceCoupon | any | optional | Price coupon value used by this API operation. |
data.priceDeal | any | optional | Price deal value used by this API operation. |
data.priceFba | any | optional | Price fba value used by this API operation. |
data.priceFbm | any | optional | Price fbm value used by this API operation. |
data.priceList | any | optional | Price list value used by this API operation. |
data.pricePrime | any | optional | Price prime value used by this API operation. |
data.rating | any | optional | Rating value used by this API operation. |
data.ratingCount | any | optional | Rating count value used by this API operation. |
data.sellerCount | any | optional | Seller count 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.time | any | optional | Time value used by this API operation. |
data.title | any | optional | Title value used by this API operation. |
data.totalPage | any | optional | Total page value used by this API operation. |
data.type | any | optional | Type value used by this API operation. |
data.value | any | optional | Value 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.bsrMain | array | optional | Category BSR; each element contains `categoryName` (category name) and `points` (time series point). Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.bsrMain | null | optional | Bsr main value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.bsrSub | array | optional | Small class BSR; each element contains `categoryName` (category name) and `points` (time series point). Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.bsrSub | null | optional | Bsr sub value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.buyboxPrice | array | optional | Buy Box price; elements contain `time` (time) and `value` (Buy Box price). Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.buyboxPrice | null | optional | Buybox price value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.categoryName | string | optional | Category name; the specific type shall be subject to the source file or upstream official documentation. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.categoryName | null | optional | Category name 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.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.monthlySold | array | optional | Subbody sales; elements contain `time` and `value`. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.monthlySold | null | optional | Monthly sold 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.points | string | optional | This category is a BSR time series point, and the elements include `time` and `value`; the specific type is subject to the source file or the upstream official document. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.points | null | optional | Points value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.price | array | optional | The lowest new product price on the market; elements include `time` and `value`. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.price | null | optional | Price value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.priceCoupon | array | optional | Coupon price; elements contain `time` and `value`. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.priceCoupon | null | optional | Price coupon value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.priceDeal | array | optional | Deal price; elements contain `time` and `value`. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.priceDeal | null | optional | Price deal value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.priceFba | array | optional | FBA price; elements contain `time` and `value`. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.priceFba | null | optional | Price fba value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.priceFbm | array | optional | FBM price; elements contain `time` and `value`. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.priceFbm | null | optional | Price fbm value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.priceList | array | optional | Strikethrough price; elements contain `time` and `value`. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.priceList | null | optional | Price list value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.pricePrime | array | optional | Prime price; elements contain `time` and `value`. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.pricePrime | null | optional | Price prime value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.rating | array | optional | Rating; elements contain `time` and `value`. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.rating | null | optional | Rating value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.ratingCount | array | optional | Score number; elements contain `time` and `value`. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.ratingCount | null | optional | Rating count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sellerCount | array | optional | Number of sellers; elements contain `time` and `value`. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sellerCount | null | optional | Seller count 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.time | string | optional | Time; the specific type shall be subject to the source file or upstream official documentation. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.time | null | optional | Time 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.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.type | string | optional | Provider-specific render or payload type. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.type | null | optional | Type value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.value | string | optional | The indicator value corresponding to the time point; the specific type shall be subject to the source file or upstream official documentation. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.value | null | optional | Value 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.