1688 Product Billboard API

REST API and MCP service documentation generated from server-side API definitions. Responses use the shared code, msg, and data envelope.

API selector

1688 Sourcing

API overview

Query 1688 bestseller charts for wholesale sourcing and product research. Review request parameters, response fields, and MCP usage.

Try this API

Endpoint

https://api.nexscope.ai/api/skill-api/v1/skills/1688-product-billboard/run

MCP method

nexscope_1688_product_billboard

Authentication

All run endpoints require a user API key. Send it as a bearer token in the Authorization header.

Authorization: Bearer nk-xxxxxxxxxxxxxxxxx

Missing or invalid API keys return an authentication error. Manage keys from .

POSThttps://api.nexscope.ai/api/skill-api/v1/skills/1688-product-billboard/run

Run an API

Request parameters documented by ecommerce.1688-product-billboard.

Slug	`1688-product-billboard`
Headers	`Authorization: Bearer nk-...` `Content-Type: application/json`
Request body	API-specific JSON object.
Response body	Platform envelope: code, msg, data, ts, time, cost, traceId. Inspect data.status for asynchronous completion.

Status codes

Code	Description
200	HTTP request completed. Check JSON code; only 0 indicates business success or acceptance.
400	Request JSON or required API parameters are invalid.
401	API key is missing, invalid, or cannot be matched to a user.
5xx	API execution or upstream service failed.

Example request

curl -X POST https://api.nexscope.ai/api/skill-api/v1/skills/1688-product-billboard/run \
  -H "Authorization: Bearer nk-xxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{   "pageType": 3,   "searchType": 1,   "pageIndex": 1,   "keyWord": "iPhone 15",   "date": "2026-07-01",   "pageSize": 10 }'

All categories/ 1688 Sourcing

POSThttps://api.nexscope.ai/api/skill-api/v1/skills/1688-product-billboard/run

Run this API

Send a JSON request to execute this API and receive the documented response payload.

Open tester

Endpoint

Method	`POST`
Path	`https://api.nexscope.ai/api/skill-api/v1/skills/1688-product-billboard/run`
Auth	`Bearer API key`
Content-Type	`application/json`

Request body

Name	Type	Required	Description
`keyWord`	`string`	optional	Product search keyword (must be written in Simplified Chinese; translate it before calling this API). Maximum 50 characters Example: iPhone 15
`date`	`string`	optional	Query time. Weekly chart: pass the Sunday date of that week, e.g. 2025-06-15 (up to 90 days); Monthly chart: pass the first day of the month, e.g. 2025-06-01 (up to one year) Example: 2026-07-01
`pageType`	`integer`	optional	Billboard type: 2 = weekly, 3 = monthly. Default 3 Example: 3
`pageIndex`	`integer`	optional	Page number (starting from 1), default 1 Example: 1
`pageSize`	`integer`	optional	Number of results per page (10-100), default 20 Example: 10
`sortField`	`string`	optional	Sort field, default orderCount. Options: orderCount (order count), saleCount (units sold), saleVolume (estimated sales amount), offerCreateTime (listing time), price (wholesale price), consignPrice (dropship price)
`sortType`	`string`	optional	Sort order: desc (descending), asc (ascending), default desc
`searchType`	`integer`	optional	Product keyword search type: 1 = fuzzy match, 3 = exact match. Default 1 Example: 1
`offerType`	`integer`	optional	Product tag: 0 = no limit, 2 = new product, 3 = 1688 Select, 4 = cross-border, 5 = customization supported, 6 = store highlight. Default 0 Example: 1
`companyType`	`integer`	optional	Company type: 0 = no limit, 1 = store, 2 = factory Example: 1
`shiLiType`	`string`	optional	Seller membership type (multi-select), comma-separated. Options: superFactory (Super Factory), Power (Power Seller), TrustPass (TrustPass member only)
`beginTpYear`	`integer`	optional	Start TrustPass years Example: 1
`endTpYear`	`integer`	optional	End TrustPass years Example: 1
`beginPrice`	`number`	optional	Wholesale price (start) Example: 1
`endPrice`	`number`	optional	Wholesale price (end) Example: 1
`beginConsignPrice`	`number`	optional	Dropship price (start) Example: 1
`endConsignPrice`	`number`	optional	Dropship price (end) Example: 1
`beginOrderCount`	`integer`	optional	Order count (start) Example: 1
`endOrderCount`	`integer`	optional	Order count (end) Example: 1
`beginSaleCount`	`integer`	optional	Units sold (start) Example: 1
`endSaleCount`	`integer`	optional	Units sold (end) Example: 1
`beginSaleVolume`	`number`	optional	Sales amount (start) Example: 1
`endSaleVolume`	`number`	optional	Sales amount (end) Example: 1
`beginStartQuantity`	`integer`	optional	Minimum order quantity (start) Example: 1
`endStartQuantity`	`integer`	optional	Minimum order quantity (end) Example: 1
`beginOfferCreateTime`	`string`	optional	Listing time (start), format: YYYY-MM-DD
`endOfferCreateTime`	`string`	optional	Listing time (end), format: YYYY-MM-DD
`sendTime`	`string`	optional	Delivery time (multi-select), comma-separated. Options: 24 (24 hours), 48 (48 hours), 72 (72 hours)
`proxyRights`	`string`	optional	Dropship rights (multi-select), comma-separated. Options: 4360897 (one-piece dropship with free shipping), 449154 (procure now, pay later)
`shopService`	`string`	optional	Seller services (multi-select), comma-separated. Options: 4057409 (Safe Buy), 888777 (Deep Verification Report)
`buyerProtections`	`string`	optional	Buyer protections, comma-separated: free shipping, 7-day free return, or shipping insurance
`faceToFaceSupport`	`string`	optional	Waybill support (multi-select), comma-separated. Options: 441218 (Taobao), 386434 (Douyin), 422914 (Pinduoduo), 422978 (Xiaohongshu), 386370 (Kuaishou)
`productIds`	`string`	optional	Product IDs, separated by Chinese comma for multiple, max 20
`goodsUrl`	`string`	optional	Product link URL Example: https://example.com/image.jpg

