https://github.com/popcorn-official/popcorn-api

Popcorn Time is a multi-platform, free software BitTorrent client that includes an integrated media player. Compatible API Anime/Movies/Show Scrapper
https://github.com/popcorn-official/popcorn-api

episodes metadata popcorn popcorn-api popcorn-time trakt

Last synced: 19 days ago
JSON representation

Popcorn Time is a multi-platform, free software BitTorrent client that includes an integrated media player. Compatible API Anime/Movies/Show Scrapper

• Host: GitHub
• URL: https://github.com/popcorn-official/popcorn-api
• Owner: popcorn-official
• License: mit
• Created: 2016-03-04T08:50:16.000Z (about 9 years ago)
• Default Branch: development
• Last Pushed: 2020-04-19T18:18:08.000Z (about 5 years ago)
• Last Synced: 2025-03-28T19:09:34.634Z (26 days ago)
• Topics: episodes, metadata, popcorn, popcorn-api, popcorn-time, trakt
• Language: JavaScript
• Homepage: https://popcorntime.app
• Size: 4.38 MB
• Stars: 626
• Watchers: 58
• Forks: 102
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# popcorn-api

[![Build Status](https://travis-ci.org/popcorn-official/popcorn-api.svg?branch=development)](https://travis-ci.org/popcorn-official/popcorn-api)

[![Windows Build](https://img.shields.io/appveyor/ci/chrisalderson/popcorn-api/3.0.0.svg?label=windows)](https://ci.appveyor.com/project/ChrisAlderson/popcorn-api)

[![Coverage Status](https://coveralls.io/repos/github/popcorn-official/popcorn-api/badge.svg?branch=3.0.0)](https://coveralls.io/github/popcorn-official/popcorn-api?branch=3.0.0)

[![Dependency Status](https://david-dm.org/popcorn-official/popcorn-api.svg)](https://david-dm.org/popcorn-official/popcorn-api)

[![devDependency Status](https://david-dm.org/popcorn-official/popcorn-api/dev-status.svg)](https://david-dm.org/popcorn-official/popcorn-api?type=dev)

[![document](https://popcorn-official.github.io/popcorn-api/badge.svg)](https://popcorn-official.github.io/popcorn-api/source.html)

Popcorn API is developed to make it easier for anyone to create their own

version of [Popcorn Time](http://popcorntime.sh). It contains:

- Metadata about movies (taken from Trakt).

- Metadata about TV shows and individual episodes (taken from Trakt).

- Multiple quality magnet links for every episode.

- Ability to easily filter content to the user's content.

- Add content manually through the CLI.

## Installation

To setup your local machine to start working on the project you can follow

these steps:

1. Install [MongoDB](https://www.mongodb.com/) including `mongoexport` and `mongoimport`

2. Install [NodeJS](https://nodejs.org/) (at least Node v7.10.1 or greater)

3. Clone the repository with: `git clone https://github.com/popcorn-official/popcorn-api.git`

4. Install dependencies `npm i`

5. Install the flow-typed libraries with `npm run flow-typed`

## Documentation

 - [General documentation](https://popcorn-official.github.io/popcorn-api/manual/index.html)

 - [Route Api docs](http://docs.popcornofficial.apiary.io/).

 - [Api docs](https://popcorn-official.github.io/popcorn-api/identifiers.html)

 - TODO: Add more documentation links.

## License

MIT License