> Documentation index: https://docs.scrapier.io/llms.txt
> Auth: header `X-API-Key: <key>` · Base: https://api.scrapier.io/api/v2 · Synchronous; paginate with `cursor` ← `data.next_cursor`.

# TikTok Playlist Videos

Structured TikTok data: every input is optional. Cursor-paginated, 1 credit per successful call.

`GET|POST https://api.scrapier.io/api/v2/tiktok-playlist-videos/` · 1 credit per successful call · Cursor-paginated

## Overview

Call `GET /api/v2/tiktok-playlist-videos/`. The results are in `data.playlists`; send `data.next_cursor` back as `cursor` to get the next page. 7 optional parameters refine the call (see Parameters).

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/tiktok-playlist-videos/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/tiktok-playlist-videos/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={},
    timeout=210,
)
body = resp.json()
if not resp.ok:
    raise RuntimeError(body.get("error") or body.get("detail"))

print(body["data"]["playlists"])
```

POST with a JSON body works too (same parameters; the body is merged over the query string).

## Parameters

> **Note:** No parameter is strictly required, but send at least the inputs shown in the example.

| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| `X-API-Key` (header) | string | yes | — | Your API key. |
| `playlist_ids` | string | no | `7090570072548461358` | TikTok playlist id or playlist URL -> playlist mode: ONE native /api/mix/item_list/ page (<= 20 videos, under `videos`) per call, paged through TikTok's own offset. Any ONE of playlist_ids / usernames / user_ids on the first call (the first given wins, in that order); ignored when `cursor` is supplied. |
| `usernames` | string | no | — | TikTok handle / @handle / profile URL -> profile mode: every playlist of the creator, playlist by playlist in TikTok's order. The frozen playlist plan (ids + counts) rides in the cursor, so each call fetches ONE native page and continues into the next playlist without re-walking; next_cursor is null after the last playlist. |
| `user_ids` | string | no | — | Numeric TikTok user id -> profile mode (resolved via /share/user/{id}). |
| `cursor` | string | no | — | Pagination cursor returned in the previous response's `next_cursor`. Pass it back unchanged to fetch the next page. When `next_cursor` is null, you have reached the last page. |
| `enrich` | string | no | `auto` | auto = skip the per-video pages (a native page holds up to 30 videos, above the 10-video auto limit; each page costs ~90 KB of proxy traffic); true = open every video's page for location_created, diversification_labels, aigc flags; false = never (fastest). Best-effort inside the call's 70 s budget: if TikTok rate-limits video pages or time runs out, rows still return (enriched=false) with a `warning`. One of: `auto`, `true`, `false`. Locked in cursor. |
| `strict_owner` | boolean | no | `false` | true = playlist URL @handle != real owner -> 404. Locked in cursor. |
| `region` | string | no | `US` | 2-letter market region for the signed API calls. Locked in cursor. |
| `use_proxy` | boolean | no | `true` | Route the request through Scrapier's residential proxy pool. Default: `true`. Leave as is unless support tells you otherwise. |
| `raw_data` | boolean | no | `false` | When true, the response carries the full raw upstream payload(s) the scraper received (GraphQL / JSON API bodies, HTML, embedded JSON-LD -- exactly as the platform returned them) under `raw_responses`, in place of the formatted items. When false (default) you get the formatted output. Pagination (`cursor` / `next_cursor`) works the same in both modes. |

## Response

HTTP 200. Results are in `data.playlists`. Sample from the live catalog, arrays trimmed to 3 items.

```json
{
  "success": true,
  "data": {
    "usernames": "stoolpresidente",
    "mode": "profile",
    "status": "ok",
    "error": null,
    "page": 1,
    "page_size": 20,
    "cursor": 0,
    "next_offset": 20,
    "has_more": true,
    "total": 1066,
    "dropped": 0,
    "owner": {
      "id": "6614519312189947909",
      "username": "stoolpresidente",
      "display_name": "Dave Portnoy",
      "sec_uid": "MS4wLjABAAAA...",
      "verified": true,
      "signature": "El Presidente",
      "avatar_url": "https://p16-common-sign.tiktokcdn.com/...",
      "private_account": false,
      "url": "https://www.tiktok.com/@stoolpresidente",
      "followers": 4700000,
      "following": 43,
      "video_count": 1462,
      "total_likes": 197400000,
      "source": "profile_page"
    },
    "playlists": [
      {
        "id": "7628274620319795982",
        "name": "Tea By The Sea",
        "video_count": 55
      },
      {
        "id": "7336308011385867051",
        "name": "Miss Peaches",
        "video_count": 78
      },
      {
        "id": "7090570072548461358",
        "name": "Pizza Reviews",
        "video_count": 651
      }
    ],
    "warnings": [],
    "videos": [
      {
        "input_playlist_id": null,
        "input_username": "stoolpresidente",
        "input_user_id": null,
        "mode": "profile",
        "status": "ok",
        "error": null,
        "playlist_id": "7628274620319795982",
        "playlist_name": "Tea By The Sea",
        "playlist": {
          "id": "7628274620319795982",
          "name": "Tea By The Sea",
          "url": "https://www.tiktok.com/@stoolpresidente/playlist/Tea%20By%20The%20Sea-7628274620319795982",
          "video_count": 55,
          "cover_url": null,
          "listed_on_profile": true,
          "owner": {
            "username": "stoolpresidente",
            "...": "(owner card)"
          }
        },
        "playlist_position": 0,
        "video_id": "7623513708433607949",
        "url": "https://www.tiktok.com/@stoolpresidente/video/7623513708433607949",
        "description": "Tea By The Sea - Episode 1",
        "created_at": "2026-03-31T16:22:35.000Z",
        "create_time": 1774974155,
        "play_count": 4000000,
        "like_count": 187300,
        "comment_count": 2551,
        "share_count": 5039,
        "save_count": 6420,
        "repost_count": 0,
        "duration_seconds": 93,
        "thumbnail_url": "https://p16-common-sign.tiktokcdn.com/...",
        "play_url": "https://v16-webapp-prime.tiktok.com/video/tos/...",
        "download_url": null,
        "is_photo_post": false,
        "pinned": false,
        "hashtags": [],
        "mentions": [],
        "music_title": "original sound",
        "music_author": "Dave Portnoy",
        "location_created": "US",
        "text_language": "en",
        "enriched": true,
        "author": {
          "id": "6614519312189947909",
          "username": "stoolpresidente",
          "display_name": "Dave Portnoy",
          "...": "(author card)"
        },
        "post": {
          "id": "7623513708433607949",
          "content": {
            "...": "(text, media URLs, dimensions, bitrates)"
          },
          "engagement": {
            "views": 4000000,
            "likes": 187300,
            "comments": 2551,
            "shares": 5039,
            "saves": 6420,
            "reposts": 0
          },
          "flags": {
            "...": "(pinned / ad / aigc / duet / stitch / comments ...)"
          },
          "published_at": "2026-03-31T16:22:35.000Z",
          "ext": {
            "playlist_id": "7628274620319795982",
            "playlist_name": "Tea By The Sea",
            "playlist_position": 0,
            "location_created": "US",
            "diversification_labels": [
              "Food & Drink"
            ],
            "...": "(music, author stats)"
          }
        },
        "computed": {
          "engagement_rate": 0.048723,
          "content_category": "food & drink",
          "estimated_reach": 4800000,
          "...": "(rates, age_days)"
        },
        "playlists": [
          {
            "id": "7628274620319795982",
            "name": "Tea By The Sea",
            "video_count": 55
          },
          "..."
        ],
        "cursor": 0,
        "next_cursor": 20,
        "has_more": true,
        "total": 1066,
        "dropped": 0,
        "warnings": [],
        "position": 1,
        "scraped_at": "2026-09-20T15:52:10.305Z"
      },
      "... 19 more rows (Tea By The Sea, playlist_position 1-19) ..."
    ],
    "next_cursor": "eyJoIjoic3Rvb2xwcmVzaWRlbnRlIiwiaSI6MCwiaW4iOiJzdG9vbHByZXNpZGVudGUiLCJsayI6e30sIm0iOiJwcm9maWxlIiwib2ZmIjoyMCwib3duIjp7Li4ufSwicCI6MSwicGxhbiI6W1siNzYyODI3NDYyMDMxOTc5NTk4MiIsNTUsIlRlYSBCeSBUaGUgU2VhIl0sLi4uXSwicG9zIjoyMCwicyI6WyI3NjIzNTEzNzA4NDMzNjA3OTQ5IiwuLi5dfQ",
    "elapsed_sec": 4.1
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `usernames` | string | `stoolpresidente` |  |
| `mode` | string | `profile` |  |
| `status` | string | `ok` |  |
| `error` | null | `null` |  |
| `page` | integer | `1` |  |
| `page_size` | integer | `20` |  |
| `cursor` | integer | `0` |  |
| `next_offset` | integer | `20` |  |
| `has_more` | boolean | `true` |  |
| `total` | integer | `1066` |  |
| `dropped` | integer | `0` |  |
| `owner` | object | `{…}` |  |
| `playlists` | array | `[4 items]` | The results. |
| `warnings` | array | `[]` |  |
| `videos` | array | `[2 items]` |  |
| `next_cursor` | string | `eyJoIjoic3Rvb2xwcmVzaWRlbnRlIiwiaSI6MCwiaW4iO…` | Pass back as `cursor` for the next page. `null` on the last page. |
| `elapsed_sec` | number | `4.1` |  |
| `playlists[].id` | string | `7628274620319795982` |  |
| `playlists[].name` | string | `Tea By The Sea` |  |
| `playlists[].video_count` | integer | `55` |  |

## Pagination

Pass `data.next_cursor` back as `cursor` until it is `null`. Required inputs are ignored once a cursor is sent. Each page is one billed call.

```python
import requests

URL = "https://api.scrapier.io/api/v2/tiktok-playlist-videos/"
HEADERS = {"X-API-Key": "YOUR_API_KEY"}
params = {}
items = []

for _ in range(10):  # each page is one billed call
    resp = requests.get(URL, headers=HEADERS, params=params, timeout=210)
    resp.raise_for_status()
    data = resp.json()["data"]
    items.extend(data.get("playlists") or [])
    if not data.get("next_cursor"):  # None = last page
        break
    params = {"cursor": data["next_cursor"]}
```

## Errors

Failed calls are free. Branch on HTTP status; the message is in `error` (or `detail`). See https://docs.scrapier.io/errors.md

- **400** Bad input. The exact message varies by endpoint. `{"success":false,"error":"…"}`
- **402** Balance below the endpoint's price. `{"error":"Insufficient credits. Buy more to scrape more.","balance":1,"required":2}`
- **403** Invalid or unknown API key. `{"detail":"Authentication service unavailable or invalid API key."}`
- **429** Throttled — wait for Retry-After. `{"detail":"Request was throttled. Expected available in N seconds."}`
- **404** unknown slug · **503** busy (retry after `Retry-After`) · **5xx** upstream failure or timeout (retry with backoff).

## Notes

- Locked into the cursor: `enrich`, `strict_owner`, `region`. Set them on the first call; later pages reuse them.

## Related

- [TikTok Ad Library Leads](https://docs.scrapier.io/api-reference/tiktok/tiktok-ad-library-leads.md): Structured TikTok data: every input is optional. Single lookup, 3 credits per successful call.
- [TikTok Ad Library](https://docs.scrapier.io/api-reference/tiktok/tiktok-ads.md): Structured TikTok data: send `urls`. Cursor-paginated, 1 credit per successful call.
- [TikTok Ads Top](https://docs.scrapier.io/api-reference/tiktok/tiktok-ads-top.md): Structured TikTok data: every input is optional. Cursor-paginated, 1 credit per successful call.
- [TikTok Collection Videos](https://docs.scrapier.io/api-reference/tiktok/tiktok-collection-videos.md): Structured TikTok data: send `urls`. Cursor-paginated, 1 credit per successful call.
