https://github.com/deadsec-security/popcorn-time-api

Python API for interacting with the Popcorn Time Servers
https://github.com/deadsec-security/popcorn-time-api

popcorn popcorn-api popcorn-sdk popcorn-time popcorn-time-api popcorntime popcorntime-api popcorntimeapi

Last synced: about 1 year ago
JSON representation

Python API for interacting with the Popcorn Time Servers

• Host: GitHub
• URL: https://github.com/deadsec-security/popcorn-time-api
• Owner: DEADSEC-SECURITY
• License: mit
• Created: 2022-01-06T07:44:45.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-04-21T19:46:57.000Z (about 1 year ago)
• Last Synced: 2025-04-21T20:43:20.432Z (about 1 year ago)
• Topics: popcorn, popcorn-api, popcorn-sdk, popcorn-time, popcorn-time-api, popcorntime, popcorntime-api, popcorntimeapi
• Language: Python
• Homepage:
• Size: 103 KB
• Stars: 3
• Watchers: 1
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# Popcorn Time API ![Version](https://img.shields.io/badge/Version-v1.0.0-orange?style=flat-square&url=https://github.com/DEADSEC-SECURITY/popcorn-time-api/blob/main/CHANGELOG.md) ![Python_Version](https://img.shields.io/badge/Python-3.7%2B-blue?style=flat-square) ![License](https://img.shields.io/badge/License-MIT-red?style=flat-square) ![Donate](https://img.shields.io/badge/Donate-Crypto-yellow?style=flat-square)

[![CodeQL](https://github.com/DEADSEC-SECURITY/popcorn-time-api/actions/workflows/codeql-analysis.yml/badge.svg?branch=main&style=flat-square)](https://github.com/DEADSEC-SECURITY/popcorn-time-api/actions/workflows/codeql-analysis.yml)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/DEADSEC-SECURITY/popcorn-time-api/main.svg)](https://results.pre-commit.ci/latest/github/DEADSEC-SECURITY/popcorn-time-api/main)

![PyPI - Downloads](https://img.shields.io/pypi/dd/popcorn-time?label=Daily%20Downloads&style=flat-square) ![PyPI - Downloads](https://img.shields.io/pypi/dw/popcorn-time?label=Weekly%20Downloads&style=flat-square) ![PyPI - Downloads](https://img.shields.io/pypi/dm/popcorn-time?label=Monthly%20Downloads&style=flat-square)

## 📝 CONTRIBUTIONS

Before doing any contribution read CONTRIBUTING.

## 📧 CONTACT

Email: amng835@gmail.com

General Discord: https://discord.gg/dFD5HHa

Developer Discord: https://discord.gg/rxNNHYN9EQ

## 📥 INSTALLING

Latest PyPI stable release

```bash

pip install popcorn-time

```

## ⚙ HOW TO USE

```python

from popcorntime import PopcornTime

popAPI = PopcornTime()

```

## 🤝 PARAMETERS

### CLASS PARAMETERS

- **debug** : bool, optional

  - Enable for debug mode (Default: False)

- **min_peers** : int, optional

  - Minimum number of peers to select torrent (Default: 0)

- **min_seeds** : int, optional

  - Minimum number of seeds to select torrent (Default: 0)

### FUNCTION PARAMETERS

- #### FUNCTION `set_logging_level`

  - **level** : int, required

    - Set the logging level

    - Accepted values:

      - 0: DEBUG

      - 1: INFO

      - 2: WARNING

      - 3: ERROR

      - 4: CRITICAL

      - 5: NOTSET

- #### FUNCTION `set_base_url`

  - **url** : str, required

    - Set the base url for the API

- #### FUNCTION `set_base_url`

  - **url** : str, required

    - Set the base url for the API

- #### FUNCTION `set_min_seeds`

  - **value** : int, required

    - Minimum number of seeds to select torrent

- #### FUNCTION `get_server_status`

  - Returns the server status in json format

- #### FUNCTION `get_shows_stats`

  - Returns the show stats in json format

- #### FUNCTION `get_shows_page`

  - **page** : (int, str), required

  - Returns the shows page in json format

- #### FUNCTION `get_movies_stats`

  - Returns the movies stats in json format

- #### FUNCTION `get_movies_page`

  - **page** : (int, str), required

  - Returns the movies page in json format

- #### FUNCTION `get_show`

  - **show_id** : (int, str), required

    - IMDB ID of the show

  - Returns the show data in json format

- #### FUNCTION `get_movie`

  - **movie_id** : (int, str), required

    - IMDB ID of the movie

  - Returns the movie data in json format

- #### FUNCTION `get_random_show`

  - Returns the show in json format

- #### FUNCTION `get_random_movie`

  - Returns the movie in json format

- #### FUNCTION `get_best_torrent`

  - **torrents** : dict, required

    - The dictionary of torrents provided by the API (get_show or get_movie)

  - **min_quality** : int, optional

    - Minimum quality to select torrent (Default: '1080')

  - **revert_to_default** : bool, optional

    - Revert to default item if no torrents are found (Default: False)

  - Returns the best torrent is json format

- #### FUNCTION `remove_cam_torrents`

  - **torrents** : dict, required

    - The dictionary of torrents provided by the API (get_show or get_movie)

  - Returns all the torrents without cam in json format

## Legal Notice

This SDK is not meant to be used for illegal purposes, use it at your own risk and check your local regulations first.