Consumet API

Consumet provides an APIs for accessing information and links for various entertainments like movies, books, anime, etc.

Consumet scrapes data from various websites and provides APIs for accessing the data to satisfy your needs.

Table of Contents

• Installation
  • Locally
  • Docker
  • Heroku
  • Vercel
  • Render
  • Railway
• Documentation
• Development
• Showcases
• Provider Request
• Support
• Contributors ✨
• Related repositories

Installation

Locally

installation is simple.

Run the following command to clone the repository, and install the dependencies.

$ git clone https://github.com/consumet/api.consumet.org.git
$ cd api.consumet.org
$ npm install #or yarn install

start the server!

$ npm start #or yarn start

Docker

Docker image is available at Docker Hub.

run the following command to pull and run the docker image.

$ docker pull riimuru/consumet-api
$ docker run -p 3000:3000 riimuru/consumet-api

This will start the server on port 3000. You can access the server at http://localhost:3000/, And can change the port by changing the -p option to -p <port>:3000.

Be sure to set NODE_ENV to PROD in your environment variables when running your own instance. Check out the .env.example file for more information.

You can add -d flag to run the server in detached mode.

Heroku

Host your own instance of Consumet API on Heroku using the button below.

Vercel

Host your own instance of Consumet API on Vercel using the button below.

Render

Host your own instance of Consumet API on Render using the button below.

Railway

Host your own instance of Consumet API on Railway using the button below.

Documentation

Please refer to the documentation. Join our Discord server if you need any additional help or have any questions, comments, or suggestions.

Development

Pull requests and stars are always welcome, for bugs and features create a new issue. If you're brave to make make a commit to the project see CONTRIBUTING.md.

Showcases

Showcases are welcome! If you have a project that uses Consumet API, please let us know by making a new discussion here or by joining our Discord server. We will add your project to our showcases page.

Provider Request

Make a new issue with the name of the provider on the title, as well as a link to the provider in the body paragraph.

Support

You can contact the maintainers of consumet.ts via email, or join the discord server (Recommended).

Contributors ✨

Thanks to the following people for keeping this project alive and thriving.

Related repositories

• Consumet.ts
• Website
• Providers Status