Giter Club home page Giter Club logo

flixquestapi's Introduction

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

flixquestapi's People

Contributors

beamlakaschalew avatar tommy0412 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.