TikTok video comments API
  1. Docs
  2. TikTok
  3. TikTok video comments API

TikTok video comments API

Comments on a video, with the commenter and like and reply counts.

GET /v1/tiktok/video/comments

GET /v1/tiktok/video/comments

Comments on a video, with the commenter and like and reply counts.

  • Cost: 1 credit
  • Cache: Results are kept up to 30 days; send max_age_days to reuse them for free.
  • Timeout: A request still running after about 25 seconds answers 202 with a job to poll (Batch and jobs).

Parameters#

NameTypeRequiredDescription
urlURLone ofVideo URL (www.tiktok.com/@user/video/..., vm.tiktok.com/..., vt.tiktok.com/...). Accepted hosts: tiktok.com.
idstringone ofNumeric video id. Also accepted as aweme_id, video_id.

Send at least one of url, id. If you send several, the first listed is used and the rest are ignored.

Every request also accepts:

  • cursor: the cursor from the previous page (Pagination).
  • trim: true for a smaller response without null fields and extra.
  • raw: true to also get the platform's original object as raw.
  • max_age_days: accept a cached result up to this many days old, for 0 credits (Caching).

Example request#

Set your key in the environment first (see Authentication).

1curl -G "https://api.socialscrape.dev/v1/tiktok/video/comments" \2  -H "x-api-key: $SOCIALSCRAPE_API_KEY" \3  --data-urlencode "url=https://www.tiktok.com/@khaby.lame/video/7137423965982592302"

Example response#

This is a sample from a recorded response, lists and long text are shortened, other people's names and handles are replaced. Status 200.

200 OKSample response
1{2  "ok": true,3  "credits_charged": 1,4  "credits_remaining": 4999,5  "cached": false,6  "cached_at": null,7  "request_id": "req_c081974c80bc4d366c700069",8  "data": {9    "object": "list",10    "items": [11      {12        "object": "comment",13        "platform": "tiktok",14        "id": "7137510823549272878",15        "url": null,16        "post_id": "7137423965982592302",17        "parent_id": null,18        "author": {19          "id": "1000000001",20          "handle": "sample_user",21          "name": "Sample User",22          "url": null,23          "avatar_url": null,24          "verified": false25        },26        "text": "Charli Barker",27        "published_at": "2022-08-30T03:47:36Z",28        "stats": {29          "likes": 5161,30          "replies": 46,31          "dislikes": null32        },33        "is_pinned": null,34        "is_by_creator": null,35        "extra": {36          "language": "en",37          "liked_by_creator": false38        }39      },40      {41        "object": "comment",42        "platform": "tiktok",43        "id": "7137825415053853483",44        "url": null,45        "post_id": "7137423965982592302",46        "parent_id": null,47        "author": {48          "id": "1000000001",49          "handle": "sample_user",50          "name": "Sample User",51          "url": null,52          "avatar_url": null,53          "verified": false54        },55        "text": "You’re so pretty Charlie and don’t listen to the other haters you’re an amazing person",56        "published_at": "2022-08-31T00:08:16Z",57        "stats": {58          "likes": 9,59          "replies": 0,60          "dislikes": null61        },62        "is_pinned": null,63        "is_by_creator": null,64        "extra": {65          "language": "en",66          "liked_by_creator": false67        }68      }69    ],70    "cursor": "c20",71    "has_more": true,72    "parent": null73  },74  "cursor": "c20",75  "has_more": true76}

Response#

A list of Comment objects in data.items, with data.cursor and data.has_more.

See Data models for every field. The envelope around data is described in Responses.

Errors#

Failures are free: credits_charged is 0. Branch on error.code, never on the message.

CodeHTTPRetryMeaning
invalid_params400noA parameter is missing, unknown or has the wrong type.
unsupported_url400noThe URL is not one this endpoint accepts (wrong platform or form).
not_found404noThe platform says this profile, post or item does not exist.

Every request can also fail with the account and platform errors listed on the Errors page.