Nexscope

TikTok Livestream Analytics

Compare TikTok shopping livestreams by sales revenue, viewers, and products sold. Call via REST API or MCP with your Nexscope API key.

CostRecent Avg. 22 · Range 11–22 credits / call
Try online
POST · https://api.nexscope.ai/kd/livestream/rankMCP · nexscope_tiktok_livestream_analytics

What this API does

Compare TikTok shopping livestreams by sales revenue, viewers, and products sold. 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 Livestream Analytics API use cases

Shortlist commerce content partners

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

Review public creator or livestream evidence

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

Prepare a campaign research brief

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

TikTok Livestream Analytics API FAQ

What does the TikTok Livestream Analytics API return?

Compare TikTok shopping livestreams by sales revenue, viewers, and products sold. 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 Livestream Analytics 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 Analytics 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_tiktok_livestream_analytics. 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 creditsConnect this API with MCP

Try this API
Endpoint
https://api.nexscope.ai/kd/livestream/rank
MCP method
nexscope_tiktok_livestream_analytics

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"
}'

Code example

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

CodeDescription
200Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result.
429Execution admission rate limit; honor Retry-After when present.
503Execution admission is temporarily unavailable; honor Retry-After when present.
Opt-inX-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing or invalid API key (code 11209, including an incomplete or corrupted copy) or an expired website login session (code 12001), 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.
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.

Endpoint

MethodPOST
Pathhttps://api.nexscope.ai/kd/livestream/rank
AuthBearer API key
Content-Typeapplication/json

Request parameters

NameTypeRequiredDescription
regionstringoptional
Region/market code, such as `US`; maximum length 1000
dateRangestringoptional
Time range, such as `last7Day` (last 7 days), `last30Day` (last 30 days); maximum length 1000
pageNumberintegeroptional
Page number, value 1-5; out of range returns `errcode 501`
pageSizeintegeroptional
Quantity per page, value 5-100
languagestringoptional
Return language, for example `zh-CN`, `en-US`
currencystringoptional
Currency unit, such as `USD`
category_idstringoptional
Category ID filter
shop_idstringoptional
Store ID filter
creator_idstringoptional
Expert ID filtering
product_idstringoptional
Product ID filter
followers_rangestringoptional
Filter by number of fans
sortFieldobjectoptional
Sorting conditions, the structure is defined by the gateway; when not sorting, pass an empty object `{}`
livestreamIdstringrequired
Live broadcast unique ID, such as `7661409374878878494`, usually `livestream_id` from the list; maximum length 1000

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 (27 fields)

NameTypeRequiredDescription
errcodeintegeroptional
Business status code, `200` indicates success
dataarrayoptional
Live broadcast list or live broadcast details
costTokenintegeroptional
The deduction token for this call is fixed to `14000`
errmsgstringoptional
Status message, `ok` on success
livestream_start_timeintegeroptional
Live broadcast start time (epoch milliseconds)
livestream_end_timeintegeroptional
Live broadcast end time (epoch milliseconds)
livestream_durationintegeroptional
Live broadcast duration (seconds)
livestream_titlestringoptional
Live title
livestream_idstringoptional
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_idstringoptional
The unique ID of the expert (string, to avoid loss of large integer precision)
creator_handlestringoptional
Expert account handle
revenuestringoptional
Total sales/GMV, returned by requested `currency`; returned as a string, such as `"185590.52"`
unit_pricestringoptional
The unit price of the piece is returned according to the requested `currency`; the return is a string, such as `"265.89"`
viewsintegeroptional
Number of views
record_typestringoptional
Record type, such as `SHORT`
livestream_idstringoptional
Live broadcast unique ID, consistent with the requested `livestreamId`
livestream_titlestringoptional
Live title, such as `24 HOUR STREAM`
creator_idstringoptional
The unique ID of the expert (string, to avoid loss of large integer precision)
creator_handlestringoptional
Expert username/handle, such as `pokepiglt`
livestream_start_timeintegeroptional
Live broadcast start time, epoch milliseconds
livestream_end_timeintegeroptional
Live broadcast end time, epoch milliseconds
livestream_durationintegeroptional
Live broadcast duration, unit seconds
record_typestringoptional
Record type, such as `SHORT`
viewersintegeroptional
Number of viewers; use `viewers` for details and `views` for lists
revenuenumberoptional
Live sales/GMV, returned by requested `currency`; details are of type numeric
gpmnumberoptional
GMV per mille, GMV per thousand impressions; details exclusive
product_numberintegeroptional
Number of goods delivered live

