Skip to content

List comments

GET/v1/posts/{id}/comments

Returns a post's comment tree page by page, with sorting, an episode filter, a single thread or a text search.

Request

Shell
curl -g "https://api.nogitsu.com/v1/posts/{id}/comments"

Parameters

  • id

    pathrequired

    Id of the item, a UUID.

    text

  • sort

    queryoptional

    Order of the results.

    text

    Allowed valuesbestnewoldcontroversialunit

    Default: best

  • unit

    queryoptional

    Only comments about this episode or chapter number, or general for comments not tied to one.

    one of several shapes

  • thread

    queryoptional

    Only the thread under this comment.

    text (uuid)

  • q

    queryoptional

    Text to search for.

    text

  • cursor

    queryoptional

    The nextCursor value from the previous page. Leave it out for the first page.

    text

Answer

A successful request answers 200 with this JSON:

  • itemslist of __schema0
    • idtext (uuid)
    • authorobjectcan be null
      • usernametext
      • displayNametext
      • avatarUrltext (uri)can be null
    • authorFlairtextcan be null
    • authorProgressobjectcan be null
      • trackingStatustext
        Allowed valuesplannedcurrentcompletedpauseddroppedrewatching
      • progressUnitsnumbercan be null

        At least 0

      • progressTotalwhole numbercan be null

        From 0 to 9007199254740991

    • statetext
      Allowed valuespublishedremoveddeleted
    • bodyobjectcan be null
      • blockslist of one of several shapes

        1. Option 1

          • typetext
            Allowed valuesparagraph
          • childrenlist of any value

        2. Option 2

          • typetext
            Allowed valuesheading
          • childrenlist of any value

        3. Option 3

          • typetext
            Allowed valuesquote
          • childrenlist of RichTextBlock

        4. Option 4

          • typetext
            Allowed valueslist
          • isOrderedtrue or false
          • itemslist of list of any value

        5. Option 5

          • typetext
            Allowed valuescode
          • texttext
    • hasSpoilertrue or false
    • unitNumbernumbercan be null

      At least 0

    • sourceSpoilerobjectcan be null
      • kindtext
        Allowed valuesmangamanhwamanhuawebtoonnovelother
      • unitnumbercan be null

        At least 0

    • imageslist of object
      • urltext (uri)
      • widthwhole number

        From 0 to 9007199254740991

      • heightwhole number

        From 0 to 9007199254740991

      • alttextcan be null
      • variantWidthslist of whole number

        From 0 to 9007199254740991

    • linkobjectcan be null
      • urltext (uri)
      • hosttext
      • titletextcan be null
      • descriptiontextcan be null
      • imageobjectcan be null
        • urltext (uri)
        • widthwhole number

          From 0 to 9007199254740991

        • heightwhole number

          From 0 to 9007199254740991

        • alttextcan be null
        • variantWidthslist of whole number

          From 0 to 9007199254740991

      • isPendingtrue or false
    • scorewhole numbercan be null

      From -9007199254740991 to 9007199254740991

    • reactionslist of object
      • kindtext
        Allowed valueslovelaughwowsadclapfirethinkangrypartycry
      • countwhole number

        From 0 to 9007199254740991

    • isByPostAuthortrue or false
    • isByModeratortrue or false
    • createdAttext (date-time)
    • editedAttext (date-time)can be null
    • depthwhole number

      From 0 to 9007199254740991

    • replyCountwhole number

      From 0 to 9007199254740991

    • replieslist of __schema0
  • nextCursortextcan be null

Errors

Like every operation, this one can answer 400 for invalid parameters, 404 when nothing is found and 429 when you send too many requests. All errors share one shape.

Read about errors