Live Data

List Video Comments

Fetches the comments on a video, in the platform's own order.

PlatformPer pageOrderNotes
TikTokup to 30TikTok's rankingcommenter country and comment language are filled here only
Instagramabout 15newest firstreply counts can be null
YouTube20top commentsonly a comment's age is published ("8 days ago"), so commented_at is approximate
Facebook10most relevantlikes are the sum of all reactions
Snapchatabout 20, one pagetop commentsno commenter usernames

Replies are counted, not listed. Fields a platform does not publish are null. region has no effect on this route. A pageToken on a platform that has one page returns an empty page and is not charged.

Optional live endpoint. You do not need this endpoint for normal API integrations; prefer tracked accounts, tracked videos, analytics, projects, and Creator Hub endpoints when working with viral.app data.

⚠️ Consumes extra credits: 3 credits per request. Additional charges may apply.

Headers:

  • X-Viral-Credits-Consumed
  • X-Viral-Credits-Meter
  • X-Viral-Credits-Benefited-Remaining
  • X-Viral-Credits-Can-Purchase-Extra
  • Retry-After (on 429 responses)

A page past the only one of a one-page lookup costs nothing: it carries X-Viral-Credits-Consumed: 0 and X-Viral-Credits-Meter, without the two balance headers.

get/live/{platform}/videos/{platformVideoId}/comments

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/live/{platform}/videos/{platformVideoId}/comments
  • Auth: API key in header x-api-key

Path parameters

platform'facebook' | 'instagram' | 'tiktok' | 'youtube' | 'snapchat' required

Social media platform (facebook, instagram, tiktok, youtube, snapchat)

Example:facebook
platformVideoIdstring required

Native platform video id found in the URL of the video

Example:7123456789012345678

Query parameters

pageTokenstring nullable

Opaque cursor token used to fetch the next page

Example:v2:eyJvZmZzZXQiOjIwLCJsaW1pdCI6MjB9
regionstring nullable

Region code (2-letter ISO country code)

Example:US

Response

OK

nextPageTokenstring nullable required

Example response

{
  "comments": [
    {
      "platform": "facebook",
      "platform_video_id": "7123456789012345678",
      "commenter_avatar_url": "https://www.myproject.com",
      "commenter_country_code": "US",
      "share_url": "https://www.myproject.com"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.