https://api.nexscope.ai/dl/productBillboardRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/dl/productBillboard |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
keyWord | string | optional | Chinese search keyword, at most 50 characters. Translate your search terms to Chinese before sending. Example: 手机壳 |
date | string | optional | Weekly: Sunday within the last 90 days. Monthly: first day of a month within the last year. Omit for current default. |
pageType | integer | optional | List type: `2` weekly list, `3` monthly list Example: 3 |
pageIndex | integer | optional | Page number, starting from 1 Example: 1 |
pageSize | integer | optional | Return quantity per page, range 10-100 Example: 20 |
sortField | string | optional | `orderCount` sales number, `saleCount` sales number, `saleVolume` estimated sales, `offerCreateTime` shelf time, `price` wholesale price, `consignPrice` consignment price Example: orderCount |
sortType | string | optional | Sorting type: `desc` descending order, `asc` ascending order Example: desc |
searchType | integer | optional | Product keyword search: `1` fuzzy matching, `3` precise matching Example: 1 |
offerType | integer | optional | Product identification: `0` is not limited, `2` is new, `3` is carefully selected by 1688, `4` is cross-border, `5` supports customization, `6` is the treasure of the store Example: 0 |
companyType | integer | optional | Company type: `0` unlimited, `1` shop, `2` factory |
shiLiType | string | optional | Seller membership type, separate multiple choices with commas: `superFactory` super factory, `Power` powerful merchant, `TrustPass` integrity member |
beginTpYear | integer | optional | Start the Integrity Pass period |
endTpYear | integer | optional | End of integrity pass period |
beginPrice | number | optional | Wholesale price starting value |
endPrice | number | optional | wholesale price ending value |
beginConsignPrice | number | optional | Starting value of agency price |
endConsignPrice | number | optional | The end value of the agency price |
beginOrderCount | integer | optional | Starting value of number of sales |
endOrderCount | integer | optional | Sales end value |
beginSaleCount | integer | optional | Starting value of sales units |
endSaleCount | integer | optional | Sales end value |
beginSaleVolume | number | optional | sales starting value |
endSaleVolume | number | optional | sales end value |
beginStartQuantity | integer | optional | Starting batch size |
endStartQuantity | integer | optional | end batch |
beginOfferCreateTime | string | optional | Starting value of shelf time, format `YYYY-MM-DD` |
endOfferCreateTime | string | optional | Shelf time end value, format `YYYY-MM-DD` |
sendTime | string | optional | Shipping time, multiple selections separated by commas: `24`, `48`, `72` hours |
proxyRights | string | optional | For drop-shipping rights, multiple options must be separated by commas: `4360897`, free shipping for one piece, `449154`, purchase first, pay later |
shopService | string | optional | Seller services, multiple selections separated by commas: `4057409` Safe Purchase, `888777` In-depth Certification Report |
buyerProtections | string | optional | Rights protection, separate multiple choices with commas: `Free shipping for goods`, `7-day return guarantee`, `Support freight insurance` |
faceToFaceSupport | string | optional | Farewell support, multiple selections separated by commas: `441218` Taobao, `386434` Douyin, `422914` Pinduoduo, `422978` Xiaohongshu, `386370` Kuaishou |
productIds | string | optional | Up to 20 product IDs separated by Chinese enumeration commas (、). |
goodsUrl | string | optional | Product link address |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "0",
"data": {
"products": [
{
"currency": "CNY",
"offerId": "1234567890123456789",
"price": 4.2,
"title": "Example product"
}
],
"total": 1,
"columns": []
},
"msg": null,
"time": "2026-10-20T00:00:00Z",
"traceId": null,
"ts": "0"
}Response fields
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | optional | Nexscope transport/business envelope code; 0 means the request was processed. Inspect data for operation outcomes. |
cost | string | optional | Processing time in milliseconds, not credits. |
data | object | optional | Data value used by this API operation. |
data.columns | array | optional | Render column definition |
data.columns[] | any | required | Item in data columns. |
data.products | array | optional | Products value used by this API operation. |
data.products[] | object | required | Item in data products. |
data.products[].asin | string | optional | Item number |
data.products[].asinUrl | string | optional | Product link address |
data.products[].availableDate | string | optional | Product shelf time, in the format of `yyyy-MM-dd HH:mm:ss` |
data.products[].company | string | optional | Store name |
data.products[].consignPrice | number | optional | Price on behalf of others |
data.products[].currency | string | optional | Currency |
data.products[].dataType | string | optional | Data type: `weeklyData` weekly data, `monthlyData` monthly data |
data.products[].deliveryTime | string | optional | Shipping time |
data.products[].estimatedSalesAmount | integer | optional | Estimated sales, returning corresponding values according to statistical period |
data.products[].imageUrl | string | optional | Image address |
data.products[].levelName | string | optional | Category level name |
data.products[].offerId | string | optional | Product ID |
data.products[].price | number | optional | wholesale price |
data.products[].quantityBegin | integer | optional | Minimum batch size |
data.products[].quantityPrices | string | optional | price range |
data.products[].salesOrderCount | integer | optional | The number of sales, returns the corresponding value according to the statistical period |
data.products[].salesQuantity | integer | optional | The number of pieces sold, returns the corresponding value according to the statistical period |
data.products[].shopId | string | optional | Store ID |
data.products[].shopUrl | string | optional | Store link address |
data.products[].sourceType | string | optional | Source platform (1688) |
data.products[].title | string | optional | Product title |
data.products[].unit | string | optional | unit |
data.total | integer | optional | Number of records |
data.type | string | optional | rendering style |
msg | string | null | optional | Safe response message. |
time | string | optional | Server response time. |
traceId | string | null | optional | Request trace identifier. |
ts | string | optional | Server timestamp. |
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.