> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). The sections below mirror the orientation block in [`/llms.txt`](https://www.socialfetch.dev/llms.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need a structured operation inventory. The catalog covers documented operations with on-site reference pages.

## This page

- **On-site (HTML):** [https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/live/get](https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/live/get)
- **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/live/get.mdx](https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/live/get.mdx)

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** [https://www.socialfetch.dev/openapi.json](https://www.socialfetch.dev/openapi.json)

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [SDK reference](https://www.socialfetch.dev/docs/sdk-reference.mdx) — exhaustive SDK method inventory and route mapping for agents, tooling, and power users.
- [Choose the right endpoint](https://www.socialfetch.dev/docs/choose-endpoint.mdx) — task-oriented route selection for smoke tests, profiles, list endpoints, and single-item lookups.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — fast comparison of identifiers, pagination, outcomes, media download, and SDK coverage.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).

---
# Get TikTok live stream (https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/live/get)

## Summary

Looks up a TikTok handle and returns live stream details when broadcasting, with profile fields for lookup context.

**Tags:** `TikTok`

## HTTP

- **Method:** GET
- **Path:** `/v1/tiktok/profiles/{handle}/live`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.tiktok.getProfileLive({ handle })`
- **Accepted identifiers:** `handle` (path)
- **Pagination:** none
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `handle` (path)

- **Required:** yes
- **Constraints:** type `string`; minLength: 1; maxLength: 64
- **Description:** TikTok handle to look up, with or without a leading @.

## Responses (status codes)

- **200**: Lookup result. Check `data.lookupStatus` for `found` or `not_found`; when found, `data.liveStatus` is `live` or `offline`, with profile context in `data.profile` and live stream payload in `data.live` when broadcasting.
- **400**: Invalid handle or bad request
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed from the response (unexpected or invalid data).
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

Lookup result. Check `data.lookupStatus` for `found` or `not_found`; when found, `data.liveStatus` is `live` or `offline`, with profile context in `data.profile` and live stream payload in `data.live` when broadcasting.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether a TikTok profile identity could be resolved for the handle.
  - **liveStatus** (required) — type `string`; enum: live, offline, null; nullable. When `lookupStatus` is `found`, whether the profile is `live` or `offline`. Null when the profile could not be resolved.
  - **profile** (required) — type `object`; nullable. Profile identity when the lookup resolved.
    - **platform** (required) — type `string`; enum: tiktok. Social platform for this profile.
    - **handle** (required) — type `string`. TikTok username without the leading @.
    - **displayName** (required) — type `string`; nullable. Public display name shown on the TikTok profile.
    - **avatarUrl** (required) — type `string`; nullable. Best available avatar image URL for the profile.
    - **verified** (required) — type `boolean`. Whether TikTok marks the profile as verified.
    - **profileUrl** (required) — type `string`; minLength: 1. Canonical public TikTok profile URL.
    - **platformUserId** (optional) — type `string`. TikTok numeric user id as a string (stable within TikTok).
    - **secUid** (optional) — type `string`. TikTok opaque stable user identifier (for advanced integrations).
    - **followerCount** (optional) — type `integer`; minimum: 0. Follower count reported by TikTok when available.
    - **followingCount** (optional) — type `integer`; minimum: 0. Following count reported by TikTok when available.
    - **bio** (optional) — type `string`; nullable. Profile biography text when TikTok provides it.
  - **live** (required) — type `object`; nullable. Live broadcast details when `liveStatus` is `live`. Null when not live or when the profile could not be resolved.
    - **roomId** (required) — type `string`; minLength: 1. TikTok live room identifier for the current broadcast.
    - **title** (required) — type `string`; nullable. Live stream title when TikTok provides one.
    - **coverUrl** (required) — type `string`; nullable. Cover image URL for the live stream when available.
    - **startedAt** (required) — type `string`; nullable. ISO-8601 timestamp when the live stream started, when TikTok provides a valid start time.
    - **viewerCount** (required) — type `integer`; minimum: 0. Approximate concurrent viewers reported by TikTok.
    - **enterCount** (required) — type `integer`; minimum: 0. Cumulative enters reported by TikTok for this live room.
    - **streamId** (optional) — type `string`. TikTok stream identifier when TikTok provides one.
    - **streams** (required) — type `array`. Flattened playback variants for the live stream.
      - _items:_
        - **codecFamily** (required) — type `string`; enum: h264, h265. Video codec family for this variant.
        - **source** (required) — type `string`; enum: primary, hevc. Which upstream stream bundle this variant came from (standard vs alternate encoding).
        - **qualityKey** (required) — type `string`; minLength: 1. Stable quality key for this variant (for example origin, hd, sd).
        - **qualityLabel** (optional) — type `string`. Human-readable quality label when TikTok provides one.
        - **flvUrl** (optional) — type `string`. FLV playback URL when TikTok provides one.
        - **hlsUrl** (optional) — type `string`. HLS playback URL when TikTok provides one.
        - **cmafUrl** (optional) — type `string`. CMAF playback URL when TikTok provides one.
        - **resolution** (optional) — type `string`. Video resolution string when TikTok reports it.
        - **bitrate** (optional) — type `integer`; minimum: 0. Target bitrate in bits per second when TikTok reports it.
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.

### Example JSON (live)

```json
{
  "data": {
    "lookupStatus": "found",
    "liveStatus": "live",
    "profile": {
      "platform": "tiktok",
      "handle": "aommsinn_28",
      "displayName": "ธนาคารสีชมพู💕",
      "avatarUrl": "https://example.com/avatar.jpg",
      "verified": false,
      "profileUrl": "https://www.tiktok.com/@aommsinn_28",
      "platformUserId": "6824385553216996353",
      "secUid": "MS4wLjABAAAAexample",
      "followerCount": 1100,
      "followingCount": 612,
      "bio": "IG:aomsinnn_28\nรับรีวิวสินค้า🧺"
    },
    "live": {
      "roomId": "7630101503277746960",
      "title": "เหงาาคับบพี่",
      "coverUrl": "https://example.com/cover.jpg",
      "startedAt": "2026-04-18T14:30:53.000Z",
      "viewerCount": 4,
      "enterCount": 820,
      "streamId": "1848602593495089198",
      "streams": [
        {
          "codecFamily": "h264",
          "source": "primary",
          "qualityKey": "origin",
          "qualityLabel": "Original",
          "flvUrl": "https://example.com/stream-origin.flv"
        }
      ]
    }
  },
  "meta": {
    "requestId": "req_01example",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Example JSON (offline)

```json
{
  "data": {
    "lookupStatus": "found",
    "liveStatus": "offline",
    "profile": {
      "platform": "tiktok",
      "handle": "jade_pk6",
      "displayName": "Jade-pk",
      "avatarUrl": "https://example.com/avatar.jpg",
      "verified": false,
      "profileUrl": "https://www.tiktok.com/@jade_pk6",
      "platformUserId": "75123320319",
      "secUid": "MS4wLjABAAAAexample",
      "followerCount": 1657,
      "followingCount": 217,
      "bio": "หยกรีวิวทู้กกกอย่างงง🥰"
    },
    "live": null
  },
  "meta": {
    "requestId": "req_01example_offline",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Example JSON (not_found)

```json
{
  "data": {
    "lookupStatus": "not_found",
    "liveStatus": null,
    "profile": null,
    "live": null
  },
  "meta": {
    "requestId": "req_01example_nf",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid handle or bad request **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed from the response (unexpected or invalid data). **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.tiktok.getProfileLive({
  handle: "charlidamelio",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/tiktok/profiles/charlidamelio/live",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY",
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/tiktok/profiles/charlidamelio/live" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/tiktok/profiles/charlidamelio/live",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```