Skip to content
ScrapeField

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.

Fields
FieldWhat it is
username
string
Without the @.
display_name
string · or null
The display name.
bio_description
string · or null
The bio.
bio_url
URL · or null
The link in the bio.
avatar_url
URL · or null
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
URL
The profile.
is_verified
boolean
Whether the account has the verified badge.
follower_count
integer · or null
null when the source does not give it.
following_count
integer · or null
null when the source does not give it.
likes_count
integer · or null
Likes across all their videos. null when the source does not give it.
video_count
integer · or null
null when the source does not give it.

tiktok_video

Fields
FieldWhat it is
id
string
TikTok's numeric id — the number at the end of the URL.
share_url
URL
The video.
username
string
Who posted it.
video_description
string · or null
The caption.
create_time
time, ISO 8601 UTC · or null
When it was posted. null when the source does not say.
duration
integer · or null
Seconds. null when the source does not give it.
cover_image_url
URL · or null
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
URL · or null
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
integer · or null
null when the source does not give it.
like_count
integer · or null
null when the source does not give it.
comment_count
integer · or null
null when the source does not give it.
share_count
integer · or null
null when the source does not give it.
favorites_count
integer · or null
Saves. null where the page does not show them.
hashtag_names
array of strings
Without the #.
region_code
string · or null
Where it was posted from, ISO 3166-1 alpha-2.
music
object · or null
The sound.
music.id
string
TikTok's id for the sound.
music.title
string
The sound's name, as TikTok shows it.
music.author
string · or null
Who the sound is credited to.
music.original
boolean
An original sound rather than a track.
duet_enabled
boolean · or null
null where that is not known.
stitch_enabled
boolean · or null
null where that is not known.

tiktok_comment

A comment on a TikTok video. Returned by tiktok/comments.

Fields
FieldWhat it is
id
string
TikTok's id for the comment.
video_id
string
The video it is on.
parent_comment_id
string · or null
The comment it replies to. null for a top-level comment.
username
string
Who wrote it, without the @.
text
string · or null
null for a comment with no words, such as a sticker.
create_time
time, ISO 8601 UTC · or null
null when the source does not say.
like_count
integer · or null
null when the source does not give it.
reply_count
integer · or null
null when the source does not give it.

tiktok_hashtag

A TikTok hashtag, from a search. Returned by tiktok/search.

Fields
FieldWhat it is
hashtag_name
string
Without the #.
url
URL
The hashtag page.
video_count
integer · or null
How many videos use it.
view_count
integer · or null
Views across its videos.

tiktok_ad

An ad from TikTok's Ad Library. Returned by tiktok/ads.

Fields
FieldWhat it is
id
string
The Ad Library's id for the ad.
url
URL
The ad in TikTok's Ad Library.
advertiser
string · or null
The name the ad runs under.
title
string · or null
The ad's title, as the library shows it.
industry
string · or null
As the library files it, e.g. "Apparel & Accessories".
first_shown
time, ISO 8601 UTC · or null
When it was first shown, as the library dates it.
last_shown
time, ISO 8601 UTC · or null
When it was last shown, as the library dates it.
video_url
URL · or null
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
URL · or null
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
array of 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
string · or null
The range the library shows, e.g. "1K-10K".
impressions
integer · or null
How many times it was shown, as the library counts it. null where the library leaves it blank.