# horrible-api

> Unofficial API to scrap anime from horriblesubs.info

Latest version **1.1.1** (published 2017-11-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install horrible-api
pnpm add horrible-api
yarn add horrible-api
bun add horrible-api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2017-11-17 |
| First published | 2017-05-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >7 |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Kylart |
| Maintainers | kylart |

## Links

- npm: https://www.npmjs.com/package/horrible-api
- Repository: https://github.com/Kylart/HorribleApi
- Homepage: https://github.com/Kylart/horribleApi#readme
- Issues: https://github.com/Kylart/horribleApi/issues
- npm.io page: https://npm.io/package/horrible-api

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^0.16.1
- [cheerio](https://npm.io/package/cheerio.md) ^0.22.0

## Recent versions

- 1.1.1 (latest) — 2017-11-17
- 1.0.5 — 2017-05-22
- 1.0.4 — 2017-05-04
- 1.0.3 — 2017-05-02
- 1.0.2 — 2017-05-02
- 1.0.1 — 2017-05-02
- 1.0.0 — 2017-05-02

## README

# HorribleApi
[![Build Status](https://travis-ci.org/Kylart/HorribleApi.svg?branch=master)](https://travis-ci.org/Kylart/HorribleApi)
 
This is an api allowing one to gather torrents directly from horriblesubs.info in around half a second.

HorribleApi is being developed mainly for KawAnime (rip Nyaa...) but anyone can use it for its own purpose.

Any contribution is welcomed.

# Installation
```
npm install --save horrible-api
```

# Use
```javascript
const horribleApi = require('horrible-api')
 
// Want to get a list of all available anime ?
console.log(horribleApi.getShowsOnly())

// Want to know how many shows are avaible at the moment ?
console.log(horribleApi.getNumberOfShows())

// Want to get the 18 latest releases from Horrible subs ?
const quality = '720p' // Can be 480p, 720p or 1080p. Something else will throw an error.
 
horribleApi.getLatest(quality).then((releases) => {
  console.log(releases)
}).catch((err) => {
  console.log(err)
})
```

```javascript
// Want to get magnets for an anime ?
 
horribleApi.getMagnetsFromAnimeName({
  fromEp: 0,
  untilEp: 500,
  name: 'Absolute Duo',   // Show must in horribleApi.getShowsOnly()
  quality: '720p'  // Can be 480p, 720p or 1080p. Something else will throw an error.
}).then((links) => {
  console.log(links.length)
}).catch((err) => {
  console.log(err)
})
```

# Dev
```
npm test
```


# Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request.

# License

MIT License

Copyright (c) Kylart

---
_Source: https://npm.io/package/horrible-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._