POST
https://api.nexscope.ai/amazon/opportunity/reportByKeywordRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/amazon/opportunity/reportByKeyword |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
site | string | required | Amazon site code, currently only supports `US`. Example: US |
keyword | string | required | The search keyword to query the insight report. |
Code example
{
"keyword": "ice bricks",
"site": "US"
}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 (6 fields)
| Name | Type | Required | Description |
|---|---|---|---|
code | string | optional | Response code. |
msg | string | optional | Prompt message or error message. |
stdout | string | optional | Comprehensive business insight report content (Markdown format), including six dimensions: market potential, product features, user reviews, customer portraits, search trends, and pricing analysis. |
costTime | integer | optional | The total processing time, in milliseconds. |
costToken | integer | optional | Token consumption. |
type | string | optional | Response type. |
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.