Pular para o conteúdo

Listar os posts de uma comunidade

GET/v1/communities/{id}/posts

Retorna os posts de uma comunidade com ordenação e filtros, ou os posts que correspondem a uma busca.

Requisição

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

Parâmetros

  • id

    caminhoobrigatório

    ID do item, um UUID.

    texto

  • sort

    consultaopcional

    Ordem dos resultados.

    texto

    Valores permitidoshotnewtoprising

    Padrão: hot

  • period

    consultaopcional

    Janela de tempo para a ordenação por melhores.

    texto

    Valores permitidosdayweekmonthyearall

    Padrão: week

  • cursor

    consultaopcional

    O valor de nextCursor da página anterior. Omita-o na primeira página.

    texto

  • limit

    consultaopcional

    Quantos itens retornar em uma página.

    número inteiro

    De 1 a 25Padrão: 25

  • flairId

    consultaopcional

    Apenas posts com este flair.

    texto (uuid)

  • filter

    consultaopcional

    media para posts com imagens, units para posts sobre um episódio ou capítulo.

    texto

    Valores permitidosmediaunits
  • q

    consultaopcional

    Texto a buscar.

    texto

Resposta

Uma requisição bem-sucedida responde 200 com este JSON:

  • itemslista de objeto
    • idtexto (uuid)
    • slugtexto
    • communityobjeto
      • idtexto (uuid)
      • slugtexto
      • languagetexto
      • kindtexto
        Valores permitidosworkboarduser
      • nametexto
      • iconUrltexto (uri)pode ser null
      • themetexto
        Valores permitidosvioletblueskycyanemeraldgreenyellowamberrosepink
      • isSampletrue ou false
    • authorobjetopode ser null
      • usernametexto
      • displayNametexto
      • avatarUrltexto (uri)pode ser null
    • authorFlairtextopode ser null
    • kindtexto
      Valores permitidostextlinkimagepoll
    • titletextopode ser null
    • excerpttextopode ser null
    • flairobjetopode ser null
      • idtexto (uuid)
      • labeltexto
      • tonetexto
        Valores permitidosneutralaccentsuccesswarningdangervioletblueskycyanemeraldgreenyellowamberrosepink
    • spoilerobjetopode ser null
      • workTitletextopode ser null
      • unitNumbernúmeropode ser null

        No mínimo 0

    • workobjetopode ser null
      • idtexto (uuid)
      • titletexto
      • mediumtexto
        Valores permitidosanimedonghuaanimationmangamanhwamanhuawebtoon
      • slugtexto
      • unitNumbernúmeropode ser null

        No mínimo 0

    • isAdulttrue ou false
    • isPinnedtrue ou false
    • isLockedtrue ou false
    • scorenúmero inteiropode ser null

      De -9007199254740991 a 9007199254740991

    • commentCountnúmero inteiro

      De 0 a 9007199254740991

    • reactionslista de objeto
      • kindtexto
        Valores permitidoslovelaughwowsadclapfirethinkangrypartycry
      • countnúmero inteiro

        De 0 a 9007199254740991

    • linkobjetopode ser null
      • urltexto (uri)
      • hosttexto
      • titletextopode ser null
      • descriptiontextopode ser null
      • imageobjetopode ser null
        • urltexto (uri)
        • widthnúmero inteiro

          De 0 a 9007199254740991

        • heightnúmero inteiro

          De 0 a 9007199254740991

        • alttextopode ser null
        • variantWidthslista de número inteiro

          De 0 a 9007199254740991

      • isPendingtrue ou false
    • imageslista de objeto
      • urltexto (uri)
      • widthnúmero inteiro

        De 0 a 9007199254740991

      • heightnúmero inteiro

        De 0 a 9007199254740991

      • alttextopode ser null
      • variantWidthslista de número inteiro

        De 0 a 9007199254740991

    • pollobjetopode ser null
      • optionslista de objeto
        • idtexto (uuid)
        • labeltexto
        • voteCountnúmero inteiropode ser null

          De 0 a 9007199254740991

      • totalVotesnúmero inteiro

        De 0 a 9007199254740991

      • closesAttexto (date-time)
      • isClosedtrue ou false
      • allowsMultipletrue ou false
    • createdAttexto (date-time)
    • editedAttexto (date-time)pode ser null
  • nextCursortextopode ser null

Erros

Como toda operação, esta pode responder 400 para parâmetros inválidos, 404 quando nada é encontrado e 429 quando você envia requisições demais. Todos os erros compartilham o mesmo formato.

Leia sobre erros