FIREANIME API
Browse API97 operations
POST

ListEpisodeComments

ListEpisodeComments returns root comments using an opaque cursor.

/api.v1.comment.CommentService/ListEpisodeComments Bearer optional
01

Request

ListEpisodeCommentsRequest

ListEpisodeCommentsRequestapi.v1.comment.ListEpisodeCommentsRequest5 fields

List Episode Comments Request message.

episodeId
uint32

Episode Id value.

sort
string

top or newest

language
string

all or a BCP-47 language preference. Preferred-language comments rank first.

cursor
string

Cursor value.

limit
int32

Limit value.

Request JSON
{
  "episodeId": 1,
  "sort": "string",
  "language": "de",
  "cursor": "string",
  "limit": 20
}
02

Response

ListEpisodeCommentsResponse

ListEpisodeCommentsResponseapi.v1.comment.ListEpisodeCommentsResponse4 fields

List Episode Comments Response message.

dataarray
EpisodeComment[]

Data value.

nextCursor
string

Next Cursor value.

hasMore
bool

Has More value.

totalResults
int32

Total Results value.

Example response
{
  "data": [
    {
      "id": 1,
      "episodeId": 1,
      "authorId": 1,
      "author": {
        "id": 1,
        "username": "fireanime_user",
        "avatarUrl": "/anime/frieren"
      },
      "parentCommentId": 1,
      "replyToCommentId": 1,
      "replyTo": {
        "id": 1,
        "authorId": 1,
        "authorUsername": "fireanime_user",
        "excerpt": "string value"
      },
      "content": "Example content"
    }
  ],
  "nextCursor": "string value",
  "hasMore": true,
  "totalResults": 1
}
03

Referenced models

3 nested message types

EpisodeCommentapi.v1.comment.EpisodeComment20 fields

Episode Comment message.

id
uint32

Id value.

episodeId
uint32

Episode Id value.

authorId
uint32

Author Id value.

author
CommentAuthor

Author value.

parentCommentIdoptional
uint32

Parent Comment Id value.

replyToCommentIdoptional
uint32

Reply To Comment Id value.

replyTooptional
CommentReference

Reply To value.

content
string

Content value.

likeCount
int32

Like Count value.

replyCount
int32

Reply Count value.

isHidden
bool

Is Hidden value.

language
string

Language value.

spoilerScope
string

Spoiler Scope value.

timestampSecondsoptional
int32

Timestamp Seconds value.

createdAt
string

Created At value.

updatedAt
string

Updated At value.

viewerHasLiked
bool

Viewer Has Liked value.

canEdit
bool

Can Edit value.

canDelete
bool

Can Delete value.

permalink
string

Permalink value.

CommentAuthorapi.v1.comment.CommentAuthor3 fields

Comment Author message.

id
uint32

Id value.

username
string

Username value.

avatarUrl
string

Avatar Url value.

CommentReferenceapi.v1.comment.CommentReference4 fields

Comment Reference message.

id
uint32

Id value.

authorId
uint32

Author Id value.

authorUsername
string

Author Username value.

excerpt
string

Excerpt value.

04

Error handling

Common failure codes

unauthenticatedThe Bearer token is missing or invalid.

invalid_argumentThe request payload failed validation.

internalThe service could not complete the operation.