POST
https://api.nexscope.ai/api/skill-api/v1/skills/amazon-keyword-expansion/runRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/api/skill-api/v1/skills/amazon-keyword-expansion/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
marketplace | string | required | Target marketplace code. Options: us, uk, de, in, ca, fr, it, es, mx, jp. Default us Example: us |
searchTerms | string | required | Seed keyword (single keyword string) Example: phone case |
needCount | integer | optional | Total number of results returned Example: 10 |
sort | string | optional | Sort field, default -monthly_search_volume_exact (exact search volume descending) |
minMonthlySearchVolumeExact | integer | optional | Minimum exact search volume Example: 1 |
maxMonthlySearchVolumeExact | integer | optional | Maximum exact search volume Example: 1 |
minMonthlySearchVolumeBroad | integer | optional | Minimum broad search volume Example: 1 |
maxMonthlySearchVolumeBroad | integer | optional | Maximum broad search volume Example: 1 |
minWordCount | integer | optional | Minimum word count for keywords (for filtering long-tail keywords) Example: 1 |
maxWordCount | integer | optional | Maximum word count for keywords Example: 1 |
minOrganicProductCount | integer | optional | Minimum organic product count Example: 1 |
maxOrganicProductCount | integer | optional | Maximum organic product count Example: 1 |
Code example
{
"marketplace": "us",
"needCount": 10,
"searchTerms": "phone case"
}Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "-1",
"data": {
"costToken": 1,
"keywordInfoList": [
{
"easeOfRankingScore": 1,
"monthlySearchVolumeBroad": 1,
"monthlySearchVolumeExact": 1,
"monthlyTrend": 1,
"organicProductCount": 1,
"ppcBidBroad": 1,
"ppcBidExact": 1,
"quarterlyTrend": 1,
"recommendedPromotions": 1,
"relevancyScore": 1,
"spBrandAdBid": 1,
"sponsoredProductCount": 1
}
]
},
"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 | integer | optional | Execution time reported by the upstream provider. Example: null |
data.costToken | integer | optional | Tokens consumed Example: 1 |
data.dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. Example: null |
data.keywordInfoList | array | optional | Keyword information list Example: [] |
data.keywordInfoList[] | object | required | Item in data keywordInfoList. |
data.keywordInfoList[].country | string | optional | Marketplace code Example: null |
data.keywordInfoList[].dominantCategory | string | optional | Category with the highest share in search results Example: null |
data.keywordInfoList[].easeOfRankingScore | integer | optional | Ease of ranking score (higher means easier to rank) Example: 1 |
data.keywordInfoList[].monthlySearchVolumeBroad | integer | optional | Monthly average broad match search volume Example: 1 |
data.keywordInfoList[].monthlySearchVolumeExact | integer | optional | Monthly average exact match search volume Example: 1 |
data.keywordInfoList[].monthlyTrend | number | optional | Monthly search volume change percentage Example: 1 |
data.keywordInfoList[].name | string | optional | Keyword name Example: null |
data.keywordInfoList[].organicProductCount | integer | optional | Number of organic ranking products Example: 1 |
data.keywordInfoList[].ppcBidBroad | number | optional | Broad match PPC suggested bid (USD) Example: 1 |
data.keywordInfoList[].ppcBidExact | number | optional | Exact match PPC suggested bid (USD) Example: 1 |
data.keywordInfoList[].quarterlyTrend | number | optional | Quarterly search volume change percentage Example: 1 |
data.keywordInfoList[].recommendedPromotions | integer | optional | Number of recommended promotion giveaways Example: 1 |
data.keywordInfoList[].relevancyScore | integer | optional | Relative relevance score to the seed keyword. Higher values indicate a closer match; the upstream provider does not document a fixed 0-100 range Example: 1 |
data.keywordInfoList[].spBrandAdBid | number | optional | Sponsored Brand ad suggested bid (USD) Example: 1 |
data.keywordInfoList[].sponsoredProductCount | integer | optional | Number of sponsored products Example: 1 |
data.page | integer | optional | Current page returned by the upstream provider. Example: null |
data.pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. Example: null |
data.pageSize | integer | optional | Page size returned by the upstream provider. Example: null |
data.sourceTool | string | optional | Provider-specific source tool name. Example: null |
data.sourceType | string | optional | Provider-specific source platform type. Example: null |
data.title | string | optional | Provider-specific response title. Example: null |
data.totalPage | integer | optional | Total page count returned by the upstream provider. Example: null |
data.type | string | optional | Provider-specific render or payload type. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data | null | required | Data value used by this API operation. |
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.