https://api.nexscope.ai/ss/competitor-lookupRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/ss/competitor-lookup |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
marketplace | string | optional | Amazon site codes: `US`, `UK`, `DE`, `FR`, `JP`, `CA`, `IT`, `ES`, `MX`, `AU`, `TR`, `IN` Example: US |
keyword | string | optional | Search keywords, it is recommended to use the target site language |
asinList | string | optional | ASIN, multiple ASINs separated by English commas, up to 40; format: `^[A-Z0-9]+(,[A-Z0-9]+){0,39}$` |
sellerName | string | optional | Seller name filter |
brand | string | optional | Brand name filter |
nodeLabel | string | optional | Amazon category name, supports multi-level category names, and the levels are separated by English colon `:` |
nodeIdPath | string | optional | Amazon Category ID Path |
matchType | integer | optional | Matching method: `1` phrase matching, `2` fuzzy matching, `3` precise matching Example: 1 |
showVariation | string | optional | Whether to query the variant: `Y` yes, `N` no Example: N |
dataSnapshotMonth | string | optional | `nearly` represents the last 30 days of real-time data; historical snapshots can also be queried in the `yyyyMM` format, such as `202412` Example: nearly |
page | integer | optional | Page number, starting from 1 Example: 1 |
size | integer | optional | Number of items per page, return 10–100 pieces of data Example: 50 |
order | object | optional | Sorting configuration, fields are shown in the table below |
field | string | required | Sorting fields: `total_units`, `total_amount`, `bsr_rank`, `price`, `rating`, `reviews`, `profit`, `reviews_rate`, `available_date`, `questions`, `total_units_growth`, `total_amount_growth`, `reviews_increasement`, `bsr_rank_cv`, `bsr_rank_cr`, `amz_unit` Example: total_units |
desc | string | required | Sorting direction: `true` descending order, `false` ascending order Example: true |
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 (64 fields)
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | optional | Total number of matching results |
sourceType | string | optional | Source type, such as `amazon` |
message | string | optional | Execution message or error description |
type | string | optional | rendering style |
nodeLabel | string | optional | Category name echo |
columns | array | optional | Rendered column definitions |
products | array | optional | Competing product list |
costToken | integer | optional | Consume token |
asin | string | optional | Product ASIN |
title | string | optional | Product title |
price | number | optional | current price |
primePrice | number | optional | Prime price |
averagePrice | number | optional | average price |
currency | string | optional | Currency |
monthlySalesUnits | integer | optional | Monthly sales volume (number of pieces) |
monthlySalesRevenue | number | optional | monthly sales |
monthlySalesUnitsGrowthRate | number | optional | monthly sales growth rate |
bsr | integer | optional | BSR Ranking |
bsrGrowthRate | number | optional | BSR growth rate |
bsrGrowthCount | integer | optional | BSR growth number |
rating | number | optional | Rating |
ratings | integer | optional | Rating number |
ratingsGrowth | integer | optional | Number of new ratings per month |
ratingsRate | number | optional | Review rate |
brand | string | optional | brand |
brandUrl | string | optional | Brand URL |
sellerName | string | optional | BuyBox seller name |
sellerId | string | optional | BuyBox seller ID |
sellerNation | string | optional | BuyBox seller nationality |
sellerNum | integer | optional | Number of sellers |
fulfillment | string | optional | Delivery method: `AMZ`, `FBA`, `FBM` |
availableDate | string | optional | Release time (date format) |
availableDateString | string | optional | Release date (string format) |
profit | number | optional | Gross profit margin |
fba | number | optional | FBA shipping |
deliveryPrice | number | optional | Seller shipping fee |
imageUrl | string | optional | Product image URL |
parent | string | optional | Parent ASIN |
variationNum | integer | optional | number of variants |
variant30DayUnits | integer | optional | Monthly sales volume of daughter bodies (number of pieces) |
variant30DayRevenue | number | optional | Subsidiary monthly sales |
variant30DayUpdatedAt | string | optional | Child data update time (timestamp) |
amzUnitDateString | string | optional | Sub-body sales update date |
listingQualityScore | number | optional | Listing quality score |
nodeLabelPath | string | optional | Category path |
nodeIdPath | string | optional | Node ID path |
nodeId | integer | optional | Node ID |
dimension | string | optional | Product size |
dimensionsType | string | optional | size type |
weight | string | optional | Product weight |
packageDimensions | string | optional | Packing size |
packageDimensionType | string | optional | Packaging size type |
packageWeight | string | optional | Packing weight |
sku | string | optional | SKU |
keyword | string | optional | matching keywords |
dataSnapshotMonth | string | optional | Data query month |
sourceType | string | optional | Source type |
badgeBestSeller | string | optional | Best Seller logo (Y/N) |
badgeAmazonChoice | string | optional | Amazon's Choice logo (Y/N) |
badgeNewRelease | string | optional | New Release logo (Y/N) |
badgeEbc | string | optional | A+ page identification (Y/N) |
badgeVideo | string | optional | Video introduction logo (Y/N) |
badge | object | optional | Identity details object, including `bestSeller`, `amazonChoice`, `newRelease`, `ebc`, `video` (all Y/N strings) |
subcategories | array | optional | Subcategory rankings, each including `code`, `rank`, `label` |
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.