TikTok response objects
Every object the TikTok endpoints return, field by field, named after TikTok's Display and Research APIs. Every key is there on every call: a field the platform does not show is null, and a list is empty.
tiktok_profile
A TikTok account. Returned by tiktok/profile, tiktok/followers, tiktok/search.
| Field | What it is |
|---|---|
username | Without the @. |
display_name | The display name. |
bio_description | The bio. |
bio_url | The link in the bio. |
avatar_url | The profile picture. On TikTok's CDN. TikTok signs the link, and it can stop working within hours, so fetch the file soon. We do not rehost media. |
profile_url | The profile. |
is_verified | Whether the account has the verified badge. |
follower_count | null when the source does not give it. |
following_count | null when the source does not give it. |
likes_count | Likes across all their videos. null when the source does not give it. |
video_count | null when the source does not give it. |
tiktok_video
A TikTok video. Returned by tiktok/videos, tiktok/video, tiktok/search, tiktok/trending.
| Field | What it is |
|---|---|
id | TikTok's numeric id — the number at the end of the URL. |
share_url | The video. |
username | Who posted it. |
video_description | The caption. |
create_time | When it was posted. null when the source does not say. |
duration | Seconds. null when the source does not give it. |
cover_image_url | The video's cover image. On TikTok's CDN. TikTok signs the link, and it can stop working within hours, so fetch the file soon. We do not rehost media. |
play_url | The video file. On TikTok's CDN. TikTok signs the link, and it can stop working within hours, so fetch the file soon. We do not rehost media. |
view_count | null when the source does not give it. |
like_count | null when the source does not give it. |
comment_count | null when the source does not give it. |
share_count | null when the source does not give it. |
favorites_count | Saves. null where the page does not show them. |
hashtag_names | Without the #. |
region_code | Where it was posted from, ISO 3166-1 alpha-2. |
music | The sound. |
music.id | TikTok's id for the sound. |
music.title | The sound's name, as TikTok shows it. |
music.author | Who the sound is credited to. |
music.original | An original sound rather than a track. |
duet_enabled | null where that is not known. |
stitch_enabled | null where that is not known. |
tiktok_comment
A comment on a TikTok video. Returned by tiktok/comments.
| Field | What it is |
|---|---|
id | TikTok's id for the comment. |
video_id | The video it is on. |
parent_comment_id | The comment it replies to. null for a top-level comment. |
username | Who wrote it, without the @. |
text | null for a comment with no words, such as a sticker. |
create_time | null when the source does not say. |
like_count | null when the source does not give it. |
reply_count | null when the source does not give it. |
tiktok_hashtag
A TikTok hashtag, from a search. Returned by tiktok/search.
| Field | What it is |
|---|---|
hashtag_name | Without the #. |
url | The hashtag page. |
video_count | How many videos use it. |
view_count | Views across its videos. |
tiktok_ad
An ad from TikTok's Ad Library. Returned by tiktok/ads.
| Field | What it is |
|---|---|
id | The Ad Library's id for the ad. |
url | The ad in TikTok's Ad Library. |
advertiser | The name the ad runs under. |
title | The ad's title, as the library shows it. |
industry | As the library files it, e.g. "Apparel & Accessories". |
first_shown | When it was first shown, as the library dates it. |
last_shown | When it was last shown, as the library dates it. |
video_url | The ad's video. On TikTok's CDN. TikTok signs the link, and it can stop working within hours, so fetch the file soon. We do not rehost media. |
cover_image_url | The video's cover image. On TikTok's CDN. TikTok signs the link, and it can stop working within hours, so fetch the file soon. We do not rehost media. |
image_urls | The ad's images, in order. On TikTok's CDN. TikTok signs the link, and it can stop working within hours, so fetch the file soon. We do not rehost media. |
estimated_audience | The range the library shows, e.g. "1K-10K". |
impressions | How many times it was shown, as the library counts it. null where the library leaves it blank. |