https://claw-callback.nexscope.ai/api/skill-api/v1/skills/tiktok-product-search/runRun this API
Send a JSON request to execute this API and receive the direct response payload.
Endpoint
| Method | POST |
| Path | https://claw-callback.nexscope.ai/api/skill-api/v1/skills/tiktok-product-search/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
keyword | string | optional | Product keyword (please translate to the local language). Max length 1000 Example: phone case |
region | string | optional | Region, default US. Options: US (United States), ID (Indonesia), TH (Thailand), PH (Philippines), MY (Malaysia), VN (Vietnam), GB (United Kingdom), MX (Mexico), SG (Singapore), SA (Saudi Arabia), BR (Brazil), ES (Spain), JP (Japan), DE (Germany), IT (Italy), FR (France) Example: US |
categoryKeywordCN | string | optional | Product category (please enter in Chinese). Max length 1000 Example: phone case |
minTotalSaleCnt | integer | optional | Total sales (minimum) Example: 1 |
maxTotalSaleCnt | integer | optional | Total sales (maximum) Example: 1 |
minTotalSale30dCnt | integer | optional | 30-day sales (minimum) Example: 1 |
maxTotalSale30dCnt | integer | optional | 30-day sales (maximum) Example: 1 |
minTotalSaleGmvAmt | string | optional | Product total GMV (minimum). Max length 1000 |
maxTotalSaleGmvAmt | string | optional | Product total GMV (maximum). Max length 1000 |
minTotalSaleGmv30dAmt | string | optional | Product total GMV (30-day) (minimum). Max length 1000 |
maxTotalSaleGmv30dAmt | string | optional | Product total GMV (30-day) (maximum). Max length 1000 |
minSpuAvgPrice | number | optional | SPU average price (minimum) Example: 1 |
maxSpuAvgPrice | number | optional | SPU average price (maximum) Example: 1 |
minProductRating | number | optional | Product rating (minimum) Example: 1 |
maxProductRating | number | optional | Product rating (maximum) Example: 1 |
minReviewCount | integer | optional | Review count (minimum) Example: 1 |
maxReviewCount | integer | optional | Review count (maximum) Example: 1 |
minProductCommissionRate | number | optional | Product commission rate (minimum). Input as percentage will be automatically converted to decimal, e.g., 5%->0.05 Example: 1 |
maxProductCommissionRate | number | optional | Product commission rate (maximum). Input as percentage will be automatically converted to decimal, e.g., 5%->0.05 Example: 1 |
minTotalIflCnt | integer | optional | Promoting creator count (minimum) Example: 1 |
maxTotalIflCnt | integer | optional | Promoting creator count (maximum) Example: 1 |
minTotalVideoCnt | integer | optional | Promotional video count (minimum) Example: 1 |
maxTotalVideoCnt | integer | optional | Promotional video count (maximum) Example: 1 |
minTotalViewsCnt | integer | optional | Promotional view count (minimum) Example: 1 |
maxTotalViewsCnt | integer | optional | Promotional view count (maximum) Example: 1 |
minFirstCrawlDt | integer | optional | Product listing time (minimum), format YYYYMMDD (e.g., 20200101 represents 2020-01-01) Example: 1 |
maxFirstCrawlDt | integer | optional | Product listing time (maximum), format YYYYMMDD Example: 1 |
saleDays | integer | optional | Days the product has been on sale, unit is days Example: 1 |
productSortField | integer | optional | Sort field: 1=total sales, 2=total GMV, 3=SPU average price, 4=7-day sales, 5=30-day sales, 6=7-day GMV, 7=30-day GMV. Default 1 Example: 1 |
sortType | integer | optional | Sort direction: 0=ascending, 1=descending. Default 1 Example: 1 |
pageNum | integer | optional | Page number. Default 1 Example: 1 |
pageSize | integer | optional | Items per page. Default 50 Example: 10 |
Request example
{
"region": "US",
"pageSize": 10,
"keyword": "phone case",
"pageNumber": 1
}Response body
Returns the documented upstream API response directly without an additional wrapper.
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | optional | Record count Example: 1 |
products | array | optional | Product information list (see below) Example: [] |
columns | array | optional | Rendered columns Example: [] |
type | string | optional | Render style |
costToken | integer | optional | Token cost Example: 1 |
products[].productId | string | optional | Product unique identifier ID Example: example-id |
products[].productName | string | optional | Product name |
products[].title | string | optional | Product name |
products[].imageUrl | string | optional | Product image URL Example: https://example.com/image.jpg |
products[].coverUrl | string | optional | Cover image URL list Example: https://example.com/image.jpg |
products[].productImageUrls | array | optional | Product image URL list Example: [] |
products[].categoryName | string | optional | Product category name |
products[].categoryIds | array | optional | Product category ID list Example: [] |
products[].region | string | optional | Region code Example: US |
products[].currency | string | optional | Currency |
products[].price | number | optional | Product price Example: 1 |
products[].minPrice | number | optional | Minimum price Example: 1 |
products[].maxPrice | number | optional | Maximum price Example: 1 |
products[].spuAvgPrice | number | optional | SPU average price Example: 1 |
products[].productRating | number | optional | Product rating Example: 1 |
products[].reviewCount | integer | optional | Review count Example: 1 |
products[].ratings | integer | optional | Review count Example: 1 |
products[].productCommissionRate | number | optional | Product commission rate Example: 1 |
products[].totalSaleCnt | integer | optional | Total sales Example: 1 |
products[].totalSale1dCnt | integer | optional | Total sales in 1 day Example: 1 |
products[].totalSale7dCnt | integer | optional | Total sales in 7 days Example: 1 |
products[].totalSale15dCnt | integer | optional | Total sales in 15 days Example: 1 |
products[].totalSale30dCnt | integer | optional | Total sales in 30 days Example: 1 |
products[].totalSale60dCnt | integer | optional | Total sales in 60 days Example: 1 |
products[].totalSale90dCnt | integer | optional | Total sales in 90 days Example: 1 |
products[].monthlySalesUnits | integer | optional | Monthly sales Example: 1 |
products[].totalSaleGmvAmt | number | optional | Total GMV Example: 1 |
products[].totalSaleGmv1dAmt | number | optional | Total GMV in 1 day Example: 1 |
products[].totalSaleGmv7dAmt | number | optional | Total GMV in 7 days Example: 1 |
products[].totalSaleGmv15dAmt | number | optional | Total GMV in 15 days Example: 1 |
products[].totalSaleGmv30dAmt | number | optional | Total GMV in 30 days Example: 1 |
products[].totalSaleGmv60dAmt | number | optional | Total GMV in 60 days Example: 1 |
products[].totalSaleGmv90dAmt | number | optional | Total GMV in 90 days Example: 1 |
products[].firstCrawlDt | integer | optional | Listing date Example: 1 |
products[].availableDate | string | optional | Listing time (timestamp) Example: 2026-01-01 |
products[].discount | string | optional | Discount info |
products[].freeShippingText | string | optional | Whether free shipping |
products[].offMarkText | string | optional | Whether there is a discount mark |
products[].salesFlagText | string | optional | Selling method |
products[].salesTrendFlagText | string | optional | Sales trend indicator |
products[].isSShopText | string | optional | Whether S store |
products[].salePropsInfo | array | optional | Sales property info (product specifications) Example: [] |
products[].sourceTool | string | optional | Source tool |
products[].sourceType | string | optional | Product source |
products[].asin | string | optional | Product ID Example: B072MQ5BRX |
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. |
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,
"products": [
{
"productId": "example-id",
"imageUrl": "https://example.com/image.jpg",
"coverUrl": "https://example.com/image.jpg",
"productImageUrls": [],
"categoryIds": [],
"region": "US",
"price": 1,
"minPrice": 1,
"maxPrice": 1,
"spuAvgPrice": 1,
"productRating": 1,
"reviewCount": 1,
"ratings": 1,
"productCommissionRate": 1,
"totalSaleCnt": 1,
"totalSale1dCnt": 1,
"totalSale7dCnt": 1,
"totalSale15dCnt": 1,
"totalSale30dCnt": 1,
"totalSale60dCnt": 1,
"totalSale90dCnt": 1,
"monthlySalesUnits": 1,
"totalSaleGmvAmt": 1,
"totalSaleGmv1dAmt": 1,
"totalSaleGmv7dAmt": 1,
"totalSaleGmv15dAmt": 1,
"totalSaleGmv30dAmt": 1,
"totalSaleGmv60dAmt": 1,
"totalSaleGmv90dAmt": 1,
"firstCrawlDt": 1,
"availableDate": "2026-01-01",
"salePropsInfo": [],
"asin": "B072MQ5BRX"
}
],
"columns": [],
"costToken": 1
}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.