https://api.nexscope.ai/sf/asinKeywordsRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/sf/asinKeywords |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
asin | string | required | ASIN code, maximum length 1000 characters; only one ASIN can be queried at a time |
country | string | optional | Site: `US`, `UK`, `DE`, `CA`, `JP`, `FR`, `ES`, `IT`, `MX`, `AU`, `AE`, `BR`, `SA` Example: US |
keyword | string | optional | Keyword filtering, maximum length 1000; try to use the target site language |
timePieceType | string | optional | Time type: `latelyDay`, `month`, `week` Example: latelyDay |
timePieceValue | string | optional | Time slice value, maximum length 1000; `latelyDay` only supports `7` or `30`; `month` is `YYYY-MM`; `week` is the week start date `YYYY-MM-DD` Example: 7 |
conditions | string | optional | Comma separated conditions: `nfPosition`, `isSpAd`, `isBrandAd`, `isVedioAd`, `isAC`, `isAccurateKw`, `isAccurateTailKw`, `isPurchaseKw`, `isQualityKw`, `isStableKw`, `isLossKw`, `isInvalidKw`, `isMultiVariantKw`, `isSearchVolUpKw`, `isSearchVolDownKw`; cycle condition: `totalPeriod.in`、`nfKeywordCnt.total`/`.in`、`adKeywordCnt.total`/`.in`、`allSpKeywordCnt.total`/`.in`、`spKeywordCnt.total`/`.in`、`recSpKeywordCnt.total`/`.in`、`allSbKeywordCnt.total`/`.in`、`sbKeywordCnt.total`/`.in`、`sbvKeywordCnt.total`/`.in` |
sortBy | string | optional | `lastRank`、`adLastRank`、`updateTime`、`searchesRank`、`estSearchesNum` |
desc | boolean | optional | Is descending order Example: true |
pageNum | integer | optional | Page number Example: 1 |
pageSize | integer | optional | Number per page, range 10–100 Example: 100 |
Code example
{
"asin": "B0XXXXXXXX",
"country": "US",
"desc": true,
"pageSize": 100,
"sortBy": "estSearchesNum"
}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.abaCreateDateWeek | any | optional | Aba create date week value used by this API operation. |
data.adRankDisplay | any | optional | Ad rank display value used by this API operation. |
data.asin | any | optional | Asin value used by this API operation. |
data.brandAdScore | any | optional | Brand ad score value used by this API operation. |
data.clickConcentrationShare | any | optional | Click concentration share value used by this API operation. |
data.clickToPurchaseConversionRate | any | optional | Click to purchase conversion rate value used by this API operation. |
data.columns | any | optional | Columns value used by this API operation. |
data.conversionPerformanceMarkers | any | optional | Conversion performance markers 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.data | any | optional | Data value used by this API operation. |
data.dataSnapshotMonth | any | optional | Data snapshot month value used by this API operation. |
data.displayPositionTypes | any | optional | Display position types value used by this API operation. |
data.hasVaiants | any | optional | Has vaiants value used by this API operation. |
data.isParentAsin | any | optional | Is parent asin value used by this API operation. |
data.keyword | any | optional | Keyword value used by this API operation. |
data.keywordPopularityRank | any | optional | Keyword popularity rank value used by this API operation. |
data.lastAdRankTime | any | optional | Last ad rank time value used by this API operation. |
data.lastNaturalRankTime | any | optional | Last natural rank time value used by this API operation. |
data.naturalRankDisplay | any | optional | Natural rank display value used by this API operation. |
data.naturalTrafficScore | any | optional | Natural traffic score value used by this API operation. |
data.naturalTrafficShare | any | optional | Natural traffic share 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.paidTrafficShare | any | optional | Paid traffic share value used by this API operation. |
data.periodEndDate | any | optional | Period end date value used by this API operation. |
data.productAdRank | any | optional | Product ad rank value used by this API operation. |
data.productNaturalRank | any | optional | Product natural rank 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.sponsoredProductsScore | any | optional | Sponsored products score value used by this API operation. |
data.sponsoredRecommendationBreakdown | any | optional | Sponsored recommendation breakdown value used by this API operation. |
data.sponsoredRecommendationScore | any | optional | Sponsored recommendation score value used by this API operation. |
data.title | any | optional | Title 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.totalSearchResultProductCount | any | optional | Total search result product count value used by this API operation. |
data.trafficCharacteristicMarkers | any | optional | Traffic characteristic markers value used by this API operation. |
data.trafficShare | any | optional | Traffic share value used by this API operation. |
data.translateKeyword | any | optional | Translate keyword value used by this API operation. |
data.type | any | optional | Type value used by this API operation. |
data.updateTime | any | optional | Update time value used by this API operation. |
data.videoAdScore | any | optional | Video ad score value used by this API operation. |
data.weeklySearchVolume | any | optional | Weekly search volume value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.abaCreateDateWeek | string | optional | The latest weekly ABA data corresponds to the weekly time Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.abaCreateDateWeek | null | optional | Aba create date week value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.adRankDisplay | string | optional | Ad rank display text Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.adRankDisplay | null | optional | Ad rank display value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.asin | string | optional | Product 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.brandAdScore | number | optional | SB Brand Advertising Score (Regular + Video) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.brandAdScore | null | optional | Brand ad score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.clickConcentrationShare | number | optional | ABA TOP3 click concentration, not conversion rate Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.clickConcentrationShare | null | optional | Click concentration share value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.clickToPurchaseConversionRate | number | optional | Click-to-purchase conversion rate (`purchaseQty / clickQty`) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.clickToPurchaseConversionRate | null | optional | Click to purchase conversion rate value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.columns | array | optional | render column 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.conversionPerformanceMarkers | array | optional | Conversion tags: `isPurchaseKw`, `isQualityKw`, `isStableKw`, `isLossKw`, `isInvalidKw` Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.conversionPerformanceMarkers | null | optional | Conversion performance markers value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.costTime | integer | optional | Time consuming (ms) 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.data | array | optional | keyword data array 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.displayPositionTypes | array | optional | Placement: `natural`, `ac`, `sp`, `top`, `bottom`, `er`, `vedio`, `tr`, `trfob` Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.displayPositionTypes | null | optional | Display position types value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.hasVaiants | boolean | optional | Are there any variants? Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.hasVaiants | null | optional | Has vaiants value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.isParentAsin | boolean | optional | Is it a parent ASIN? Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.isParentAsin | null | optional | Is parent asin value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.keyword | string | optional | keywords Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.keyword | null | optional | Keyword value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordPopularityRank | integer | optional | Keyword popularity ranking. The smaller the value, the greater the search volume. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordPopularityRank | null | optional | Keyword popularity rank value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.lastAdRankTime | string | optional | Last effective SP ad ranking time Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.lastAdRankTime | null | optional | Last ad rank time value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.lastNaturalRankTime | string | optional | The most recent effective natural ranking time Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.lastNaturalRankTime | null | optional | Last natural rank time value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalRankDisplay | string | optional | Natural ranking display text Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalRankDisplay | null | optional | Natural rank display value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalTrafficScore | number | optional | Natural Search Exposure Score Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalTrafficScore | null | optional | Natural traffic score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalTrafficShare | number | optional | Natural traffic score proportion Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalTrafficShare | null | optional | Natural traffic share 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.paidTrafficShare | number | optional | Proportion of paid advertising traffic score (SP+SB+SBV+recommended advertising) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.paidTrafficShare | null | optional | Paid traffic share value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.periodEndDate | string | optional | End date of this cycle Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.periodEndDate | null | optional | Period end date value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.productAdRank | integer | optional | SP Ad Rank Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.productAdRank | null | optional | Product ad rank value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.productNaturalRank | integer | optional | Natural search ranking Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.productNaturalRank | null | optional | Product natural rank 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.sponsoredProductsScore | number | optional | SP regular bit score Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredProductsScore | null | optional | Sponsored products score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredRecommendationBreakdown | array | optional | Recommendation bit details, each item is `{title, score, scoreRatio}` Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredRecommendationBreakdown | null | optional | Sponsored recommendation breakdown value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredRecommendationScore | number | optional | SP recommendation total score Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredRecommendationScore | null | optional | Sponsored recommendation score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.title | string | optional | 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.total | integer | optional | The actual amount of data returned this time 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.totalSearchResultProductCount | integer | optional | Total number of search results items Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalSearchResultProductCount | null | optional | Total search result product count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.trafficCharacteristicMarkers | array | optional | Traffic tags: `isMainKw`, `isAccurateKw`, `isAccurateAboveKw`, `isAccurateTailKw` Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.trafficCharacteristicMarkers | null | optional | Traffic characteristic markers value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.trafficShare | number | optional | The proportion of traffic this keyword brings to ASIN, 1 means 100% Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.trafficShare | null | optional | Traffic share value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.translateKeyword | string | optional | Site localization translation Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.translateKeyword | null | optional | Translate keyword 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 1
| Name | Type | Required | Description |
|---|---|---|---|
data.updateTime | string | optional | Keyword data update time Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.updateTime | null | optional | Update time value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.videoAdScore | number | optional | SBV Video Ad Score Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.videoAdScore | null | optional | Video ad score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.weeklySearchVolume | integer | optional | Estimated search volume per week Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.weeklySearchVolume | null | optional | Weekly search volume 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.