search

BeamlakAschalew / flixquest-api

https://flixquest-api.vercel.app
GNU General Public License v3.0
49 stars 19 forks source link
movies movies-api rest-api streaming tv-shows

readme

Consumet

FlixQuest API

REST API that fetches streaming links of movies and TV shows based on TMDB id using @movie-web/providers package

Node build badge

Hosted instance: https://flixquest-api.vercel.app

API Reference

List of available providers:

Name Id Status
ShowBox showbox 🟢 200
FlixHQ flixhq 🔴 500
ZoeChip zoe 🔴 500
SmashyStream smashystream 🔴 500
RemoteStream remotestream 🔴 500
Gomovies gomovies 🔴 500
VidSrc vidsrc 🟢 200
VidSrcTo vidsrcto 🟢 200

Get all links and subtitles for a movie

Parameter Type Description
tmdbId int Required. TMDB id of the movie
proxied bool Optional. true or false value.

If set true or proxied parameter is left empty, the script uses the proxy URL that is found in the environment variable.
Otherwise if set false the script will make a raw request towards the provider.		 
  GET /{provider ID}/watch-movie?tmdbId=tmdbId

Example

Get streaming link and subtitles for the movie 'The Hangover 1' from the 'FlixHQ' provider

  GET /flixhq/watch-movie?tmdbId=18785

Get all links and subtitles for an episode

Parameter Type Description
tmdbId int Required. TMDB id of the TV show
season int Required. The season number of the episode
episode int Required. The episode number of the episode
proxied bool Optional. true or false value.

If set true or proxied parameter is left empty, the script uses the proxy URL that is found in the environment variable.
Otherwise if set false the script will make a raw request towards the provider.		 
  GET /{provider ID}/watch-tv?tmdbId=tmdbId&season=season&episode=episode

Example

Get streaming link and subtitles for the TV show 'The Office' from the 'FlixHQ' provider

  GET /flixhq/watch-tv?tmdbId=2316&season=1&episode=1

Installation

Locally

Installation is simple.

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

$ git clone https://github.com/BeamlakAschalew/flixquest-api.git
$ cd flixquest-api
$ npm install

start the server!

$ npm start

or

$ nodemon

Vercel

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

Deploy with Vercel

Render

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

Deploy to Render

Environment Variables

TMDB_KEY (Required) : TMDB API key, used to get the metadata of a movie or TV show, can be found at https://www.themoviedb.org/settings/api

WORKERS_URL (Optional) : A proxy URL that'll be used while making a GET request (used only if proxied is true or if proxied is left unprovided).

You can get Cloudflare proxy at https://workers.cloudflare.com/
Or deploy your own custom proxy from here and place the endpoint in WORKERS_URL

You can cache data that comes from TMDB and from the providers if you have a Redis database:

REDIS_HOST URL of your Redis database
REDIS_PASSWORD password of your database
REDIS_PORT port of your database connection

Credits

Most of the code of this script is based on Consumet API
The script uses @movie-web/providers package

Contributors