Pular para o conteúdo

Listar obras

GET/v1/works

Retorna obras página por página, ordenadas por popularidade, nota, mais recentes ou mais próximas. Filtre a lista por mídia, gênero, temporada, status de lançamento ou sentido de leitura.

Requisição

Shell
curl "https://api.nogitsu.com/v1/works?medium=anime&limit=3"

Parâmetros

  • medium

    consultaopcional

    Apenas obras desta mídia.

    texto

    Valores permitidosanimedonghuaanimationmangamanhwamanhuawebtoon
  • releaseStatus

    consultaopcional

    Apenas obras com este status de lançamento.

    texto

    Valores permitidosnot_yet_releasedreleasingfinishedhiatuscancelledunknown
  • readingDirection

    consultaopcional

    Apenas obras lidas neste sentido.

    texto

    Valores permitidosrtlltrvertical_scroll
  • genre

    consultaopcional

    Apenas obras com este gênero, pelo slug.

    texto

  • hasBanner

    consultaopcional

    true para apenas obras que têm imagem de banner.

    texto

  • hasTrailer

    consultaopcional

    true para apenas obras que têm trailer.

    texto

  • minCoverWidth

    consultaopcional

    Apenas obras cuja capa tem pelo menos esta largura em pixels.

    número inteiro

    De 1 a 10000

  • season

    consultaopcional

    Apenas obras que começaram nesta temporada.

    texto

    Valores permitidoswinterspringsummerfall
  • seasonYear

    consultaopcional

    Ano da temporada; use junto com season.

    número inteiro

    De 1900 a 2100

  • sort

    consultaopcional

    Ordem dos resultados.

    texto

    Valores permitidospopularityscorenewestsoonest

    Padrão: popularity

  • limit

    consultaopcional

    Quantos itens retornar em uma página.

    número inteiro

    De 1 a 50Padrão: 20

  • cursor

    consultaopcional

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

    texto

  • language

    consultaopcional

    Código de idioma de duas letras para os textos da resposta, como en ou tr. Omita-o para inglês.

    texto

    Padrão: en

Resposta

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

  • itemslista de objeto
    • idtexto (uuid)
    • slugtexto
    • mediumtexto
      Valores permitidosanimedonghuaanimationmangamanhwamanhuawebtoon
    • publicationFormattexto
      Valores permitidostvtv_shortmovieovaonaspecialmusicserializedone_shotdoujinlight_novelweb_novel
    • releaseStatustexto
      Valores permitidosnot_yet_releasedreleasingfinishedhiatuscancelledunknown
    • readingDirectiontextopode ser null
      Valores permitidosrtlltrvertical_scroll
    • primaryTitletexto
    • englishTitletextopode ser null
    • nativeTitletextopode ser null
    • romanizedTitletextopode ser null
    • contentRatingtexto
      Valores permitidosunknownall_agesteenmatureadult
    • seasontextopode ser null
      Valores permitidoswinterspringsummerfall
    • seasonYearnúmero inteiropode ser null

      De -9007199254740991 a 9007199254740991

    • startDatetexto (date)pode ser null
    • totalUnitsnúmero inteiropode ser null

      De -9007199254740991 a 9007199254740991

    • aggregateScorenúmero inteiropode ser null

      De 0 a 1000

    • scoreRanknúmero inteiropode ser null

      De 0 a 9007199254740991

    • popularityRanknúmero inteiropode ser null

      De 0 a 9007199254740991

    • audienceSizenúmero inteiropode ser null

      De 0 a 9007199254740991

    • coverobjetopode ser null
      • urltexto (uri)
      • widthnúmero inteiropode ser null

        De 0 a 9007199254740991

      • heightnúmero inteiropode ser null

        De 0 a 9007199254740991

      • blurhashtextopode ser null
      • providertextopode ser null
        Valores permitidosanime_offline_databaseanimapanilistmyanimelistanidbanime_news_networkanime_filler_listkitsuanime_planetanisearchtvdbimdbtmdbsimklmangaupdatesmangabakawikipedia
      • variantWidthslista de número inteiro

        De 0 a 9007199254740991

    • bannerobjetopode ser null
      • urltexto (uri)
      • widthnúmero inteiropode ser null

        De 0 a 9007199254740991

      • heightnúmero inteiropode ser null

        De 0 a 9007199254740991

      • blurhashtextopode ser null
      • providertextopode ser null
        Valores permitidosanime_offline_databaseanimapanilistmyanimelistanidbanime_news_networkanime_filler_listkitsuanime_planetanisearchtvdbimdbtmdbsimklmangaupdatesmangabakawikipedia
      • variantWidthslista de número inteiro

        De 0 a 9007199254740991

    • trailerobjetopode ser null
      • hosttexto
        Valores permitidosyoutube
      • keytexto
    • primaryStudiotextopode ser null
    • genreslista de objeto
      • slugtexto
      • labeltexto
    • contentWarningslista de texto
      Valores permitidosviolencegoresexual-contentsuicide
    • descriptionobjetopode ser null
      • texttexto
      • languagetexto
      • isMachineGeneratedtrue ou false
    • sourceUrltexto (uri)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