https://api.nexscope.ai/js/keywords/by-asinRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/js/keywords/by-asin |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
marketplace | string | required | Target market code. Optional values: `us`, `uk`, `de`, `in`, `ca`, `fr`, `it`, `es`, `mx`, `jp` Example: us |
asins | string[] | required | List of ASINs, up to 10 |
needCount | integer | optional | Total number of results returned (internal automatic pagination) |
includeVariants | boolean | optional | Whether to include keywords for variant products |
sort | string | optional | Sorting field; optional values see the sorting field table below Example: -monthly_search_volume_exact |
minMonthlySearchVolumeExact | integer | optional | Minimum monthly precise search volume (1-999999) |
maxMonthlySearchVolumeExact | integer | optional | Maximum monthly precise search volume (1-999999) |
minMonthlySearchVolumeBroad | integer | optional | Minimum monthly broad search volume (1-999999) |
maxMonthlySearchVolumeBroad | integer | optional | Maximum monthly broad search volume (1-999999) |
minWordCount | integer | optional | Minimum number of words (1-99999) |
maxWordCount | integer | optional | Maximum number of words (1-99999) |
minOrganicProductCount | integer | optional | Minimum number of natural search results (1-99999) |
maxOrganicProductCount | integer | optional | Maximum number of natural search results (1-99999) |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
No response example is published for this API. Refer to the response fields below.
Response fields
Response field reference (36 fields)
| Name | Type | Required | Description |
|---|---|---|---|
costToken | integer | optional | Number of tokens consumed |
keywordInfoList | array | optional | Keyword information list |
name | string | optional | keywords |
country | string | optional | market code |
monthlySearchVolumeExact | integer | optional | Monthly exact match search volume |
monthlySearchVolumeBroad | integer | optional | Monthly broad match search volume |
monthlyTrend | float | optional | Month-on-month trend (%) |
quarterlyTrend | float | optional | Quarterly Trend (%) |
dominantCategory | string | optional | Main categories |
relevancyScore | integer | optional | Relevance of keywords to ASIN (0-100) |
easeOfRankingScore | integer | optional | Ease of ranking (0-100, the higher it is, the easier it is to rank) |
organicRank | integer | optional | ASIN’s organic search ranking |
sponsoredRank | integer | optional | Ad Rank for ASIN |
overallRank | integer | optional | Comprehensive ranking position |
organicProductCount | integer | optional | Total number of products in organic search results |
sponsoredProductCount | integer | optional | Total number of advertising space products |
ppcBidExact | float | optional | Exact match PPC recommended bid (USD) |
ppcBidBroad | float | optional | Broad Match PPC Recommended Bid (USD) |
spBrandAdBid | float | optional | SP Brand Ad Recommended Bid (USD) |
recommendedPromotions | integer | optional | Recommended promotion amount |
primaryAsin | string | optional | The highest ranking ASIN for this keyword |
relativeOrganicPosition | float | optional | Query the relative natural ranking position of an ASIN |
relativeSponsoredPosition | float | optional | Query the relative ad ranking position of ASIN |
organicRankingAsinsCount | integer | optional | Number of query ASINs with natural rankings |
sponsoredRankingAsinsCount | integer | optional | Number of query ASINs with ad ranking |
avgCompetitorOrganicRank | float | optional | Query the average organic position of an ASIN |
avgCompetitorSponsoredRank | float | optional | Query the average ad position for an ASIN |
variationLowestOrganicRank | integer | optional | Best organic position among variations |
variationLowestSponsoredRank | integer | optional | Best ad position among variations |
competitorOrganicRank | array | optional | Natural ranking for each ASIN, element `{asin, organicRank}` |
competitorSponsoredRank | array | optional | Ad rank for each ASIN, element `{asin, sponsoredRank}` |
updatedAt | string | optional | Data last updated time |
asin | string | optional | ASIN |
organicRank | integer | optional | The ASIN’s organic search ranking |
asin | string | optional | ASIN |
sponsoredRank | integer | optional | Ad Rank for this ASIN |
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.