POST
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
Response field reference (40 fields)
| Name | Type | Required | Description |
|---|---|---|---|
code | string | optional | sf business return code, `"1"` indicates success |
msg | string | optional | news |
total | integer | optional | The actual amount of data returned this time |
data | array | optional | keyword data array |
columns | array | optional | render column |
type | string | optional | rendering style |
title | string | optional | Title |
isParentAsin | boolean | optional | Is it a parent ASIN? |
hasVaiants | boolean | optional | Are there any variants? |
abaCreateDateWeek | string | optional | The latest weekly ABA data corresponds to the weekly time |
costTime | integer | optional | Time consuming (ms) |
costToken | integer | optional | Consume token |
keyword | string | optional | keywords |
translateKeyword | string | optional | Site localization translation |
asin | string | optional | Product ASIN |
productNaturalRank | integer | optional | Natural search ranking |
naturalRankDisplay | string | optional | Natural ranking display text |
productAdRank | integer | optional | SP Ad Rank |
adRankDisplay | string | optional | Ad rank display text |
weeklySearchVolume | integer | optional | Estimated search volume per week |
keywordPopularityRank | integer | optional | Keyword popularity ranking. The smaller the value, the greater the search volume. |
totalSearchResultProductCount | integer | optional | Total number of search results items |
trafficShare | number | optional | The proportion of traffic this keyword brings to ASIN, 1 means 100% |
naturalTrafficShare | number | optional | Natural traffic score proportion |
paidTrafficShare | number | optional | Proportion of paid advertising traffic score (SP+SB+SBV+recommended advertising) |
naturalTrafficScore | number | optional | Natural Search Exposure Score |
sponsoredProductsScore | number | optional | SP regular bit score |
brandAdScore | number | optional | SB Brand Advertising Score (Regular + Video) |
videoAdScore | number | optional | SBV Video Ad Score |
sponsoredRecommendationScore | number | optional | SP recommendation total score |
sponsoredRecommendationBreakdown | array | optional | Recommendation bit details, each item is `{title, score, scoreRatio}` |
clickConcentrationShare | number | optional | ABA TOP3 click concentration, not conversion rate |
clickToPurchaseConversionRate | number | optional | Click-to-purchase conversion rate (`purchaseQty / clickQty`) |
displayPositionTypes | array | optional | Placement: `natural`, `ac`, `sp`, `top`, `bottom`, `er`, `vedio`, `tr`, `trfob` |
trafficCharacteristicMarkers | array | optional | Traffic tags: `isMainKw`, `isAccurateKw`, `isAccurateAboveKw`, `isAccurateTailKw` |
conversionPerformanceMarkers | array | optional | Conversion tags: `isPurchaseKw`, `isQualityKw`, `isStableKw`, `isLossKw`, `isInvalidKw` |
lastNaturalRankTime | string | optional | The most recent effective natural ranking time |
lastAdRankTime | string | optional | Last effective SP ad ranking time |
periodEndDate | string | optional | End date of this cycle |
updateTime | string | optional | Keyword data update time |
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.