TikTok

Video

A video or photo post: its caption, counts, author, sound, hashtags, mentions and caption tracks.

GET/v1/tiktok/videos1 credit

Headers

Get your API key

x-api-key*stringrequiredheader

Your API key, made in the dashboard.

Parameters

video_idstringoptionalquery

A video's or photo post's id: the digits after /video/ or /photo/ in its link. Give video_id or url.

example: 7587811642650545421

urlstringoptionalquery

A video's or photo post's link: tiktok.com/@handle/video/<id> or /photo/<id>. Not a short link (vm.tiktok.com): open it, and copy the link it leads to. Give video_id or url.

max 300 chars

Response fields

dataobject

The result: one object, or a list for the endpoints that return several.

data.idstring

The video's id: digits.

data.urlstring

Its link.

data.descriptionstringnullable

Its caption, with its hashtags and mentions.

data.created_atstringnullable

When it was posted.

format: date-time

data.duration_secondsintegernullable

Its length, in seconds: 0 for a photo post.

data.thumbnailstringnullable

Its cover image's link.

data.imagesstring[]nullable

A photo post's images, in order; null for a video.

data.viewsintegernullable

Views.

data.likesintegernullable

Likes.

data.comment_countintegernullable

Comments.

data.sharesintegernullable

Shares.

data.savesintegernullable

How many saved it to their favorites.

data.is_adbooleannullable

Whether it is an ad.

data.author_idstringnullable

Its author's user id.

data.author_handlestringnullable

Its author's handle, without the @.

data.author_namestringnullable

Its author's name.

data.author_verifiedbooleannullable

Whether its author is verified.

data.author_followersintegernullable

Its author's followers.

data.regionstringnullable

The country it was posted from: a two-letter code.

data.languagestringnullable

The language of its caption: a two-letter code.

data.hashtagsstring[]nullable

The hashtags in its caption, without the #.

data.mentionsstring[]nullable

The handles its caption mentions, without the @.

data.musicobjectnullable

Its sound.

data.music.idstring

The sound's id.

data.music.titlestringnullable

Its title: "original sound" for one made with the video.

data.music.authorstringnullable

Who made it.

data.music.originalbooleannullable

Whether it was made with this video, rather than a song from TikTok's library.

data.music.duration_secondsintegernullable

Its length, in seconds.

data.music.coverstringnullable

Its cover image's link.

data.captionsarraynullable

Its caption tracks; get one's text from the transcript endpoint.

data.captions[].languagestring

Its language, as TikTok codes it: eng-US, rus-RU. Ask the transcript endpoint for it by this code.

data.captions[].autobooleanoptional

Whether TikTok made it, from the speech or by translating.

default: false

pageobjectnullable

Paging, for the endpoints that page; null for the others.

page.next_cursorstringnullable

Send it as the cursor parameter, with the same other parameters, for the next page. Null on the last page.

page.has_morebooleanoptional

Whether another page follows.

default: false

metaobject

About this call.

meta.platformstring

The platform: reddit, threads, tiktok or youtube.

meta.endpointstring

The endpoint's name, such as channel_videos.

meta.paramsobject

The call's parameters, defaults included. Parameters without a value, and the cursor, are left out.

meta.request_idstring

This call's id. Quote it when you report a problem.

meta.api_versionstring

The API version that answered.

meta.fetched_atstring

When the data was fetched from the platform (UTC).

format: date-time

meta.cachedbooleanoptional

Whether it came from our cache; fetched_at says how old it is.

default: false

Code example

curl -X GET 'https://api.socialparse.dev/v1/tiktok/videos?video_id=7587811642650545421' \  -H 'x-api-key: YOUR_API_KEY'

Responses

Successful Response

{  "data": {    "id": "string",    "url": "string",    "description": "string",    "created_at": "2019-08-24T14:15:22Z",    "duration_seconds": 0,    "thumbnail": "string",    "images": [      "string"    ],    "views": 0,    "likes": 0,    "comment_count": 0,    "shares": 0,    "saves": 0,    "is_ad": true,    "author_id": "string",    "author_handle": "string",    "author_name": "string",    "author_verified": true,    "author_followers": 0,    "region": "string",    "language": "string",    "hashtags": [      "string"    ],    "mentions": [      "string"    ],    "music": {      "id": "string",      "title": "string",      "author": "string",      "original": true,      "duration_seconds": 0,      "cover": "string"    },    "captions": [      {        "language": "string",        "auto": false      }    ]  },  "page": {    "next_cursor": "string",    "has_more": false  },  "meta": {    "platform": "string",    "endpoint": "string",    "params": {      "property1": "string",      "property2": "string"    },    "request_id": "string",    "api_version": "string",    "fetched_at": "2019-08-24T14:15:22Z",    "cached": false  }}

Profile live

Whether a profile is live now, with its live room's details when it is. A private account answers LOGIN_REQUIRED.

Video comments

A video's comments, up to 50 a page, in TikTok's order, each with its reply count. TikTok re-ranks them as it serves pages, so one may come twice. An empty list: the video has no comments, or doesn't exist.