https://api.nexscope.ai/jm/getNicheInfoByKeywordRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/jm/getNicheInfoByKeyword |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
keyword | string | required | Keywords (required, and according to the selected country, translate the keywords into the language of the corresponding country), the maximum length is 1000 characters |
countryCode | string | optional | Country code, optional values: `US` (United States), `JP` (Japan), `DE` (Germany) Example: US |
page | integer | optional | Page number (starting from 1) Example: 1 |
pageSize | integer | optional | Number of returns per page (10-100) Example: 50 |
sortField | string | optional | Sorting field (see sorting options below) Example: unitsSoldT7 |
sortType | string | optional | Sort by: `desc` (descending) or `asc` (ascending) Example: desc |
productCountMin | integer | optional | Product quantity (current) minimum |
productCountMax | integer | optional | Product quantity (current) maximum |
avgPriceMin | number | optional | Average price (current) minimum |
avgPriceMax | number | optional | Average Price (Current) Maximum |
searchVolumeT7Min | integer | optional | Search volume (7 days statistics) minimum value |
searchVolumeT7Max | integer | optional | Maximum search volume (7-day statistics) |
unitsSoldT7Min | integer | optional | Sales volume (7 days statistics) minimum value |
unitsSoldT7Max | integer | optional | Maximum sales volume (7-day statistics) |
clickCountT7Min | integer | optional | Click volume (7 days statistics) minimum value |
clickCountT7Max | integer | optional | Maximum number of clicks (7-day statistics) |
clickConversionRateT7Min | number | optional | Minimum click conversion rate (7-day statistics), the value range is 0-1, representing 0%-100% |
clickConversionRateT7Max | number | optional | The maximum value of click conversion rate (7-day statistics), the value range is 0-1, representing 0%-100% |
brandCountMin | integer | optional | Minimum number of brands |
brandCountMax | integer | optional | Maximum number of brands |
top5BrandsClickShareMin | number | optional | The minimum share of clicks in the market segment occupied by the top 5 brands. The value range is 0-1, representing 0%-100%. |
top5BrandsClickShareMax | number | optional | The maximum share of clicks in the market segment occupied by the top 5 brands. The value range is 0-1, representing 0%-100%. |
avgBrandAgeMin | number | optional | Average brand age (current) minimum |
avgBrandAgeMax | number | optional | Average Brand Age (Current) Max |
avgBrandAgeQoqMin | number | optional | Average brand age (90 days statistics) minimum value |
avgBrandAgeQoqMax | number | optional | Average brand age (90 days statistics) maximum value |
avgBrandAgeYoyMin | number | optional | Average brand age (360 days statistics) minimum value |
avgBrandAgeYoyMax | number | optional | Maximum average brand age (360 days statistics) |
avgSellingPartnerAgeMin | number | optional | Minimum average sales partner age |
avgSellingPartnerAgeMax | number | optional | Maximum average age of sales partners |
avgSellingPartnerAgeQoqMin | number | optional | Average sales partner age (90 days statistics) minimum |
avgSellingPartnerAgeQoqMax | number | optional | Maximum average age of sales partners (90-day statistics) |
avgSellingPartnerAgeYoyMin | number | optional | Average sales partner age (360 days statistics) minimum value |
avgSellingPartnerAgeYoyMax | number | optional | Maximum average age of sales partners (360 days statistics) |
top5ProductsClickShareMin | number | optional | The (current) minimum click share of the top 5 products, the value range is 0-1, representing 0%-100% |
top5ProductsClickShareMax | number | optional | The (current) maximum click share of the top 5 products, the value range is 0-1, representing 0%-100% |
sponsoredProductsPercentageMin | number | optional | The minimum SP advertising proportion, the value range is 0-1, representing 0%-100% |
sponsoredProductsPercentageMax | number | optional | The maximum proportion of SP advertising, the value range is 0-1, representing 0%-100% |
cpcMediumMin | number | optional | CPC (current) minimum |
cpcMediumMax | number | optional | CPC (current) maximum |
launchRateT180Min | number | optional | The minimum success rate of product release (180-day statistics), the value range is 0-1, representing 0%-100% |
launchRateT180Max | number | optional | The maximum success rate of product release (180-day statistics), the value range is 0-1, representing 0%-100% |
newProductRateT180 | number | optional | The minimum value of the proportion of new products (180-day statistics), the value range is 0-1, representing 0%-100% |
returnRateT360Min | number | optional | The minimum return rate (360 days statistics), the value range is 0-1, representing 0%-100% |
returnRateT360Max | number | optional | The maximum return rate (360 days statistics), the value range is 0-1, representing 0%-100% |
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 (41 fields)
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | optional | total |
data | array | optional | List of segment information (see segment object fields below) |
columns | array | optional | Rendered columns |
title | string | optional | Title |
type | string | optional | Rendering style |
costToken | integer | optional | Consume token |
nicheId | string | optional | Segment ID |
nicheTitle | string | optional | market segment title |
translationZh | string | optional | Market segment title (Chinese) |
demand | integer | optional | segment score |
productCount | integer | optional | Product quantity |
avgPrice | number | optional | Product average price |
minimumPrice | number | optional | Product lowest price |
maximumPrice | number | optional | Product highest price |
searchVolumeWeekly | integer | optional | Search volume (weekly data) |
searchVolumeQuarterly | integer | optional | Search volume (quarterly data) |
searchVolumeGrowthWeekly | number | optional | Search volume growth rate (weekly data) |
searchVolumeGrowthQuarterly | number | optional | Search volume growth rate (quarterly data) |
unitsSoldWeekly | integer | optional | Sales quantity (weekly data) |
unitsSoldQuarterly | integer | optional | Sales volume (quarterly data) |
clickCountWeekly | integer | optional | Clicks (weekly data) |
clickCountQuarterly | integer | optional | Clicks (quarterly data) |
clickToSaleConversionWeekly | number | optional | Click conversion rate (weekly data) |
clickConversionRateQuarterly | number | optional | Click conversion rate (quarterly data) |
searchConversionRateWeekly | number | optional | Search conversion rate (weekly data) |
searchConversionRateQuarterly | number | optional | Search conversion rate (quarterly data) |
brandCount | integer | optional | Number of brands |
top5BrandsClickShare | number | optional | Click share of market segments occupied by top 5 brands |
top5ProductsClickShare | number | optional | Click share of the top 5 products |
avgBrandAgeNow | number | optional | Average brand age (current) |
avgBrandAgeQuarterly | number | optional | Average brand age (quarterly data) |
newProductsLaunchedSemiannual | integer | optional | Number of new products launched (half-year data) |
successfulLaunchedSemiannual | integer | optional | Number of successfully released products (half-year data) |
launchRateSemiannual | number | optional | Success rate of product release (half-year data) |
returnRateAnnual | number | optional | Return rate (full year data) |
acos | number | optional | (ACOS) Advertising Cost of Sales Ratio |
profitMarginGt50PctSkuRatio | number | optional | Proportion of products with profit margin greater than 50% |
breakEvenRatio | number | optional | Break-even natural proportion |
cpc | object | optional | CPC data: `{ high (highest price), medium (middle price), low (lowest price) }` |
categorieList | array | optional | Product category list |
referenceAsinImageUrl | string | optional | Market segment reference picture address |
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.