https://api.nexscope.ai/js/product-database/queryRun 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/product-database/query |
| 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 |
includeKeywords | string | optional | Title/ASIN contains keywords, comma separated, up to 100 items, each item can be up to 50 characters |
excludeKeywords | string | optional | Title/ASIN excluded keywords, comma separated, up to 100 items, each item can be up to 50 characters |
categories | string | optional | Main category names, separated by commas, must match the standard category names of the corresponding site. Examples of US sites: Appliances, Arts Crafts & Sewing, Automotive, Baby, Beauty & Personal Care, Books, CDs & Vinyl, Cell Phones & Accessories, Clothing Shoes & Jewelry, Collectibles & Fine Art, Computers, Digital Music, Electronics, Garden & Outdoor, Grocery & Gourmet Food, Handmade, Health Household & Baby Care, Home & Kitchen, Industrial & Scientific, Kindle Store, Kitchen & Dining, Movies & TV, Musical Instruments, Office Products, Pet Supplies, Sports & Outdoors, Tools & Home Improvement, Toys & Games, Video Games, etc.; other sites have corresponding local category names |
minPrice | number | optional | lowest price |
maxPrice | number | optional | highest price |
minSales | integer | optional | Minimum monthly sales |
maxSales | integer | optional | Highest monthly sales |
minRevenue | number | optional | minimum monthly income |
maxRevenue | number | optional | highest monthly income |
minReviews | integer | optional | Minimum number of comments |
maxReviews | integer | optional | Highest number of comments |
minRating | number | optional | Lowest rating (1.0-5.0) |
maxRating | number | optional | Highest rating (1.0-5.0) |
minWeight | number | optional | Minimum weight (lbs) |
maxWeight | number | optional | Maximum weight (lbs) |
minRank | integer | optional | Lowest BSR Rank |
maxRank | integer | optional | Highest BSR Rank |
minLqs | integer | optional | Minimum LQS score (1-10) |
maxLqs | integer | optional | Highest LQS score (1-10) |
minSellers | integer | optional | Minimum number of sellers |
maxSellers | integer | optional | Maximum number of sellers |
minNet | number | optional | minimum net profit |
maxNet | number | optional | highest net profit |
sellerTypes | string | optional | Seller types, separated by commas. Optional values: `amz` (Amazon self-operated), `fba`, `fbm` |
productTiers | string | optional | Product size hierarchy, separated by commas. Optional values: `oversize`, `standard` |
excludeTopBrands | boolean | optional | Whether to exclude top brands |
excludeUnavailableProducts | boolean | optional | Whether to exclude unpurchasable items |
minUpdatedAt | string | optional | Data update start date (YYYY-MM-DD) |
maxUpdatedAt | string | optional | Data update deadline (YYYY-MM-DD) |
needCount | integer | optional | The total number of results to be returned, automatic paging within the API |
sort | string | optional | Sort field. Available options
Example: name |
Code example
{
"includeKeywords": "yoga mat",
"marketplace": "us",
"maxPrice": 50,
"minRating": 4,
"minSales": 300,
"needCount": 20,
"sort": "-sales"
}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.approximate30DayRevenue | any | optional | Approximate30 day revenue value used by this API operation. |
data.approximate30DayUnitsSold | any | optional | Approximate30 day units sold value used by this API operation. |
data.brand | any | optional | Brand value used by this API operation. |
data.breadcrumbPath | any | optional | Breadcrumb path value used by this API operation. |
data.buyBoxOwner | any | optional | Buy box owner value used by this API operation. |
data.buyBoxOwnerSellerId | any | optional | Buy box owner seller id value used by this API operation. |
data.category | any | optional | Category 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.dataSnapshotMonth | any | optional | Data snapshot month value used by this API operation. |
data.dateFirstAvailable | any | optional | Date first available value used by this API operation. |
data.dateFirstAvailableIsEstimated | any | optional | Date first available is estimated value used by this API operation. |
data.dimensionsUnit | any | optional | Dimensions unit value used by this API operation. |
data.eanList | any | optional | Ean list value used by this API operation. |
data.feeBreakdown | any | optional | Fee breakdown value used by this API operation. |
data.gtinList | any | optional | Gtin list value used by this API operation. |
data.heightValue | any | optional | Height value value used by this API operation. |
data.id | any | optional | Id value used by this API operation. |
data.imageUrl | any | optional | Image url value used by this API operation. |
data.isAvailable | any | optional | Is available value used by this API operation. |
data.isParent | any | optional | Is parent value used by this API operation. |
data.isStandalone | any | optional | Is standalone value used by this API operation. |
data.isVariant | any | optional | Is variant value used by this API operation. |
data.isbnList | any | optional | Isbn list value used by this API operation. |
data.lengthValue | any | optional | Length value value used by this API operation. |
data.listingQualityScore | any | optional | Listing quality score value used by this API operation. |
data.numberOfSellers | any | optional | Number of sellers 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.parentAsin | any | optional | Parent asin value used by this API operation. |
data.price | any | optional | Price value used by this API operation. |
data.productDatabaseList | any | optional | Product database list value used by this API operation. |
data.productRank | any | optional | Product rank value used by this API operation. |
data.rating | any | optional | Rating value used by this API operation. |
data.reviews | any | optional | Reviews value used by this API operation. |
data.sellerType | any | optional | Seller type 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.subcategoryRanks | any | optional | Subcategory ranks 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. |
data.upcList | any | optional | Upc list value used by this API operation. |
data.updatedAt | any | optional | Updated at value used by this API operation. |
data.variants | any | optional | Variants value used by this API operation. |
data.weightUnit | any | optional | Weight unit value used by this API operation. |
data.weightValue | any | optional | Weight value value used by this API operation. |
data.widthValue | any | optional | Width value value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.approximate30DayRevenue | number | optional | Estimated revenue for the last 30 days (USD) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.approximate30DayRevenue | null | optional | Approximate30 day revenue value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.approximate30DayUnitsSold | integer | optional | Estimated sales in the past 30 days Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.approximate30DayUnitsSold | null | optional | Approximate30 day units sold value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.brand | string | optional | brand name Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.brand | null | optional | Brand value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.breadcrumbPath | string | optional | Full classification path Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.breadcrumbPath | null | optional | Breadcrumb path value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.buyBoxOwner | string | optional | Buy Box holds seller name Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.buyBoxOwner | null | optional | Buy box owner value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.buyBoxOwnerSellerId | string | optional | Buy Box holds seller ID Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.buyBoxOwnerSellerId | null | optional | Buy box owner seller id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.category | string | optional | Main category Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.category | null | optional | Category 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.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.dateFirstAvailable | string | optional | Date first put on shelves Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.dateFirstAvailable | null | optional | Date first available value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.dateFirstAvailableIsEstimated | boolean | optional | Is the release date an estimate? Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.dateFirstAvailableIsEstimated | null | optional | Date first available is estimated value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.dimensionsUnit | string | optional | Dimensional unit Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.dimensionsUnit | null | optional | Dimensions unit value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.eanList | array | optional | EAN code list Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.eanList | null | optional | Ean list value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.feeBreakdown | object | optional | Fee details: `fbaFee` (FBA fee), `referralFee` (referral fee), `variableClosingFee` (variable settlement fee), `totalFees` (total fee) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.feeBreakdown | null | optional | Fee breakdown value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.gtinList | array | optional | GTIN code list Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.gtinList | null | optional | Gtin list value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.heightValue | number | optional | height Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.heightValue | null | optional | Height value value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.id | string | optional | Product unique identifier Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.id | null | optional | Id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.imageUrl | string | optional | Product main image URL Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.imageUrl | null | optional | Image url value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.isAvailable | boolean | optional | available for purchase Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.isAvailable | null | optional | Is available value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.isParent | boolean | optional | Is it the parent body? Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.isParent | null | optional | Is parent value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.isStandalone | boolean | optional | Is it an independent product? Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.isStandalone | null | optional | Is standalone value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.isVariant | boolean | optional | Is it a variant? Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.isVariant | null | optional | Is variant value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.isbnList | array | optional | ISBN code list Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.isbnList | null | optional | Isbn list value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.lengthValue | number | optional | length Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.lengthValue | null | optional | Length value value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.listingQualityScore | integer | optional | Listing Quality Score (LQS, 1-10) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.listingQualityScore | null | optional | Listing quality score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.numberOfSellers | integer | optional | Number of sellers on sale Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.numberOfSellers | null | optional | Number of sellers 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.parentAsin | string | optional | Parent ASIN Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.parentAsin | null | optional | Parent asin value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.price | number | optional | Current selling price (USD) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.price | null | optional | Price value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.productDatabaseList | array | optional | Product data list Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.productDatabaseList | null | optional | Product database list value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.productRank | integer | optional | BSR Ranking Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.productRank | null | optional | Product rank value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.rating | number | optional | Average rating (1.0-5.0) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.rating | null | optional | Rating value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.reviews | integer | optional | Total number of comments Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.reviews | null | optional | Reviews value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sellerType | string | optional | Seller type (amz/fba/fbm) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sellerType | null | optional | Seller type 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.subcategoryRanks | array | optional | Subcategory BSR ranking list, each containing `subcategory`, `rank`, `id` Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.subcategoryRanks | null | optional | Subcategory ranks value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.title | string | optional | product 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 | Resource 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 1
| Name | Type | Required | Description |
|---|---|---|---|
data.upcList | array | optional | UPC code list Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.upcList | null | optional | Upc list value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.updatedAt | string | optional | Data update time Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.updatedAt | null | optional | Updated at value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.variants | array | optional | Variation list Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.variants | null | optional | Variants value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.weightUnit | string | optional | weight unit Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.weightUnit | null | optional | Weight unit value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.weightValue | number | optional | Product weight Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.weightValue | null | optional | Weight value value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.widthValue | number | optional | Width Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.widthValue | null | optional | Width value 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.