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
| 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.costTime | any | optional | Cost time value used by this API operation. |
data.costToken | any | optional | Cost token value used by this API operation. |
data.country | any | optional | Country value used by this API operation. |
data.dataSnapshotMonth | any | optional | Data snapshot month value used by this API operation. |
data.dominantCategory | any | optional | Dominant category value used by this API operation. |
data.easeOfRankingScore | any | optional | Ease of ranking score value used by this API operation. |
data.keywordInfoList | any | optional | Keyword info list value used by this API operation. |
data.monthlySearchVolumeBroad | any | optional | Monthly search volume broad value used by this API operation. |
data.monthlySearchVolumeExact | any | optional | Monthly search volume exact value used by this API operation. |
data.monthlyTrend | any | optional | Monthly trend value used by this API operation. |
data.name | any | optional | Name value used by this API operation. |
data.organicProductCount | any | optional | Organic product count 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.ppcBidBroad | any | optional | Ppc bid broad value used by this API operation. |
data.ppcBidExact | any | optional | Ppc bid exact value used by this API operation. |
data.quarterlyTrend | any | optional | Quarterly trend value used by this API operation. |
data.recommendedPromotions | any | optional | Recommended promotions value used by this API operation. |
data.relevancyScore | any | optional | Relevancy score 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.spBrandAdBid | any | optional | Sp brand ad bid value used by this API operation. |
data.sponsoredProductCount | any | optional | Sponsored product count 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. |
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 | Number of tokens consumed 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.country | string | optional | market code Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.country | null | optional | Country 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.dominantCategory | string | optional | Category with the highest proportion in search results Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.dominantCategory | null | optional | Dominant category value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.easeOfRankingScore | integer | optional | Ease of ranking score (the higher, the easier it is to rank) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.easeOfRankingScore | null | optional | Ease of ranking score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordInfoList | array | optional | Keyword information list Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordInfoList | null | optional | Keyword info list value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.monthlySearchVolumeBroad | integer | optional | Average monthly broad match search volume Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.monthlySearchVolumeBroad | null | optional | Monthly search volume broad value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.monthlySearchVolumeExact | integer | optional | Average monthly exact match search volume Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.monthlySearchVolumeExact | null | optional | Monthly search volume exact value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.monthlyTrend | number | optional | Monthly search volume percentage change Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.monthlyTrend | null | optional | Monthly trend value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.name | string | optional | Keyword name Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.name | null | optional | Name value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.organicProductCount | integer | optional | Number of naturally ranked products Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.organicProductCount | null | optional | Organic product count 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.ppcBidBroad | number | optional | Broad match PPC recommended bid (USD) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.ppcBidBroad | null | optional | Ppc bid broad value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.ppcBidExact | number | optional | Exact match PPC recommended bid (USD) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.ppcBidExact | null | optional | Ppc bid exact value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.quarterlyTrend | number | optional | Quarterly search volume percentage change Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.quarterlyTrend | null | optional | Quarterly trend value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.recommendedPromotions | integer | optional | Recommended promotional gift quantity Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.recommendedPromotions | null | optional | Recommended promotions value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.relevancyScore | integer | optional | Relevance score to seed word Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.relevancyScore | null | optional | Relevancy score 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.spBrandAdBid | number | optional | Sponsored Brand Ad Recommended Bid (USD) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.spBrandAdBid | null | optional | Sp brand ad bid value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredProductCount | integer | optional | Advertising product quantity Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredProductCount | null | optional | Sponsored product count 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 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.