https://github.com/mssjim/crunchyroll.js

A nodejs crunchyroll api
https://github.com/mssjim/crunchyroll.js

anime crunchyroll crunchyroll-api crunchyroll-beta nodejs scraper

Last synced: about 1 month ago
JSON representation

A nodejs crunchyroll api

• Host: GitHub
• URL: https://github.com/mssjim/crunchyroll.js
• Owner: Mssjim
• License: mit
• Created: 2022-05-01T01:14:42.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-03T20:34:22.000Z (9 months ago)
• Last Synced: 2024-10-28T22:11:48.389Z (about 2 months ago)
• Topics: anime, crunchyroll, crunchyroll-api, crunchyroll-beta, nodejs, scraper
• Language: JavaScript
• Homepage:
• Size: 113 KB
• Stars: 11
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  


  


    

  

  


  


    

    

    

    

  



## About

crunchyroll.js is an npm module that allows you to easily access the Crunchyroll API.

## Warning

This project is not affiliated with or endorsed by Crunchyroll. The use of this project may violate the terms of service between you and stream provider. Use with caution and at your own risk.

## Installation 

```bash

npm i crunchyroll.js

```

## Basic Usage

```js

const cr = require('crunchyroll.js');

(async () => {

    // Login to crunchyroll

    await cr.login(email, password);

    // Get anime info

    const anime = await cr.getAnime("GY9PJ5KWR"); // "Naruto"

    

    // Get anime seasons and eps

    const { items: seasons } = await cr.getSeasons(anime.id);

    const eps = await cr.getEpisodes(seasons[0].id);

})();

```

## Examples

• Change default language

```js

await cr.login(email, password, "pt-BR");

```

• Get user profile

```js

const profile = await cr.getProfile();

```

• Search anime/episode/movie

```js

const search = await cr.search("naruto");

```

• Get anime info

```js

const categories = await cr.getCategories("[anime-id]");

const rate = await cr.getRate("[anime-id]");

const similar = await cr.getSimilar("[anime-id]", 10);

```

• Get NewsFeed

```js

const newsFeed = await cr.getNewsFeed();

console.log(newsFeed.latest_news.items[0]); // Log the latest

```

• Get last updated animes list

```js

// Get last 10 animes

const { items } = await cr.getAllAnimes(0, 10, "newly_added");

// Log animes title

console.log(items.map(anime => anime.title));

```

• Basic episodes counting system by anime seasons

```js

const anime = await cr.getAnime("GY9PJ5KWR");

const { items: seasons } = await cr.getSeasons(anime.id);

console.log(`${anime.title} Seasons:`);

for(season of seasons) {

    const episodes = await cr.getEpisodes(season.id);

    console.log(`${season.title}: ${episodes.total} eps`);

}

```

## Contributing - bug fixes

Contributions are welcome! Please feel free to open an issue or submit a pull request, for bug fixes or new features.

1. Fork the repository

2. Create a new branch `git checkout -b `

3. Make the changes

4. Commit the changes `git commit -am "Add new feature"`

5. Push the changes `git push origin `

6. Create a pull request on GitHub

Many thanks!