https://api.nexscope.ai/amazon/searchByImageRun 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/searchByImage |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
imageUrl | string | required | Valid image URL, maximum length 1000. |
amazonDomain | string | required | Site: `amazon.com`, `amazon.co.uk`, `amazon.de`, `amazon.fr`, `amazon.it`, `amazon.es`, `amazon.co.jp`, `amazon.in`. |
sort | string | optional | `default`, `price-asc-rank`, `price-desc-rank`, `rating-asc-rank`, `rating-desc-rank`, `ratings-asc-rank` or `ratings-desc-rank`. Example: default |
deliveryZip | string | optional | The postal code or city of the delivery address on the site, the maximum length is 1000. The default postal codes of each site: `10001` in the United States, `EC1A 1BB` in the United Kingdom, `10115` in Germany, `75001` in France, `00100` in Italy, `28001` in Spain, `100-0001` in Japan, and `110034` in India. |
countryOrAreaCode | string | optional | Off-site shipping country code, e.g. `CN`, `JP`, `KR`, `TW`, `HK`, `MO`, `SG`, `TH`, `VN`, `PH`, `MY`; cannot be specified at the same time as the postal code in the site, and the Indian site does not support it. Maximum length 1000. |
aggregateByKeepaData | boolean | optional | Whether to aggregate KP data, including sales ranking, monthly sales, FBA fees and sizes, etc. |
responseFormat | string | optional | raw (default) returns the provider result; matches forces enrichment and returns ranked matches. Example: raw |
topN | integer | optional | Maximum matches in matches mode, clamped to 1-100; default 20. Example: 20 |
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
responseFormat=raw (default) returns provider product fields; matches returns query, ranked matches, and caveats.
| Name | Type | Required | Description |
|---|---|---|---|
caveats | array | optional | Caveats value used by this API operation. |
caveats[] | string | required | Item in caveats. |
matches | array | optional | Ranked visual matches with optional provider enrichment. |
matches[] | object | required | Item in matches. |
matches[].asin | string | optional | Asin value used by this API operation. |
matches[].estimatedMonthlySales | integer | optional | Estimated monthly sales value used by this API operation. |
matches[].imageUrl | string | optional | Image url value used by this API operation. |
matches[].price | number | optional | Price value used by this API operation. |
matches[].rank | integer | optional | Rank value used by this API operation. |
matches[].rating | number | optional | Rating value used by this API operation. |
matches[].title | string | optional | Title value used by this API operation. |
query | object | optional | Normalized image search query in matches mode. |
Additional documented fields
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | optional | Total number of rows. Example: null |
totalCount | integer | optional | Total quantity. Example: null |
perPage | integer | optional | Quantity per page. Example: null |
currentPage | integer | optional | Current page number. Example: null |
type | string | optional | Rendering style. Example: null |
sourceType | string | optional | Source type. Example: null |
columns | array | optional | Rendered columns. Example: null |
costToken | integer | optional | Consume Token. Example: null |
products | array | optional | Product list. Example: null |
asin | string | optional | ASIN。 Example: null |
title | string | optional | Product title Example: null |
imageUrl | string | optional | Image URL, that is, the request address. Example: null |
asinUrl | string | optional | Amazon ASIN details URL. Example: null |
price | number | optional | The current price, in the corresponding currency. Example: null |
oldPrice | number | optional | Underline price. Example: null |
currency | string | optional | Currency. Example: null |
rating | number | optional | Current rating, range 0.0–5.0. Example: null |
ratings | integer | optional | Number of ratings. Example: null |
brand | string | optional | brand. Example: null |
sourceType | string | optional | Source type. Example: null |
salesRank | integer | optional | Sales Ranking (KP). Example: null |
salesRank30 | integer | optional | Average sales ranking (KP) over the past 30 days. Example: null |
salesRank90 | integer | optional | Average sales ranking (KP) over the past 90 days. Example: null |
salesRank180 | integer | optional | Average sales ranking (KP) over the past 180 days. Example: null |
monthlySalesUnits | integer | optional | Monthly sales volume (KP). Example: null |
monthlySalesRevenue | number | optional | Monthly sales. Example: null |
reviewCount | integer | optional | Number of comments (KP). Example: null |
fbaFees | number | optional | FBA delivery fee, the unit is the corresponding currency. Example: null |
profit | number | optional | Profit percentage percentage, for example 25.5 means 25.5%. Example: null |
referralFeePercentage | number | optional | Referral fee percentage. Example: null |
fulfillment | string | optional | Delivery method: `AMZ`, `FBA`, `FBM`. Example: null |
primePrice | number | optional | Prime Price. Example: null |
buyBoxSellerId | string | optional | Buy button seller ID. Example: null |
sellerNum | integer | optional | Number of sellers. Example: null |
variationNum | integer | optional | Number of variants. Example: null |
parentAsin | string | optional | Parent ASIN. Example: null |
availableDate | string | optional | Shelf time, in the format of `yyyy-MM-dd HH:mm:ss`. Example: null |
lastUpdate | string | optional | Last updated time, in the format of `yyyy-MM-dd HH:mm:ss`. Example: null |
manufacturer | string | optional | manufacturer. Example: null |
model | string | optional | model. Example: null |
color | string | optional | color. Example: null |
material | string | optional | Product material. Example: null |
weight | string | optional | Weight in grams. Example: null |
dimension | string | optional | size. Example: null |
itemLength | integer | optional | Product length in millimeters; 0 or -1 if not available. Example: null |
itemWidth | integer | optional | Product width in millimeters; 0 or -1 if not available. Example: null |
itemHeight | integer | optional | Product height in millimeters; 0 or -1 if not available. Example: null |
packageLength | integer | optional | Package length in millimeters. Example: null |
packageWidth | integer | optional | Package width in millimeters. Example: null |
packageHeight | integer | optional | Package height in millimeters. Example: null |
packageWeight | string | optional | Packaging weight in grams. Example: null |
packageDimensions | string | optional | Packaging size. Example: null |
packageQuantity | integer | optional | Number of items in the package; 0 or -1 if not available. Example: null |
dimensionsType | string | optional | Size type. Example: null |
categoryTree | string | optional | Category tree. Example: null |
categoryTreeId | string | optional | Category tree ID. Example: null |
rootCategory | integer | optional | Root category ID. Example: null |
isAdultProduct | boolean | optional | Whether it is an adult product. Example: null |
isHazmat | boolean | optional | Whether it is dangerous goods. Example: null |
urlSlug | string | optional | URL Slug。 Example: null |
productImageUrls | array | optional | List of product images. Example: null |
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 or invalid API key (code 11209, including an incomplete or corrupted copy) or an expired website login session (code 12001), 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.