https://api.nexscope.ai/js/keywords/by-keywordRun 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-keyword |
| 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 |
searchTerms | string | required | Seed keyword (single keyword string) |
needCount | integer | optional | Return the total number of results |
sort | string | optional | Sorting field, defaults to descending order by exact search volume Example: -monthly_search_volume_exact |
minMonthlySearchVolumeExact | integer | optional | Exact search volume minimum |
maxMonthlySearchVolumeExact | integer | optional | Exact search volume cap |
minMonthlySearchVolumeBroad | integer | optional | Broad search volume minimum |
maxMonthlySearchVolumeBroad | integer | optional | Broad search volume cap |
minWordCount | integer | optional | Minimum number of keywords (used to filter long-tail words) |
maxWordCount | integer | optional | Key words maximum number of words |
minOrganicProductCount | integer | optional | Minimum number of natural ranking products |
maxOrganicProductCount | integer | optional | Maximum number of natural ranking products |
Code example
{
"marketplace": "us",
"needCount": 20,
"searchTerms": "yoga mat"
}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 (17 fields)
| Name | Type | Required | Description |
|---|---|---|---|
costToken | integer | optional | Number of tokens consumed |
keywordInfoList | array | optional | Keyword information list |
name | string | optional | Keyword name |
country | string | optional | market code |
monthlySearchVolumeExact | integer | optional | Average monthly exact match search volume |
monthlySearchVolumeBroad | integer | optional | Average monthly broad match search volume |
monthlyTrend | number | optional | Monthly search volume percentage change |
quarterlyTrend | number | optional | Quarterly search volume percentage change |
dominantCategory | string | optional | Category with the highest proportion in search results |
relevancyScore | integer | optional | Relevance score to seed word |
easeOfRankingScore | integer | optional | Ease of ranking score (the higher, the easier it is to rank) |
organicProductCount | integer | optional | Number of naturally ranked products |
sponsoredProductCount | integer | optional | Advertising product quantity |
ppcBidExact | number | optional | Exact match PPC recommended bid (USD) |
ppcBidBroad | number | optional | Broad match PPC recommended bid (USD) |
spBrandAdBid | number | optional | Sponsored Brand Ad Recommended Bid (USD) |
recommendedPromotions | integer | optional | Recommended promotional gift quantity |
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.