Responses

CodeDescription
200Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result.
429Execution admission rate limit; honor Retry-After when present.
503Execution admission is temporarily unavailable; honor Retry-After when present.
Opt-inX-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing or invalid API key (code 11209, including an incomplete or corrupted copy) or an expired website login session (code 12001), 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_tiktok_livestream_analytics",
    "arguments": {
      "dateRange": "last30Day",
      "pageNumber": 1,
      "pageSize": 10,
      "region": "US",
      "sortField": {}
    }
  }
}

Legacy MCP v1

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

GET / POST /mcp/legacy

What can you do with this API?

Data explained and practical use cases

AI Guide

Question

What can TikTok Livestream Analytics tell me about shopping streams, and how might I use it?

AI answer

Query TikTok shopping livestream rankings for a market and date range, or request a specific stream with livestreamId. List and detail responses document some different fields and value types.

Data categoryDocumented fieldsWhat the values mean
Stream and creatorlivestream_id, livestream_title, creator_id, creator_handleIdentifies the broadcast and its creator. A list result’s ID can be used for a detail request.
Timinglivestream_start_time, livestream_end_time, livestream_durationStart and end times in epoch milliseconds and broadcast length in seconds.
Audienceviews, viewersviews is documented for list results; viewers is documented for details.
Salesrevenue, unit_priceReported livestream GMV and unit price in the requested currency; list values are documented as strings, while detail revenue is numeric.
Detail performancegpm, product_numberDetail-level GMV per thousand impressions and number of products delivered live.
Record contextrecord_typeThe reported record type, such as SHORT.
  • Compare streams in a selected market by reported GMV and views within the requested date range.
    • Prompt example: “I am researching TikTok marketplace data. Could you compare streams in a selected market by reported GMV and views within the requested date range? Show the returned values behind the comparison, and mark missing data.”
  • Identify a stream by livestream_id, then request its details to inspect viewers, gpm, and product_number when returned.
    • Prompt example: “I am researching TikTok marketplace data. Could you identify a stream by livestream_id, then request its details to inspect viewers, gpm, and product_number when returned? Show matching records and source links where the API provides them; ask me for any required identifier or filter.”
  • Compare stream duration with sales to investigate which broadcasts merit closer review.
    • Prompt example: “I am researching TikTok marketplace data. Could you compare stream duration with sales to investigate which broadcasts merit closer review? Show the returned values behind the comparison, and mark missing data.”
  • Filter by a creator or product ID to examine relevant broadcasts, then inspect the returned titles and performance fields.
    • Prompt example: “I am researching TikTok marketplace data. Could you filter by a creator or product ID to examine relevant broadcasts, then inspect the returned titles and performance fields? Show matching records and source links where the API provides them; ask me for any required identifier or filter.”

Data Example

Sample request and response

Request parameters

{
  "region": "US",
  "page": 1,
  "size": 5
}

Response

