<img src="./hanime-crave.png" />

# hanime-crave

Craving for some dope hentai scraper? Well here it is, a damn hanime.tv scraper!

## Author

Nickname: Chizz3x

Social:
* Discord: https://discord.gg/zG83r6M
* Patreon: https://www.patreon.com/Milim

## IMPORTANT NOTICE!

Take a note that I am not responsible for your actions and how you use this scraper. Therefore if you get banned for spamming over the site it is your own fault. Use this scraper at your own risk and don't fuck up such an awesome hentai streaming site, thanks.

## Documentation

### Including module:
```js
const hac = require('hanime-crave');
```

### Getting all the good stuff:

##### Useful info:
* Page numbers start from 0
* \* - variables marked with this are optional

---

### > Getting => Streams
```js
hac.streams(*string<episode_link>)
```

#### Output:
<details>
<summary>{Object}</summary>
<p>

```js
HentaiEpisodeInfo {
  title: {
    name: 'Aku no Onna Kanbu: Full Moon Night R 1',
    slug: 'aku-no-onna-kanbu-full-moon-night-r-1'
  },
  created: { date: '2020-10-05T08:42:24.837Z', unix: 1601887344 },
  released: { date: '2020-10-02T15:44:52.000Z', unix: 1601653492 },
  description: 'How could this "special training" be in such a beautiful beach location? There is no way this is actual training.',
  views: 2475509,
  interests: 127662,
  artwork: {
    poster: 'https://i1.wp.com/static-assets.droidbuzz.top/images/posters/aku-no-onna-kanbu-full-moon-night-r-1-pv1.png?quality=100',
    cover: 'https://i1.wp.com/static-assets.droidbuzz.top/images/covers/aku-no-onna-kanbu-full-moon-night-r-1-cv1.png?quality=100'
  },
  brand: 'Bunnywalker',
  censored: true,
  rates: { likes: 12862, dislikes: 145 },
  downloads: 70634,
  banned_in: 'JP',
  tags: [
    'hand job',   'censored',
    'x-ray',      'swimsuit',
    'hd',         'creampie',
    'big boobs',  'facial',
    'public sex', 'blow job',
    'harem',      'fantasy'
  ],
  streams: [
    HentaiVideo {
      url: 'https://weeb.hanime.tv/weeb-api-cache/api/v8/m3u8s/55693.m3u8',
      width: 1920,
      height: 1080,
      duration: 963000
    },
    ...
  ]
}
```

</p>
</details>

---

### > Getting => Trending:
```js
hac.trending({*page: integer<page_number>, *sort: string<sort_type>})
```
#### sort_type:
> Options: `year`, `6_month`, `3_month`, `month`, `week`, `day`

#### Output:
<details>
<summary>{Object}</summary>
<p>

```js
{
  episodes: [
    HentaiEpisode {
      title: {
        name: "Oujo & Onna Kishi W Dogehin Roshutsu: Chijoku no Misemono Dorei 1",
        slug: "oujo-onna-kishi-w-dogehin-roshutsu-chijoku-no-misemono-dorei-1"
      },
      created: {
        date: "2020-09-03T05:55:21.329Z",
        unix: 1599112521
      },
      released: {
        date: "2020-08-27T15:44:23.000Z",
        unix: 1598543063
      },
      views: 1889868,
      interests: 121236,
      artwork: {
        poster: "https://i1.wp.com/static-assets.droidbuzz.top/images/posters/oujo-onna-kishi-w-dogehin-roshutsu-chijoku-no-misemono-dorei-1-pv1.png?quality=100",
        cover: "https://i1.wp.com/static-assets.droidbuzz.top/images/covers/oujo-onna-kishi-w-dogehin-roshutsu-chijoku-no-misemono-dorei-1-cv1.png?quality=100"
      },
      brand: "White Bear",
      censored: true,
      rates: {
        likes: 10044,
        dislikes: 451
      },
      downloads: 76396,
      banned_in: "JP",
      episode: "https://hanime.tv/videos/hentai/oujo-onna-kishi-w-dogehin-roshutsu-chijoku-no-misemono-dorei-1",
      getStreams: [Function]
    },
    ...
  ],
  query: {
    page: 0,
    sort: "month"
  },
  next: [Function]
}
```

</p>
</details>

---

### > Getting => Random
```js
hac.random(*integer<seed>)
```

#### Output:
<details>
<summary>{Object}</summary>
<p>

```js
{
  info: { total: 23, seed: 39067655824 },
  episodes: [
    HentaiEpisode {
      title: {
        name: 'Nee, Chanto Shiyouyo! 4',
        slug: 'nee-chanto-shiyouyo-4'
      },
      created: { date: '2014-05-29T13:58:40.000Z', unix: 1401371920 },
      released: { date: '2007-05-25T00:01:08.000Z', unix: 1180051268 },
      views: 496374,
      interests: 786360,
      artwork: {
        poster: 'https://i1.wp.com/git-posters.pages.dev/images/nee-chanto-shiyouyo-4.jpg?quality=100',
        cover: 'https://i1.wp.com/git-covers.pages.dev/images/nee-chanto-shiyouyo-4.jpg?quality=100'
      },
      brand: 'MediaBank',
      censored: true,
      rates: { likes: 3174, dislikes: 44 },
      downloads: 28289,
      banned_in: 'JP',
      episode: 'https://hanime.tv/videos/hentai/nee-chanto-shiyouyo-4',
      getStreams: [Function]
    },
    ...
  ]
}
```

