# coolmoviez-api

> Unofficial api for coolmoviez.shop

Latest version **1.0.5** (published 2021-03-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install coolmoviez-api
pnpm add coolmoviez-api
yarn add coolmoviez-api
bun add coolmoviez-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.0.5 |
| Published | 2021-03-14 |
| First published | 2021-03-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 6 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Author | Linc Codes |
| Maintainers | linccodes |
| Keywords | movies, api, coolmoviez, freemovies, movieapi, coolmovie, coolmovies |

## Links

- npm: https://www.npmjs.com/package/coolmoviez-api
- Repository: https://github.com/LincCodes/coolmoviez-api
- Issues: https://github.com/LincCodes/coolmoviez-api/issues
- npm.io page: https://npm.io/package/coolmoviez-api

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^0.21.1
- [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.5

## Recent versions

- 1.0.5 (latest) — 2021-03-14
- 1.0.4 — 2021-03-14
- 1.0.3 — 2021-03-11
- 1.0.2 — 2021-03-11
- 1.0.1 — 2021-03-11
- 1.0.0 — 2021-03-11

## README

# **COOLMOVIEZ API**

This is an unofficial [Coolmoviez](https://www.coolmoviez.shop/) api written in javascript (using nodejs) and cheerio (a web scraper) to extract information.

### **installation:**

```js
npm install coolmoviez-api
```

---
## **INSTRUCTIONS**

### **getGenre()**
Used to get the all the movies in a specified genre. Takes the genre and page number as the arguments (parameters). The default values are **genre="Action"** and **page="1"** which are both strings.
>Returns an array of objects

```js
const movies =  require("coolmoviez-api")

const genre = movies.getGenre(genre,page)

console.log(genre)

//const genre = movies.getGenre("Action",1)
```

### **getDetails()**
Used to get details of a particular movie. It takes the movie id and code as the parameters. Both the id and code can be obtained from the returned object of **getGenre()**
> Returns an object containing details about the movie

```js
const movies =  require("coolmoviez-api")

const details = movies.getDetails(id,code)

console.log(details)

//const details = movies.getDetails("The-lego-batman-movie-(2017)-english-movie",575)
```

### **getDownload()**

Used to get the download link. Takes the id and code as the parameter.
> Returns an object with a download link

```js
const movies =  require("coolmoviez-api")

const download = movies.getDownload(id,code)

console.log(download)

//const download = movies.getDownload("The-lego-batman-movie-(2017)-english-movie",575)
```

> Both the **getDownload()** and **getDetails()** have the same parameters that is **id** and **code** which are both strings

---

## **NOTE**
>Whilst working of this api, I found that the download link **might** not work. Currently working on it.

## **TO DO**
- [x] getGenre()
- [x] getDetails()
- [x] getDownload()
- [ ] search()
- [ ] getLatestMovies()
- [ ] showTotalGenrePages()
- [ ] Make app using coolmoviez-app (This api)
---

### IMPORTANT
> In case of any problems using this api, please do address it on **this api github repo** by creating an issue and will gladely respond.

> The commands seem to work with the terminal but it might have some difficulties with runkit, it returns ```undefined```

**HAPPY PROGRAMMING, ALL THE BEST**

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