{
  "code": 0,
  "msg": null,
  "data": {
    "data": [
      {
        "livestream_start_time": "1790105782000",
        "livestream_duration": 29998,
        "revenue": "327961.84",
        "livestream_title": "",
        "creator_id": "6677756329987228678",
        "livestream_id": "7688445351061195533",
        "creator_handle": "byenblanfaktori",
        "unit_price": "7.73",
        "livestream_end_time": "1790135780000",
        "views": 408515,
        "record_type": "SHORT"
      },
      {
        "livestream_start_time": "1789468902000",
        "livestream_duration": 522419,
        "revenue": "124951.0",
        "livestream_title": "DEALS FOR YOU - Live Now!",
        "creator_id": "7153432386608251946",
        "livestream_id": "7685709140785728287",
        "creator_handle": "based",
        "unit_price": "27.83",
        "livestream_end_time": "1789991321000",
        "views": 3813644,
        "record_type": "SHORT"
      },
      {
        "livestream_start_time": "1790143565000",
        "livestream_duration": 4489,
        "revenue": "122173.0",
        "livestream_title": "DEALS FOR YOU - Live Now!",
        "creator_id": "7153432386608251946",
        "livestream_id": "7688607461032348446",
        "creator_handle": "based",
        "unit_price": "28.38",
        "livestream_end_time": "1790148054000",
        "views": 35956,
        "record_type": "SHORT"
      },
      {
        "livestream_start_time": "1789948635000",
        "livestream_duration": 21369,
        "revenue": "105431.93",
        "livestream_title": "Ripping The Hottest Sports Cards",
        "creator_id": "6688398622600692742",
        "livestream_id": "7687770584767318815",
        "creator_handle": "burtonbreaks",
        "unit_price": "184.0",
        "livestream_end_time": "1789970004000",
        "views": 359696,
        "record_type": "SHORT"
      },
      {
        "livestream_start_time": "1790338081000",
        "livestream_duration": 127381,
        "revenue": "104258.0",
        "livestream_title": "DEALS FOR YOU - Live Now!",
        "creator_id": "7153432386608251946",
        "livestream_id": "7689442635441834782",
        "creator_handle": "based",
        "unit_price": "28.38",
        "livestream_end_time": "1790465462000",
        "views": 1064234,
        "record_type": "SHORT"
      },
      {
        "livestream_start_time": "1790355613000",
        "livestream_duration": 43808,
        "revenue": "104146.5",
        "livestream_title": "MINT MONEY STAR ROBE DROP 💚💸",
        "creator_id": "6787875411281134598",
        "livestream_id": "7689518323038128910",
        "creator_handle": "jeffreestar",
        "unit_price": "28.59",
        "livestream_end_time": "1790399421000",
        "views": 497834,
        "record_type": "SHORT"
      },
      {
        "livestream_start_time": "1790383058000",
        "livestream_duration": 20813,
        "revenue": "98712.94",
        "livestream_title": "Hola❤️",
        "creator_id": "6800598044448457733",
        "livestream_id": "7689636419756706591",
        "creator_handle": ".brendaayala1",
        "unit_price": "29.7",
        "livestream_end_time": "1790403871000",
        "views": 315245,
        "record_type": "SHORT"
      },
      {
        "livestream_start_time": "1789992320000",
        "livestream_duration": 4512,
        "revenue": "94207.0",
        "livestream_title": "DEALS FOR YOU - Live Now!",
        "creator_id": "7153432386608251946",
        "livestream_id": "7687957811115969310",
        "creator_handle": "based",
        "unit_price": "29.9",
        "livestream_end_time": "1789996832000",
        "views": 32863,
        "record_type": "SHORT"
      },
      {
        "livestream_start_time": "1790092508000",
        "livestream_duration": 14896,
        "revenue": "87770.93",
        "livestream_title": "💝Medicube x Nello Collab Mega💝",
        "creator_id": "7291517492299007018",
        "livestream_id": "7688388230848219917",
        "creator_handle": "medicube_official_shop",
        "unit_price": "34.31",
        "livestream_end_time": "1790107404000",
        "views": 61503,
        "record_type": "FULL"
      },
      {
        "livestream_start_time": "1790017706000",
        "livestream_duration": 12414,
        "revenue": "79376.5",
        "livestream_title": "",
        "creator_id": "7014603102829593606",
        "livestream_id": "7688067090044963598",
        "creator_handle": "simplymandys",
        "unit_price": "37.65",
        "livestream_end_time": "1790030120000",
        "views": 80987,
        "record_type": "SHORT"
      },
      {
        "livestream_start_time": "1790355686000",
        "livestream_duration": 10779,
        "revenue": "73958.43",
        "livestream_title": "NOELY FAJAS MEGA LIVE",
        "creator_id": "6801519791112897542",
        "livestream_id": "7689518679498787614",
        "creator_handle": "noelyfajas",
        "unit_price": "89.65",
        "livestream_end_time": "1790366465000",
        "views": 75247,
        "record_type": "FULL"
      },
      {
        "livestream_start_time": "1790270453000",
        "livestream_duration": 51829,
        "revenue": "72404.21",
        "livestream_title": "",
        "creator_id": "6829169369835127814",
        "livestream_id": "7689152573131066125",
        "creator_handle": "calicurvesfajas",
        "unit_price": "65.7",
        "livestream_end_time": "1790322282000",
        "views": 222287,
        "record_type": "SHORT"
      },
      {
        "livestream_start_time": "1790355124000",
        "livestream_duration": 36821,
        "revenue": "70073.0",
        "livestream_title": "Fajas colombianas   🇨🇴",
        "creator_id": "7179385436960310318",
        "livestream_id": "7689516256734530317",
        "creator_handle": "alondrixsexycurves",
        "unit_price": "118.17",
        "livestream_end_time": "1790391945000",
        "views": 165052,
        "record_type": "SHORT"
      },
      {
        "livestream_start_time": "1790295054000",
        "livestream_duration": 23887,
        "revenue": "68666.76",
        "livestream_title": "Hola!!❤️",
        "creator_id": "6800598044448457733",
        "livestream_id": "7689258465444760351",
        "creator_handle": ".brendaayala1",
        "unit_price": "26.07",
        "livestream_end_time": "1790318941000",
        "views": 281085,
        "record_type": "SHORT"
      },
      {
        "livestream_start_time": "1790108377000",
        "livestream_duration": 3533,
        "revenue": "64389.0",
        "livestream_title": "DEALS FOR YOU - Live Now!",
        "creator_id": "7153432386608251946",
        "livestream_id": "7688456553828993823",
        "creator_handle": "based",
        "unit_price": "28.59",
        "livestream_end_time": "1790111910000",
        "views": 40296,
        "record_type": "SHORT"
      },
      {
        "livestream_start_time": "1790249163000",
        "livestream_duration": 127738,
        "revenue": "63659.89",
        "livestream_title": "RIPS ALL DAYYY!!!",
        "creator_id": "6906678272890848261",
        "livestream_id": "7689060444446722847",
        "creator_handle": "allpoketcg",
        "unit_price": "142.42",
        "livestream_end_time": "1790376901000",
        "views": 167774,
        "record_type": "SHORT"
      },
      {
        "livestream_start_time": "1790116436000",
        "livestream_duration": 2818,
        "revenue": "62098.65",
        "livestream_title": "FAST PACED TECH Nick",
        "creator_id": "7617890876685108238",
        "livestream_id": "7688491201942522655",
        "creator_handle": "refreshed.tech",
        "unit_price": "459.99",
        "livestream_end_time": "1790119254000",
        "views": 13763,
        "record_type": "SHORT"
      },
      {
        "livestream_start_time": "1790285688000",
        "livestream_duration": 31709,
        "revenue": "54655.29",
        "livestream_title": "",
        "creator_id": "7043091206013060102",
        "livestream_id": "7689218099326225165",
        "creator_handle": "glamourmodernfashion1",
        "unit_price": "73.07",
        "livestream_end_time": "1790317397000",
        "views": 66047,
        "record_type": "SHORT"
      },
      {
        "livestream_start_time": "1790268132000",
        "livestream_duration": 12027,
        "revenue": "50930.0",
        "livestream_title": "",
        "creator_id": "7042472144287466543",
        "livestream_id": "7689142531280046879",
        "creator_handle": "djounefelix5",
        "unit_price": "339.53",
        "livestream_end_time": "1790280159000",
        "views": 51296,
        "record_type": "SHORT"
      },
      {
        "livestream_start_time": "1790035193000",
        "livestream_duration": 2237,
        "revenue": "48597.51",
        "livestream_title": "Ripping The Hottest Sports Cards",
        "creator_id": "6688398622600692742",
        "livestream_id": "7688142341407853343",
        "creator_handle": "burtonbreaks",
        "unit_price": "109.95",
        "livestream_end_time": "1790037430000",
        "views": 5878,
        "record_type": "SHORT"
      }
    ]
  }
}

Related APIs