Request example

{
  "pageType": 3,
  "searchType": 1,
  "pageIndex": 1,
  "keyWord": "iPhone 15",
  "date": "2026-07-01",
  "pageSize": 10
}

Response body

Name	Type	Required	Description
`data`	`any`	required	Data value used by this API operation.
`code`	`integer`	required	0 means accepted or successful; nonzero is a platform error.
`msg`	`string \| null`	required	Msg value used by this API operation.
`ts`	`string`	required	Epoch milliseconds.
`time`	`string`	required	Server local time: yyyy-MM-dd HH:mm:ss.
`cost`	`string`	required	Elapsed milliseconds, never credits; -1 outside web requests.
`traceId`	`string \| null`	required	Trace id value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data`	`object`	required	Data value used by this API operation.
`data.total`	`integer`	optional	Total record count Example: 1
`data.type`	`string`	optional	Render style Example: null
`data.columns`	`array`	optional	Render columns Example: []
`data.products`	`array`	optional	Product list (see Product Object below) Example: []
`data.products[].offerId`	`string`	optional	Product ID Example: example-id
`data.products[].asin`	`string`	optional	Product number Example: B072MQ5BRX
`data.products[].title`	`string`	optional	Product title Example: null
`data.products[].price`	`number`	optional	Wholesale price Example: 1
`data.products[].consignPrice`	`number`	optional	Dropship price Example: 1
`data.products[].currency`	`string`	optional	Currency Example: null
`data.products[].unit`	`string`	optional	Unit Example: null
`data.products[].quantityBegin`	`integer`	optional	Minimum order quantity Example: 1
`data.products[].quantityPrices`	`string`	optional	Price range Example: null
`data.products[].salesOrderCount`	`integer`	optional	Order count (returns corresponding value based on statistical period) Example: 1
`data.products[].salesQuantity`	`integer`	optional	Units sold (returns corresponding value based on statistical period) Example: 1
`data.products[].estimatedSalesAmount`	`integer`	optional	Estimated sales amount (returns corresponding value based on statistical period) Example: 1
`data.products[].dataType`	`string`	optional	Data type: weeklyData = weekly data, monthlyData = monthly data Example: null
`data.products[].availableDate`	`string`	optional	Product listing time, format yyyy-MM-dd HH:mm:ss Example: 2026-01-01
`data.products[].deliveryTime`	`string`	optional	Delivery time Example: null
`data.products[].levelName`	`string`	optional	Category hierarchy name Example: null
`data.products[].company`	`string`	optional	Store name Example: null
`data.products[].shopId`	`string`	optional	Store ID Example: example-id
`data.products[].shopUrl`	`string`	optional	Store link URL Example: https://example.com/image.jpg
`data.products[].asinUrl`	`string`	optional	Product link URL Example: B072MQ5BRX
`data.products[].imageUrl`	`string`	optional	Image URL Example: https://example.com/image.jpg
`data.products[].sourceType`	`string`	optional	Source platform (1688) Example: null
`data.products[].sourceTool`	`string`	optional	Source tool Example: null
`data.title`	`string`	optional	Provider-specific response title. Example: null
`data.sourceType`	`string`	optional	Provider-specific source platform type. Example: null
`data.sourceTool`	`string`	optional	Provider-specific source tool name. Example: null
`data.costToken`	`integer`	optional	Token cost reported by the upstream provider. Example: null
`data.costTime`	`integer`	optional	Execution time reported by the upstream provider. Example: null
`data.page`	`integer`	optional	Current page returned by the upstream provider. Example: null
`data.pageSize`	`integer`	optional	Page size returned by the upstream provider. Example: null
`data.pageItemCount`	`integer`	optional	Item count on the current page returned by the upstream provider. Example: null
`data.totalPage`	`integer`	optional	Total page count returned by the upstream provider. Example: null
`data.dataSnapshotMonth`	`string`	optional	Data snapshot month returned by the upstream provider. Example: null

Any of option 2

Name	Type	Required	Description
`data`	`null`	required	Data value used by this API operation.

Response example

Platform response envelope. code 0 indicates success or acceptance; data contains the business result.

{
  "data": {
    "total": 1,
    "columns": [],
    "products": [
      {
        "offerId": "example-id",
        "asin": "B072MQ5BRX",
        "price": 1,
        "consignPrice": 1,
        "quantityBegin": 1,
        "salesOrderCount": 1,
        "salesQuantity": 1,
        "estimatedSalesAmount": 1,
        "availableDate": "2026-01-01",
        "shopId": "example-id",
        "shopUrl": "https://example.com/image.jpg",
        "asinUrl": "B072MQ5BRX",
        "imageUrl": "https://example.com/image.jpg"
      }
    ]
  },
  "code": 0,
  "msg": null,
  "ts": "0",
  "time": "2026-01-01 00:00:00",
  "cost": "-1",
  "traceId": null
}

Responses

Code	Description
200	HTTP request completed. Check JSON code; only 0 indicates business success or acceptance.
400	Request JSON or required API parameters are invalid.
401	API key is missing, invalid, or cannot be matched to a user.
5xx	API execution or upstream service failed.

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.

Related APIs

1688 Product Detail API

Retrieve public 1688 product, SKU, pricing, logistics, and supplier details while preserving long offer identifiers as exact strings.

1688 Product Search API

Search 1688 wholesale products for sourcing, supplier discovery, and product selection across Alibaba’s domestic B2B marketplace.

1688 Search By Image API

Find visually similar 1688 supplier products from an image URL, including price, minimum order quantity, sales, supplier, and trade data.

MCP

V2 recommended

Connect remote agents through the standard MCP 2025-11-25 Streamable HTTP endpoint. Use OAuth 2.1 Authorization Code with PKCE, or an API key for compatibility.

POST https://api.nexscope.ai/api/skill-api/v2/mcp
MCP-Protocol-Version: 2025-11-25
Content-Type: application/json

Authentication

OAuth clients request the mcp:tools scope. The endpoint's 401 response advertises protected-resource metadata for authorization discovery.

Call a tool

{
  "jsonrpc": "2.0",
  "id": "tool-call-1",
  "method": "tools/call",
  "params": {
    "name": "nexscope_1688_product_billboard",
    "arguments": {
      "pageType": 3,
      "searchType": 1,
      "pageIndex": 1,
      "keyWord": "iPhone 15",
      "date": "2026-07-01",
      "pageSize": 10
    }
  }
}

Legacy MCP v1

Existing API-key clients can continue using the compatibility endpoint. New integrations should use MCP v2.

GET / POST /api/skill-api/v1/mcp

Online test

Execute the current API with your API key and JSON payload.

12 credits / callAPI usage records

Try it

Send a real request with the same contract shown in the reference.

Endpoint

https://api.nexscope.ai/api/skill-api/v1/skills/1688-product-billboard/run

MCP method

nexscope_1688_product_billboard

API key*

JSON payload*

cURL

curl -X POST \
  https://api.nexscope.ai/api/skill-api/v1/skills/1688-product-billboard/run \
  -H "Authorization: Bearer nk-..." \
  -H "Content-Type: application/json" \
  -d '{ "pageType": 3, "searchType": 1, "pageIndex": 1, "keyWord": "iPhone 15", "date": "2026-07-01", "pageSize": 10 }'

Response

No response yet. Run the request to see the response here.