Mangadex-api

This is Mangadex website api wrapper.

Additional resources

• mangadex-heroku is a GraphQL public endpoint.
  Supports caching (in memory) and all public MD-API's that doesn't require authorization. (playground)
• Example webapp that uses mangadex-heroku for API calls.

Installation

npm i mangadex-api

# or

yarn add mangadex-api

Example

const { Mangadex } = require('mangadex-api')

Mangadex.manga.getManga(22723).then((manga) => {
  console.log(`Manga ${manga.title} has ${manga.follows} followers`)

  Mangadex.manga.getMangaChapters(22723).then(({ chapters, groups }) => {
    console.log(`Manga ${manga.title} has ${chapters.length} chapters`)
    console.log(`Manga ${manga.title} has ${groups.length} scanlated groups`)
  })
})

Mangadex.chapter.getChapter(8857).then((chapter) => {
  console.log(
    `Chapter title is "${chapter.title}" and it is ${chapter.chapter} chapter from ${chapter.volume} volume.`
  )
})

// currently requires authorization
Mangadex.search('senko').then((response) => {
  console.log(`Found ${response.titles.length} titles.`)
})


// Search with NSFW results
Mangadex.search({
  title: 'gotoubun',
  with_hentai: true
}).then(result => {
  console.log(`Found ${result.titles.filter(title => title.is_hentai).length} hentai manga (☞ ͡ ͡° ͜ ʖ ͡ ͡°)☞`)
})

Mangadex.getHome().then((home) => {
  if (home.accouncement) {
    console.log(`New accouncement!\n${home.accouncement.text}`)
  }
  console.log(
    `Todays top manga by follows is: ${home.top_manga.follows[0].title}`
  )
  console.log(
    `Todays top chapter is from manga: ${home.top_chapters.day[0].title}`
  )
  console.log(
    `Latest chapter is from manga: ${home.latest_updates.all[0].title}`
  )
})

Mangadex.group.getGroup(12).then((group) => {
  console.log(
    `Group ${group.name} has ${group.stats.follows} followers and ${group.stats.total_chapters} total chapters uploaded!`
  )
})

Authorization example

const { Mangadex } = require('mangadex-api')

const client = new Mangadex()

await client.agent.login('username', 'password', false)

const result = await client.search('To Be Winner')

console.log(result) // { titles: [{ title: 'To Be Winner', ... }] }

Cached session example

// first you must save your session somewhere

await client.agent.login('username', 'password', false)

await client.agent.saveSession('/path/to/session'))

// now we can use it

await client.agent.loginWithSession('/path/to/session')

const me = await client.getMe())

console.log(me)

Migration to version 4

Main focuses in V4 were Typescript and Mangadex API V2.

So V1 support was dropped completely. If you still, for some reason, want to use API V1 then use agent.callApi(endpoint, { baseUrl: 'https://mangadex.org/api' }) code snippet to request data from API V1.

So there're new api groups:

• chapter/{id|hash}
• follows
• group/{id}
  • group/{id}/chapters
• manga/{id}
  • manga/{id}/chapters
  • manga/{id}/covers
• relations
• tag
• tag/{id}
• user/{id}
  • user/{id}/chapters
  • user/{id}/followed-manga
  • user/{id}/followed-updates
  • user/{id}/manga/{mangaId}
  • user/{id}/ratings
  • user/{id}/settings
• user/{id}/marker

Each of them is available on Mangadex instance via these properties:

const client = new Mangadex()

// don't forget to login
await client.agent.login(username, password)

// and here we go

// chapter/{id|hash}
client.chapter.getChapter(chapterId)

// follows
client.getFollows()

// group/{id}
client.group.getGroup(groupId)

// group/{id}/chapters
client.group.getGroupChapters(groupId)

// manga/{id}
client.manga.getManga(mangaId)

// manga/{id}/chapters
client.manga.getMangaChapters(mangaId)

// manga/{id}/covers
client.manga.getMangaCovers(mangaId)

// relations
client.getRelations()

// tag
client.tag.getTags()

// tag/{id}
client.tag.getTag(tagId)

// user/{id}
client.user.getUser(userId)

// user/{id}/chapters
client.user.getUserChapters(userId)

// user/{id}/followed-updates
client.user.getUserFollowedUpdates(userId)

// user/{id}/manga/{mangaId}
client.user.getUserManga(userId, mangaId)

// user/{id}/ratings
client.user.getUserRatings(userId)

// user/{id}/settings
client.user.getUserSettings(userId)

// user/{id}/followed-manga
client.user.getUserFollowedManga(userId)

// user/{id}/marker
client.user.setUserChapterRead(userId, chapters, read)

Migration to version 3

LRU cache was removed from package, so you'll have to implement caching by yourself.

Mangadex constructor now accepts only 2 options.

getManga and getChapter lost normalize argument, now it's on by default.

API

API section is available on the website.

---

Contact

My telegram and a group where you can ask your questions or suggest something.