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 |
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 |
|---|---|---|---|
costToken | integer | optional | Number of tokens consumed |
productDatabaseList | array | optional | Product data list |
id | string | optional | Product unique identifier |
title | string | optional | product title |
brand | string | optional | brand name |
category | string | optional | Main category |
breadcrumbPath | string | optional | Full classification path |
price | number | optional | Current selling price (USD) |
approximate30DayUnitsSold | integer | optional | Estimated sales in the past 30 days |
approximate30DayRevenue | number | optional | Estimated revenue for the last 30 days (USD) |
productRank | integer | optional | BSR Ranking |
reviews | integer | optional | Total number of comments |
rating | number | optional | Average rating (1.0-5.0) |
listingQualityScore | integer | optional | Listing Quality Score (LQS, 1-10) |
numberOfSellers | integer | optional | Number of sellers on sale |
sellerType | string | optional | Seller type (amz/fba/fbm) |
imageUrl | string | optional | Product main image URL |
dateFirstAvailable | string | optional | Date first put on shelves |
weightValue | number | optional | Product weight |
weightUnit | string | optional | weight unit |
lengthValue | number | optional | length |
widthValue | number | optional | Width |
heightValue | number | optional | height |
dimensionsUnit | string | optional | Dimensional unit |
parentAsin | string | optional | Parent ASIN |
isParent | boolean | optional | Is it the parent body? |
isVariant | boolean | optional | Is it a variant? |
isStandalone | boolean | optional | Is it an independent product? |
isAvailable | boolean | optional | available for purchase |
buyBoxOwner | string | optional | Buy Box holds seller name |
buyBoxOwnerSellerId | string | optional | Buy Box holds seller ID |
updatedAt | string | optional | Data update time |
feeBreakdown | object | optional | Fee details: `fbaFee` (FBA fee), `referralFee` (referral fee), `variableClosingFee` (variable settlement fee), `totalFees` (total fee) |
subcategoryRanks | array | optional | Subcategory BSR ranking list, each containing `subcategory`, `rank`, `id` |
type | string | optional | Resource type |
variants | array | optional | Variation list |
upcList | array | optional | UPC code list |
eanList | array | optional | EAN code list |
isbnList | array | optional | ISBN code list |
gtinList | array | optional | GTIN code list |
dateFirstAvailableIsEstimated | boolean | optional | Is the release date an estimate? |
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.