Schemas

Comment

A public comment or reply on a post, with its author, thread position and like/reply counts.

Endpoints

3 endpoints return comments on Rumble, TikTok and YouTube.

Schema

Every endpoint above returns an array of these objects as data, with a page object. The standard meta comes with every response.

FieldTypeDescription
platformstringPlatform ID (tiktok, youtube, …).
idstringPlatform-native comment ID (string; Reddit without t1_).
post_idstringID of the post commented on (equals post.id).
parent_idstring or nullID of the comment this replies to; null for top-level comments.
urlstring (uri) or nullPermalink, when the platform has one.
textstringComment body as plain text.
authorobjectThe commenting account.
author.idstring or nullPlatform-native account ID; null when only the handle is known.
author.usernamestring or nullHandle without the @; null when the account has none.
author.display_namestring or nullDisplay name shown on the profile.
author.urlstring (uri) or nullCanonical profile URL.
author.avatar_urlstring (uri) or nullProfile picture URL. Platform CDN URLs can expire within hours.
author.is_verifiedboolean or nullPlatform verification badge; null where the platform has no badge.
published_atstring (date-time) or nullWhen the comment was posted, RFC 3339 UTC. Where the platform shows only a relative time ("3 weeks ago"), the latest time that label allows (the fetch time minus the stated amount), listed in approximate_fields.
edited_atstring (date-time) or nullWhen the comment was last edited, RFC 3339 UTC; null when never edited or when the platform marks edits without a time (see is_edited).
is_editedboolean or nullThe comment was edited after posting (the platform's edited mark); null when the platform does not say.
is_pinnedboolean or nullPinned by the post's author.
is_liked_by_authorboolean or nullLiked or hearted by the post's author.
is_by_post_authorboolean or nullWritten by the post's author (the creator's own comment, marked as such by the platform).
metricsobjectCounts at fetch time; null = hidden or not exposed, 0 = zero.
metrics.like_countinteger or nullLikes or upvotes; never negative.
metrics.reply_countinteger or nullDirect replies.
platform_specificobjectFields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.
platform_specific.tiktokobject or nullTikTok's own comment fields.
platform_specific.tiktok.languagestring or nullThe comment's language as TikTok detected it, an ISO 639-1 code (en, fr); null when TikTok could not tell (emoji, a name) or does not say.
platform_specific.rumbleobject or nullRumble's own comment fields.
platform_specific.rumble.dislike_countinteger or nullThumbs-down votes on the comment. Exact below 1,000; from 1,000 Rumble shows a label such as "1.31K", taken to be cut to three significant digits as Rumble's other counts are (not checked against an exact count), and listed in approximate_fields.
platform_specific.rumble.author_badgesstring[]The badges Rumble shows beside the commenter's name, by their label as Rumble writes it (seen: Verified, Admin, Moderator, Supporter, Supporter+, Supporter++, Sub, Locals Supporter; new labels may appear). [] when none.
approximate_fieldsstring[]JSON paths of values rounded by the platform or parsed from display text. A list path (external_links) means the list may be incomplete. [] when all exact.
unknown_fieldsstring[]JSON paths of lists whose [] means unknown rather than none (a source that cannot see them); null already means unknown for every other field. [] when every list is known.
platformstring

Platform ID (tiktok, youtube, …).

idstring

Platform-native comment ID (string; Reddit without t1_).

post_idstring

ID of the post commented on (equals post.id).

parent_idstringnullable

ID of the comment this replies to; null for top-level comments.

urlstring urinullable

Permalink, when the platform has one.

textstring

Comment body as plain text.

authorobject

The commenting account.

ShowHide 6 child fields
idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

published_atstring date-timenullable

When the comment was posted, RFC 3339 UTC. Where the platform shows only a relative time ("3 weeks ago"), the latest time that label allows (the fetch time minus the stated amount), listed in approximate_fields.

edited_atstring date-timenullable

When the comment was last edited, RFC 3339 UTC; null when never edited or when the platform marks edits without a time (see is_edited).

is_editedbooleannullable

The comment was edited after posting (the platform's edited mark); null when the platform does not say.

is_pinnedbooleannullable

Pinned by the post's author.

is_liked_by_authorbooleannullable

Liked or hearted by the post's author.

is_by_post_authorbooleannullable

Written by the post's author (the creator's own comment, marked as such by the platform).

metricsobject

Counts at fetch time; null = hidden or not exposed, 0 = zero.

ShowHide 2 child fields
like_countintegernullable

Likes or upvotes; never negative.

reply_countintegernullable

Direct replies.

platform_specificobject

Fields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.

ShowHide 2 child fields
tiktokobjectnullable

TikTok's own comment fields.

ShowHide 1 child field
languagestringnullable

The comment's language as TikTok detected it, an ISO 639-1 code (en, fr); null when TikTok could not tell (emoji, a name) or does not say.

rumbleobjectnullable

Rumble's own comment fields.

ShowHide 2 child fields
dislike_countintegernullable

Thumbs-down votes on the comment. Exact below 1,000; from 1,000 Rumble shows a label such as "1.31K", taken to be cut to three significant digits as Rumble's other counts are (not checked against an exact count), and listed in approximate_fields.

author_badgesstring[]

The badges Rumble shows beside the commenter's name, by their label as Rumble writes it (seen: Verified, Admin, Moderator, Supporter, Supporter+, Supporter++, Sub, Locals Supporter; new labels may appear). [] when none.

approximate_fieldsstring[]

JSON paths of values rounded by the platform or parsed from display text. A list path (external_links) means the list may be incomplete. [] when all exact.

unknown_fieldsstring[]

JSON paths of lists whose [] means unknown rather than none (a source that cannot see them); null already means unknown for every other field. [] when every list is known.

Item errors

Besides the request-level errors every endpoint can return, comment endpoints return:

CodeHTTPRetryMeaningWhat to do
not_found404NoThe item does not exist or was deleted.Check the URL or ID; do not retry.
private_or_unavailable403NoThe item exists but is private, age- or region-gated, or requires a login to view. It shares 403 with forbidden (which is about the key): branch on the code.Only public items can be fetched; do not retry.

Last updated