Social Parse
PricingDashboard
TikTok

Playlist videos

A playlist's videos, 30 a page, in its order.

GET/v1/tiktok/playlists1 credit

Headers

Get your API key
x-api-key*stringrequiredheader

Your API key, made in the dashboard.

Parameters

3
playlist_idstringoptionalquery

A playlist's id: the digits at the end of its link, or an id from the profile playlists endpoint. Give playlist_id or url.

example: 7596415294902389534

urlstringoptionalquery

A playlist's link: tiktok.com/@handle/playlist/<name>-<id>. Give playlist_id or url.

max 300 chars

cursorstringoptionalquery

For the next page: page.next_cursor from the page before. Send the other parameters again with it.

max 1000 chars

Response fields

28
dataarray

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.

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/playlists?playlist_id=7596415294902389534' \  -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"    }  ],  "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  }}

Video transcript

A video's captions, as one text and as timed segments. A video without them answers NOT_FOUND.

Collection videos

A collection's videos, 30 a page: favorites its owner made public as a collection.