# tiktok.video

**beta** **2 credits** **may need a pack**

A single TikTok video: caption, author, plays, likes, comments, shares.

`GET /v1/tiktok/video`

> [!NOTE] **Beta.** This endpoint has not yet been verified against the live source, so fields may be missing or differ until it becomes stable. Failed calls are refunded.

> [!NOTE] **May need a pack.** Free credits use only the open fetch path; the fallback path behind it needs a purchased pack and a verified email. See [pricing](https://onekey.dev/pricing).

## What you get

One TikTok record in Onekey's unified shape, in `data`. If the record does not exist you get a `404 not_found` and are not charged.

**Also works with:** [URL lookup](https://onekey.dev/docs/lookup.md) (`tiktok.com/*/video/{id}`) · [Computed block](https://onekey.dev/docs/computed.md) (`engagement_rate`, `estimated_reach`, `language`). Any [batch](https://onekey.dev/docs/batch.md) can include it.

**Also known as:** `/tiktok/post` on APIs that nest their paths. See [Alternatives and equivalents](https://onekey.dev/docs/alternatives.md).

## What it costs

- **2 credits** for a fresh fetch, charged only when it succeeds.
- **Free when served from cache (0.2 credit for a cached response over 100 KB).**
- **Free** if the request is invalid (never charged) or the source fails or reports not found (refunded).

## Parameters

| Name | Type | Required | Default | What it is | Constraints |
| --- | --- | --- | --- | --- | --- |
| `id` | string | yes | (required) | TikTok video id | max 25 chars; must match `[0-9]{10,25}`; trimmed |

## Request

```bash
curl "https://api.onekey.dev/v1/tiktok/video?id=6718335390845095173" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/tiktok/video",
    params={"id": "6718335390845095173"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ id: "6718335390845095173" });
const res = await fetch(`https://api.onekey.dev/v1/tiktok/video?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## Recorded response

A real TikTok response, recorded and returned in Onekey's shape. Fields the platform does not provide are `null`.

```json
{
  "success": true,
  "data": {
    "content": {
      "id": "id0290",
      "text": "example content.text 0",
      "createdAt": "2023-11-14T22:13:20Z"
    },
    "author": {
      "id": "id0548",
      "username": "example author.username 0",
      "displayName": "example author.displayName 0",
      "avatarUrl": "https://example.com/author/avatarurl/0"
    },
    "engagement": {
      "views": 100,
      "likes": 100,
      "comments": 100,
      "shares": 100,
      "bookmarks": 100
    },
    "media": {
      "thumbnailUrl": "https://example.com/media/thumbnailurl/0",
      "durationSeconds": 100
    },
    "ext": {
      "sound": "example content.sound 0"
    }
  },
  "metadata": {
    "platform": "tiktok",
    "endpoint": "video",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 2,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}
```

## Field mapping

How this endpoint's source fields become Onekey's [unified schema](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `itemInfo.itemStruct.id` | `content.id` | - |
| `itemInfo.itemStruct.desc` | `content.text` | - |
| `itemInfo.itemStruct.createTime` | `content.createdAt` | `toIsoDate` |
| `itemInfo.itemStruct.author.id` | `author.id` | - |
| `itemInfo.itemStruct.author.uniqueId` | `author.username` | - |
| `itemInfo.itemStruct.author.nickname` | `author.displayName` | - |
| `itemInfo.itemStruct.author.avatarThumb` | `author.avatarUrl` | `safeUrl` |
| `itemInfo.itemStruct.stats.playCount` | `engagement.views` | `toNumber` |
| `itemInfo.itemStruct.stats.diggCount` | `engagement.likes` | `toNumber` |
| `itemInfo.itemStruct.stats.commentCount` | `engagement.comments` | `toNumber` |
| `itemInfo.itemStruct.stats.shareCount` | `engagement.shares` | `toNumber` |
| `itemInfo.itemStruct.stats.collectCount` | `engagement.bookmarks` | `toNumber` |
| `itemInfo.itemStruct.video.cover` | `media.thumbnailUrl` | `safeUrl` |
| `itemInfo.itemStruct.video.duration` | `media.durationSeconds` | `toNumber` |
| `itemInfo.itemStruct.music.title` | `ext.sound` | - |

## Caching and freshness

- Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
- Between 1 hour and 1 day the cached copy is still served instantly and marked `stale: true` while Onekey refreshes it in the background.
- If the source is down when a refresh is needed, the last copy can be served for up to 3 days more (marked stale).
- A "not found" is remembered for 5 minutes and is free.
- The cache is shared across all customers, which is what keeps repeat calls cheap.

## What can go wrong

| Status | Code | What to do |
| --- | --- | --- |
| 401 | `unauthorized` | Check the `x-api-key` header. |
| 402 | `insufficient_credits` | [Add credits](https://onekey.dev/pricing); your balance must cover the price. |
| 404 | `not_found` | That record does not exist. Free; do not retry. |
| 422 | `invalid_params` | Fix the parameters using the table above. Free. |
| 429 | `rate_limited` | Wait `Retry-After` seconds, then retry. |
| 502 | `upstream_error` | The source failed. Refunded; retry with backoff. |

See [Errors](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: beta (not yet verified against the live source).