tbd-api 0.0.4

Unofficial API for TorrentBD

TorrentBD API

Unofficial API for TorrentBD with search and profile access.

Overview

TorrentBD API is a Python package that provides a RESTful API wrapper for the TorrentBD website. It handles authentication, session management, and parsing of web content.

Disclaimer

This project is not affiliated with or endorsed by TorrentBD. This is an unofficial API created for educational purposes only. Use at your own risk.

Features

• Search torrents with pagination
• Access user profile information
• Automated login with reCAPTCHA solving
• Configurable via command line, environment variables, or config file
• Web UI for easy access

Installation

pip install tbd-api

Requirements

• Python 3.12 or later
• Chrome or Chromium browser (for login functionality)
• ChromeDriver (compatible with your Chrome/Chromium version)

Usage

Command Line

# Basic usage
tbd-api

# With credentials
tbd-api --username "user" --password "pass" --totp-secret "secret"

# Custom host and port
tbd-api --host "127.0.0.1" --port 8000

API Endpoints

Endpoint	Method	Description	Parameters
/search	GET	Search torrents	query (required): Search term page (optional): Page number (default: 1)
/profile	GET	Get user profile	None

Configuration

Command-Line Arguments

usage: tbd-api [-h] [--username USERNAME] [--password PASSWORD] [--totp-secret TOTP_SECRET]
               [--port PORT] [--host HOST] [--cookies COOKIES]

options:
  -h, --help            show this help message and exit
  --username USERNAME   TorrentBD username
  --password PASSWORD   TorrentBD password
  --totp-secret TOTP_SECRET
                        TOTP secret for 2FA
  --port PORT           Port to run the server on (default: 5000)
  --host HOST           Host to bind the server to (default: 0.0.0.0)
  --cookies COOKIES     Path to cookies file

Configuration Files

All data is automatically saved in ~/.config/tbd-api/:

• Credentials and settings: config.json
• Login cookies: cookies.txt (Netscape format)

Cookie Management

You can use the Get cookies.txt LOCALLY Chrome extension to export cookies from TorrentBD in Netscape format and save them to ~/.config/tbd-api/cookies.txt. This is useful when you want to bypass the automated login process.

Environment Variables

You can also use a .env file in the project folder:

USERNAME=your_username
PASSWORD=your_password
TOTP_SECRET=your_totp_secret

Docker

# Build the image
docker build -t tbd-api .

# Run the container
docker run -p 5000:5000 tbd-api --username "user" --password "pass" --totp-secret "secret"

# or with environment variables
docker run --env-file .env -p 5000:5000 tbd-api

Development

# Clone the repository
git clone https://github.com/TanmoyTheBoT/torrentbd-api.git
cd torrentbd-api

# Install in development mode
make install

# Run
make run

# Run tests
make check

# Run linters
make lint

License

This project is licensed under the MIT License - see the LICENSE file for details.