TikTok Intelligence KD: livestream/rank API

Use TikTok Intelligence KD: livestream/rank API through Nexscope with documented parameters, structured results and API key authentication.

CostRecent Avg. 22 · Range 11–22 credits / call

Try online

POST · https://api.nexscope.ai/kd/livestream/rankMCP · nexscope_data_kd_livestream_rank

TikTok Intelligence KD

What this API does

Use TikTok Intelligence KD: livestream/rank API through Nexscope with documented parameters, structured results and API key authentication. The request accepts region, dateRange, pageNumber, pageSize, language. Its documented result includes errcode, errmsg, livestream_start_time, livestream_end_time, livestream_duration, livestream_title, livestream_id, creator_id.

TikTok Intelligence KD: livestream/rank API API use cases

Shortlist a market segment

To shortlist a market segment, a marketplace analyst submits region and dateRange to TikTok Intelligence KD: livestream/rank API. The returned errcode, errmsg, livestream_start_time help identify categories or products worth further market research.

Compare ranked products or categories

A marketplace analyst uses TikTok Intelligence KD: livestream/rank API with region and dateRange to compare ranked products or categories. The returned errcode, errmsg, livestream_start_time help compare candidates within the requested ranking scope.

Investigate candidates before sourcing

For this workflow, a marketplace analyst calls TikTok Intelligence KD: livestream/rank API with region and dateRange to investigate candidates before sourcing. The result helps choose products to investigate before contacting suppliers.

TikTok Intelligence KD: livestream/rank API API FAQ

What does the TikTok Intelligence KD: livestream/rank API API return?

Use TikTok Intelligence KD: livestream/rank API through Nexscope with documented parameters, structured results and API key authentication. The documented output includes errcode, errmsg, livestream_start_time, livestream_end_time, livestream_duration, livestream_title, livestream_id, creator_id. It corresponds to the supplied region, dateRange, pageNumber, pageSize, language. Optional fields can be absent; a missing value should not be interpreted as a measured zero. Example values illustrate the response shape, rather than live account results.

How many credits does the TikTok Intelligence KD: livestream/rank API API cost?

The current documented cost is Recent Avg. 22 · Range 11–22 credits / call. This is the same cost shown at the top of this page. If a range or estimate is displayed, the final charge depends on the request. Review your available credits and the pricing page before calling the API, and check API usage records for the actual charge.

How do I call the TikTok Intelligence KD: livestream/rank API API from my app or an MCP client?

Send a POST request to https://api.nexscope.ai/kd/livestream/rank with your API key as a Bearer token and the JSON inputs shown in API integration. In a compatible MCP client such as Claude or Cursor, connect Nexscope and call nexscope_data_kd_livestream_rank. The same documented request parameters apply; use Online test to review a request before adding it to your app.

View plans and credits Connect this API with MCP

Try this API

Endpoint

https://api.nexscope.ai/kd/livestream/rank

MCP method

nexscope_data_kd_livestream_rank

Step 1 of 3 · Authenticate

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 .

Step 2 of 3 · Send a request

POSThttps://api.nexscope.ai/kd/livestream/rank

Run an API

Send a JSON request body using the parameters described below.

Example request

Replace YOUR_API_KEY, then run this command in your terminal.

curl -X POST 'https://api.nexscope.ai/kd/livestream/rank' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "currency": "USD",
  "dateRange": "last7Day",
  "pageNumber": 1,
  "pageSize": 5,
  "region": "US"
}'

Step 3 of 3 · Inspect the result

Check the response

Read code for the request status and data for the result. Open the parameter and response reference for the full field definitions.

HTTP 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.

View parameters & response Try online

All categories/ TikTok Intelligence KD

