TikTok Livestream Details

Retrieve a TikTok livestream by ID to review available sales and performance information for your chosen region and date range.

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

Try online

POST · https://api.nexscope.ai/kd/livestream/detailMCP · nexscope_data_kd_livestream_detail

What this API does

Retrieve a TikTok livestream by ID to review available sales and performance information for your chosen region and date range. The request accepts livestreamId, region, dateRange, language, currency. Its documented result includes errcode, errmsg, livestream_id, livestream_title, creator_id, creator_handle, livestream_start_time, livestream_end_time.

TikTok Livestream Details API use cases

Shortlist commerce content partners

To shortlist commerce content partners, a marketplace analyst submits livestreamId and region to TikTok Livestream Details. The returned errcode, errmsg, livestream_id help identify potential partners for a commerce campaign.

Review public creator or livestream evidence

A marketplace analyst uses TikTok Livestream Details with livestreamId and region to review public creator or livestream evidence. The returned errcode, errmsg, livestream_id help compare public content evidence for shortlisted partners.

Prepare a campaign research brief

For this workflow, a marketplace analyst calls TikTok Livestream Details with livestreamId and region to prepare a campaign research brief. The result helps select creators or livestreams for a campaign briefing.

TikTok Livestream Details API FAQ

What does the TikTok Livestream Details API return?

Retrieve a TikTok livestream by ID to review available sales and performance information for your chosen region and date range. The documented output includes errcode, errmsg, livestream_id, livestream_title, creator_id, creator_handle, livestream_start_time, livestream_end_time. It corresponds to the supplied livestreamId, region, dateRange, language, currency. 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 Livestream Details 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 Livestream Details API from my app or an MCP client?

Send a POST request to https://api.nexscope.ai/kd/livestream/detail 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_detail. Use the MCP arguments shown in the MCP guide, or switch Online test to MCP to review its 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/detail

MCP method

nexscope_data_kd_livestream_detail

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

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/detail' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "currency": "USD",
  "dateRange": "last7Day",
  "livestreamId": "7661409374878878494",
  "region": "US"
}'

Code example

{
  "currency": "USD",
  "dateRange": "last7Day",
  "livestreamId": "7661409374878878494",
  "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	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.

View parameters & response Try online

All categories/ TikTok Intelligence KD

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

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

Request parameters

Name	Type	Required	Description
`livestreamId`	`string`	required	Target live broadcast unique ID, such as `7661409374878878494`, usually `livestream_id` from the list; maximum length 1000
`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
`language`	`string`	optional	Return language, for example `zh-CN`, `en-US`
`currency`	`string`	optional	Currency unit, such as `USD`

Response example

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

No response example is published for this API. Refer to the response fields below.

Response fields

Response field reference (16 fields)

Name	Type	Required	Description
`errcode`	`integer`	optional	Business status code, `200` indicates success
`data`	`array`	optional	Live broadcast details data, always an array of 1 element when successful
`costToken`	`integer`	optional	The deduction token for this call is fixed to `14000`
`errmsg`	`string`	optional	Status message, `ok` on success
`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	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.

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_detail",
    "arguments": {
      "currency": "USD",
      "dateRange": "last7Day",
      "livestreamId": "7661409374878878494",
      "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.

Recent Avg. 22 · Range 11–22 credits / callAPI usage records

Try it

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

Endpoint

/kd/livestream/detail

MCP method

nexscope_data_kd_livestream_detail

API key*

JSON payload*

cURL

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

Response

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

Related APIs

TikTok Shop Tik Tok Shop Rankings

Rank TikTok shops for a selected region and date range to compare available performance and discover shops worth researching.

TikTok Shop Tik Tok Video Rankings

Rank TikTok videos by available performance measures to identify content worth reviewing for product and creator research.

TikTok Creator Analytics

Compare TikTok creators by followers, sales revenue, and region.

TikTok Creator Rankings

Query TikTok creator rankings by region and date range.