</p>
</details>

---

### > Getting => Seasons
```js
hac.seasons({*order: {by: string<order_by>, type: string<order_type>}, start: string<Date>, end: string<Date>})
```

#### order.type:
> Options: `DESC`, `ASC`

#### order.by:
> Options: `released_at`, ..?

#### start & end:
> Format: `YYYY-MM-DD`

#### Output:
<details>
<summary>{Object}</summary>
<p>

```js
{
  info: { total: 97, count: 97 },
  episodes: [
    HentaiEpisode {
      title: {
        name: 'Succubus Appli: Gakuen Saimin 2',
        slug: 'succubus-appli-gakuen-saimin-2'
      },
      created: { date: '2021-10-04T14:42:17.588Z', unix: 1633358537588 },
      released: { date: '2021-09-30T15:47:56.000Z', unix: 1633016876000 },
      views: 1563452,
      interests: 91358,
      artwork: {
        poster: 'https://i1.wp.com/ba.alphafish.top/images/posters/succubus-appli-gakuen-saimin-2-pv1.png?quality=100',
        cover: 'https://i1.wp.com/ba.alphafish.top/images/covers/succubus-appli-gakuen-saimin-2-cv1.png?quality=100'
      },
      brand: 'Queen Bee',
      censored: null,
      rates: { likes: 9684, dislikes: 127 },
      downloads: 47055,
      banned_in: '',
      episode: 'https://hanime.tv/videos/hentai/succubus-appli-gakuen-saimin-2',
      getStreams: [Function]
    },
    ...
  ],
  query: {
    order: { by: 'released_at', type: 'DESC' },
    start: '2021-01-01',
    end: '2022-01-01'
  }
}
```

</p>
</details>

---

### > Getting => Tags
```js
hac.tag({tag: string<tag>, *page: integer<page_number>, *order: string<order_type>})
```

#### order:
> Options: `DESC`, `ASC`

#### Output:
<details>
<summary>{Object}</summary>
<p>

```js
{
  episodes: [
    HentaiEpisode {
      title: { name: 'Ishuzoku Reviewers 6', slug: 'ishuzoku-reviewers-6' },
      created: { date: '2021-09-21T14:28:25.976Z', unix: 1632234505 },
      released: { date: '2020-02-14T15:47:51.000Z', unix: 1581695271 },
      views: 480615,
      interests: 28200,
      artwork: {
        poster: 'https://i1.wp.com/ba.alphafish.top/images/posters/ishuzoku-reviewers-6-pv1.png?quality=100',
        cover: 'https://i1.wp.com/ba.alphafish.top/images/covers/ishuzoku-reviewers-6-cv1.png?quality=100'
      },
      brand: 'Passione',
      censored: true,
      rates: { likes: 1471, dislikes: 94 },
      downloads: 5002,
      banned_in: 'JP',
      episode: 'https://hanime.tv/videos/hentai/ishuzoku-reviewers-6',
      getStreams: [Function]
    },
    ...
  ],
  query: { page: 0, order: 'desc' },
  next: [Function]
}
```

</p>
</details>

---

### > Getting => Search
```js
hac.search({text: string<search_query>, *brands: string[]<brands>, *blacklist: string[]<blacklists>, *tags: string[]<tags>, *tags_mode: string<tags_mode>, *page: integer<page_number>, order: string<order>})
```

#### tags_mode:
> Options: `OR`, `AND`

#### order:
> Options: `DESC`, `ASC`

#### Output:
<details>
<summary>{Object}</summary>
<p>

```js
{
  episodes: [
    HentaiEpisode {
      title: {
        name: 'Soshite Watashi wa Sensei ni... 1',
        slug: 'soshite-watashi-wa-sensei-ni-1'
      },
      created: { date: 1633815833, unix: undefined },
      released: { date: 1632412078, unix: undefined },
      views: 375040,
      interests: 28136,
      artwork: {
        poster: 'https://i1.wp.com/ba.alphafish.top/images/posters/soshite-watashi-wa-sensei-ni-1-pv1.png?quality=100',
        cover: 'https://i1.wp.com/ba.alphafish.top/images/covers/soshite-watashi-wa-sensei-ni-1-cv1.png?quality=100'
      },
      brand: 'nur',
      censored: true,
      rates: { likes: 2499, dislikes: 94 },
      downloads: 10846,
      banned_in: undefined,
      episode: 'https://hanime.tv/videos/hentai/soshite-watashi-wa-sensei-ni-1',
      getStreams: [Function]
    },
    ...
  ],
  query: { page: 0, maxPages: 59, totalHits: 2785, hitsPerPage: 48, tags: [] },
  next: [Function]
}
```

</p>
</details>