1688 Product Billboard API

REST API and MCP service documentation generated from server-side API definitions. Responses shown here are the direct payload returned by each API execution.

API selector

1688 Sourcing

API overview

Query 1688 product bestseller billboard data for sourcing discovery and wholesale product research.

Try this API

Endpoint

https://claw-callback.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://claw-callback.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	Direct API response payload. No data/result wrapper is added.

Status codes

Code	Description
200	API executed successfully. Body is the direct response payload.
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 '{   "date": "2026-07-01",   "keyWord": "手机壳",   "pageIndex": 1,   "searchType": 1,   "pageType": 3,   "pageSize": 10 }'

All categories/ 1688 Sourcing

POSThttps://claw-callback.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 direct response payload.

Open tester

Endpoint

Method	`POST`
Path	`https://claw-callback.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 (search keyword must be in Chinese; if not, translate it first), max length 50 Example: 手机壳
`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 (multi-select), comma-separated. Options: 商品包邮 (free shipping), 7天包退货 (7-day free return), 支持运费险 (shipping insurance supported)
`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

{
  "date": "2026-07-01",
  "keyWord": "手机壳",
  "pageIndex": 1,
  "searchType": 1,
  "pageType": 3,
  "pageSize": 10
}

Response body

Returns the documented upstream API response directly without an additional wrapper.

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

Response example

Direct response payload. No extra wrapper is added.

{
  "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"
    }
  ]
}

Responses

Code	Description
200	API executed successfully. Body is the direct response payload.
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 Search

Search and analyze products on the Chinese 1688 wholesale platform (Alibaba domestic B2B market) for sourcing, supplier discovery, and product selection.

1688 Search By Image

Perform image-based product search on the 1688 platform. Use an image URL to find visually similar supplier products, returning title, price, minimum order quantity, monthly sales, repurchase rate, trade score, and seller identity.

MCP

Use the MCP endpoint when an agent needs to discover and call API tools with JSON-RPC.

GET /api/skill-api/v1/mcp

POST /api/skill-api/v1/mcp
Authorization: Bearer nk_xxxxxxxxxxxxxxxxx
Content-Type: application/json

Call a tool

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

Online test

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

Try it

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

Endpoint

https://claw-callback.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://claw-callback.nexscope.ai/api/skill-api/v1/skills/1688-product-billboard/run \
  -H "Authorization: Bearer nk-..." \
  -H "Content-Type: application/json" \
  -d '{ "date": "2026-07-01", "keyWord": "手机壳", "pageIndex": 1, "searchType": 1, "pageType": 3, "pageSize": 10 }'

Response

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