Install the TikTok SDK

Install @traceryn/tiktok-sdk, create a client, and fetch your first TikTok video.

Requirements

• Node.js 18 or later

Install

npm

npm install @traceryn/tiktok-sdk

yarn

yarn add @traceryn/tiktok-sdk

From GitHub

npm install git+https://github.com/traceryn/tiktok-sdk.git
# or
yarn add git+https://github.com/traceryn/tiktok-sdk.git

Optional: Playwright

Playwright is only needed for browser-backed session requests. See Playwright sessions.

npm install playwright
npx playwright install chromium

The playwright package does not ship a browser by default. You must download a browser binary with npx playwright install chromium.

Create a client

ESM

import { TikTokClient } from '@traceryn/tiktok-sdk';

const client = new TikTokClient();

Make your first request

import { TikTokClient } from '@traceryn/tiktok-sdk';

const client = new TikTokClient();

const video = await client.getVideo('https://www.tiktok.com/@user/video/1234567890');
console.log(video.title);

A few more examples:

const user = await client.getUser('tiktok');
console.log(user.nickname);

const comments = await client.getComments('https://www.tiktok.com/@user/video/1234567890');
console.log(comments.comments.length);

const hashtag = await client.getHashtag('fyp');
console.log(hashtag.stats.videoCount);

const trending = await client.getTrendingVideos();
console.log(trending.videos.length);

Runnable example scripts live in the repository’s docs/examples directory, and sample response data is in docs/responses.

Next steps

Methods

Every method the client exposes.

Configuration

Timeouts, retries, rate limits, and caching.