https://api.nexscope.ai/ebay/searchRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/ebay/search |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
keyword | string | optional | Search keywords, maximum 1024 characters |
ebayDomain | string | optional | eBay site domain name. Optional values: `ebay.com` (United States), `ebay.co.uk` (UK), `ebay.de` (Germany), `ebay.fr` (France), `ebay.it` (Italy), `ebay.es` (Spain), `ebay.ca` (Canada), `ebay.com.au` (Australia) ), `ebay.nl` (Netherlands), `ebay.at` (Austria), `ebay.ch` (Switzerland), `ebay.pl` (Poland), `ebay.ie` (Ireland), `ebay.com.hk` (Hong Kong, China), `ebay.com.my` (Malaysia), `ebay.com.sg` (Singapore) |
page | integer | optional | Page number, used for pagination Example: 1 |
pageSize | integer | optional | The maximum number of results returned per page. Optional values: `25`, `50`, `100`, `200` Example: 50 |
orderBy | string | optional | Sort by. Optional values: `1` (soon to end), `2` (lowest price), `3` (highest price), `7` (closest), `10` (latest on the shelves), `12` (best match), `15` (lowest price + shipping fee), `16` (highest price + shipping fee), `18` (new product first), `19` (second-hand priority) Example: 12 |
priceMin | number | optional | Lowest price filter |
priceMax | number | optional | Highest price filter |
itemCondition | string | optional | Product status code, multiple separated by `\|`. Optional values: `1000` (new), `1500` (new other), `1750` (new with defects), `2000` (official refurbished), `2010` (excellent refurbished), `2020` (Good Refurbished), `2030` (Generally Refurbished), `2500` (Seller Refurbished), `2750` (Almost New), `3000` (Second Hand/Used), `7000` (Accessory or Not Working) |
buyingFormat | string | optional | Purchase format. Optional values: `Auction` (auction), `BIN` (fixed price), `BO` (best offer) |
showOnly | string | optional | Filter conditions, multiple values separated by commas. Optional values: `Complete` (Ended), `Sold` (Sold), `FR` (Free Returns), `RPA` (Returns Accepted), `AS` (Authorized Seller), `Savings` (discount), `SaleItems` (promotional items), `Lots` (bulk), `Charity` (charity), `AV`, `FS` (free shipping), `LPickup` (self-pickup) |
location | integer | optional | The country/region code where the product is located, for example: `1` (United States), `2` (Canada), `3` (UK), `45` (China), `77` (Germany) |
prefLoc | string | optional | Preferred location range. Optional values: `1` (national), `2` (regional), `3` (global) |
zipCode | string | optional | ZIP or postal code to filter products for delivery by area |
categoryId | integer | optional | eBay category ID, used to search for specified categories |
noCache | boolean | optional | Whether to disable caching Example: false |
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 (27 fields)
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | optional | Total number of matching results |
products | array | optional | Product list array (see product fields below for details) |
columns | array | optional | Rendered column definitions |
type | string | optional | Rendering style identifier |
costToken | integer | optional | Consume token |
productId | string | optional | eBay item ID |
title | string | optional | Product title |
subtitle | string | optional | Product subtitle |
price | number | optional | Current price/transaction price |
minPrice | number | optional | Starting value of the price range (applicable to products of multiple specifications) |
maxPrice | number | optional | The end value of the price range (applicable to multi-specification products) |
oldPrice | number | optional | Original price before discount |
currency | string | optional | Currency units such as USD, GBP, EUR |
condition | string | optional | Product status description |
link | string | optional | eBay product detail page link |
imageUrl | string | optional | Product thumbnail URL |
shipping | string | optional | Shipping information |
location | string | optional | Product location |
sellerName | string | optional | Seller name |
sellerReviews | integer | optional | Number of seller reviews |
positiveFeedbackInPercentage | number | optional | Seller’s positive rating |
salesQuantity | integer | optional | Quantity sold |
bidsCount | integer | optional | Bid quantity (auction items) |
returns | string | optional | Return information |
promotion | string | optional | Promotional information |
sponsored | boolean | optional | Is it a sponsored/promoted product? |
sourceType | string | optional | Source platform identification (`ebay`) |
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.