POSThttps://api.nexscope.ai/kd/livestream/rank

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/kd/livestream/rank`
Auth	`Bearer API key`
Content-Type	`application/json`

Request parameters

Name	Type	Required	Description
`region`	`string`	optional	Region/market code, such as `US`; maximum length 1000
`dateRange`	`string`	optional	Time range, such as `last7Day` (last 7 days), `last30Day` (last 30 days); maximum length 1000
`pageNumber`	`integer`	optional	Page number, value 1-5; out of range returns `errcode 501`
`pageSize`	`integer`	optional	Quantity per page, value 5-100
`language`	`string`	optional	Return language, for example `zh-CN`, `en-US`
`currency`	`string`	optional	Currency unit, such as `USD`
`category_id`	`string`	optional	Category ID filter
`shop_id`	`string`	optional	Store ID filter
`creator_id`	`string`	optional	Expert ID filtering
`product_id`	`string`	optional	Product ID filter
`followers_range`	`string`	optional	Filter by number of fans
`sortField`	`object`	optional	Sorting conditions, the structure is defined by the gateway; when not sorting, pass an empty object `{}`
`livestreamId`	`string`	required	Live broadcast unique ID, such as `7661409374878878494`, usually `livestream_id` from the list; maximum length 1000

Code example

{
  "currency": "USD",
  "dateRange": "last7Day",
  "pageNumber": 1,
  "pageSize": 5,
  "region": "US"
}

Response example

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

{
  "code": 0,
  "cost": "-1",
  "data": {},
  "msg": null,
  "time": "2026-01-01 00:00:00",
  "traceId": null,
  "ts": "0"
}

Response fields

Response field reference (27 fields)

Name	Type	Required	Description
`errcode`	`integer`	optional	Business status code, `200` indicates success
`data`	`array`	optional	Live broadcast list or live broadcast details
`costToken`	`integer`	optional	The deduction token for this call is fixed to `14000`
`errmsg`	`string`	optional	Status message, `ok` on success
`livestream_start_time`	`integer`	optional	Live broadcast start time (epoch milliseconds)
`livestream_end_time`	`integer`	optional	Live broadcast end time (epoch milliseconds)
`livestream_duration`	`integer`	optional	Live broadcast duration (seconds)
`livestream_title`	`string`	optional	Live title
`livestream_id`	`string`	optional	The unique ID of the live broadcast (a string to avoid the loss of large integer precision), which can be used as the `livestreamId` of the details interface
`creator_id`	`string`	optional	The unique ID of the expert (string, to avoid loss of large integer precision)
`creator_handle`	`string`	optional	Expert account handle
`revenue`	`string`	optional	Total sales/GMV, returned by requested `currency`; returned as a string, such as `"185590.52"`
`unit_price`	`string`	optional	The unit price of the piece is returned according to the requested `currency`; the return is a string, such as `"265.89"`
`views`	`integer`	optional	Number of views
`record_type`	`string`	optional	Record type, such as `SHORT`
`livestream_id`	`string`	optional	Live broadcast unique ID, consistent with the requested `livestreamId`
`livestream_title`	`string`	optional	Live title, such as `24 HOUR STREAM`
`creator_id`	`string`	optional	The unique ID of the expert (string, to avoid loss of large integer precision)
`creator_handle`	`string`	optional	Expert username/handle, such as `pokepiglt`
`livestream_start_time`	`integer`	optional	Live broadcast start time, epoch milliseconds
`livestream_end_time`	`integer`	optional	Live broadcast end time, epoch milliseconds
`livestream_duration`	`integer`	optional	Live broadcast duration, unit seconds
`record_type`	`string`	optional	Record type, such as `SHORT`
`viewers`	`integer`	optional	Number of viewers; use `viewers` for details and `views` for lists
`revenue`	`number`	optional	Live sales/GMV, returned by requested `currency`; details are of type numeric
`gpm`	`number`	optional	GMV per mille, GMV per thousand impressions; details exclusive
`product_number`	`integer`	optional	Number of goods delivered live

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.

Step 1 of 2 · Connect your MCP client

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/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.

Step 2 of 2 · Call the tool

Call a tool

{
  "jsonrpc": "2.0",
  "id": "tool-call-1",
  "method": "tools/call",
  "params": {
    "name": "nexscope_data_kd_livestream_rank",
    "arguments": {
      "currency": "USD",
      "dateRange": "last7Day",
      "pageNumber": 1,
      "pageSize": 5,
      "region": "US"
    }
  }
}

Legacy MCP v1

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

GET / POST /mcp/legacy

Online test

Execute the current API with your API key and JSON payload. Online tests use this site's configured API environment; the Endpoint and copyable examples use the public integration address.

15 credits / callAPI usage records

Try it

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

Endpoint

/kd/livestream/rank

MCP method

nexscope_data_kd_livestream_rank

API key*

JSON payload*

cURL

curl -X POST \
  https://api.nexscope.ai/kd/livestream/rank \
  -H "Authorization: Bearer nk-..." \
  -H "Content-Type: application/json" \
  -d '{ "currency": "USD", "dateRange": "last7Day", "pageNumber": 1, "pageSize": 5, "region": "US" }'

Response

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

Use TikTok Intelligence KD: creator/detail API through Nexscope with documented parameters, structured results and API key authentication.

TikTok Intelligence KD: creator/rank API

Use TikTok Intelligence KD: creator/rank API through Nexscope with documented parameters, structured results and API key authentication.

TikTok Intelligence KD: livestream/detail API

Use TikTok Intelligence KD: livestream/detail API through Nexscope with documented parameters, structured results and API key authentication.

TikTok Intelligence KD: product/detail API

Use TikTok Intelligence KD: product/detail API through Nexscope with documented parameters, structured results and API key authentication.

What this API does

TikTok Intelligence KD: livestream/rank API API use cases

Shortlist a market segment

Compare ranked products or categories

Investigate candidates before sourcing

TikTok Intelligence KD: livestream/rank API API FAQ

What does the TikTok Intelligence KD: livestream/rank API API return?

How many credits does the TikTok Intelligence KD: livestream/rank API API cost?

How do I call the TikTok Intelligence KD: livestream/rank API API from my app or an MCP client?

Authentication

Run an API

Example request

Check the response

HTTP status codes

Run this API

Endpoint

Request parameters

Code example

Response example

Response fields

Responses

Data source, freshness, and limitations

MCP

Call a tool

Legacy MCP v1

Online test

Try it

Related APIs