Skip to main content
GET
List comments

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

item
string

Item selector: a natural key such as youtube:dQw4w9WgXcQ, or the item URL

Required string length: 1 - 2048
sort
enum<string>
default:top

Comment ordering

Available options:
top,
newest
cursor
string

Opaque cursor from a previous page

maxAge
string
default:15m

How fresh a stored page may be; default 15m

Pattern: ^(0|[1-9][0-9]{0,5}[mhd])$

Response

One page of item comments

object
string
required
Allowed value: "list"
data
object[]
required
Maximum array length: 100
page
object
required
total
integer | null
required
Required range: 0 <= x <= 9007199254740991
totalApproximate
boolean | null
required
account
object | null
required
observedAt
string
required
Pattern: ^\d{4}-(0[1-9]|1[0-2])-([0-2]\d|3[01])T([01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d{1,9})?(?:Z|[+-](?:[01]\d|2[0-3]):[0-5]\d)$
cached
boolean
required
usage
object
required