Torrent Search MCP/API/WebUI
This repository provides a Python API/WebUI and an MCP (Model Context Protocol) server to find torrents programmatically on ThePirateBay, 1337x, Nyaa, YTS, EZTV, FitGirl, SubsPlease, BitTorrented and UIndex. It allows for easy integration into other applications or services.
Quickstart
# One-time setup: install playwright/chromium for crawl4ai
uvx --from torrent-search-mcp crawl4ai-setup
# CLI search
uvx torrent-search-mcp --mode cli "breaking bad"
# MCP server over stdio (default)
uvx torrent-search-mcp --mode stdio
# MCP server over streamable HTTP (port 8000, endpoint /mcp)
uvx torrent-search-mcp --mode http
# MCP server over SSE (port 8000, endpoint /sse, legacy)
uvx torrent-search-mcp --mode sse
# Standalone FastAPI server (port 8000)
uvx torrent-search-mcp --mode fastapi
Table of Contents
Features
- API wrapper for ThePirateBay, 1337x, Nyaa, YTS, EZTV, FitGirl, SubsPlease, BitTorrented and UIndex.
- MCP server interface for standardized communication (
stdio,sse,streamable-http). - FastAPI server interface for alternative HTTP access (e.g., for direct API calls or testing).
- CLI mode for quick one-off searches directly from the terminal.
- In-memory +
aiocacheresult caching to reduce redundant scraping. - Configurable source filtering via environment variables.
- Tools:
- Search for torrents across all available sources.
- Get the most popular torrents per source (apibay, uindex, 1337x, YTS, nyaa, EZTV).
- Get the magnet link for a specific torrent by id.
- List available sources.
Supported Sources
| Source | Domain | Fetch method |
|---|---|---|
| ThePirateBay | thepiratebay.org |
HTML (crawl4ai) |
| apibay (TPB mirror) | apibay.org |
HTTP API |
| 1337x | 1337x.to |
HTTP API |
| Nyaa | nyaa.si |
HTTP API |
| YTS | yts.mx |
HTTP API |
| EZTV | eztvx.to |
HTTP API |
| FitGirl | fitgirl-repacks.site |
HTTP API |
| SubsPlease | subsplease.org |
HTTP API |
| BitTorrented | bittorrented.com |
HTTP API |
| UIndex | uindex.org |
HTTP top list |
Note on UIndex: the site exposes no programmatic search endpoint (its search path is protected by a browser challenge), so queries are matched client-side against its live top list - which conveniently carries magnet links inline.
Sources can be excluded individually via the EXCLUDE_SOURCES env var.
Setup
Prerequisites
- Python 3.10+ (required for PyPI install). CI and Docker images use Python 3.14.
uv(for local development).- Docker and Docker Compose (for Docker setup).
Configuration (Optional)
The application reads configuration from environment variables. The recommended way to set them is by creating a .env file in your project's root directory. The application will load it automatically. See .env.example for all available options.
| Variable | Default | Description |
|---|---|---|
INCLUDE_LINKS |
false |
When true, include magnet links in the MCP search_torrents / popular_torrents results. Left off by default to greatly reduce token usage. |
EXCLUDE_SOURCES |
(none) | Comma-separated list of sources to exclude from results (e.g. nyaa.si,1337x.to). |
CRAWLER_IDLE_TIMEOUT |
120 |
Seconds of inactivity before the headless browser (used for HTML sources like ThePirateBay) is shut down; the timer resets on every search. Set 0 to disable. |
TORRENT_SEARCH_API_URL |
(none) | MCP only: base URL of a running Torrent Search REST API - tools proxy it instead of scraping locally. Unset = standalone. |
TELEGRAM_BOT_HANDLE |
(none) | Telegram bot handle used by the Web UI torrent action. The Telegram button is hidden when unset. |
Installation
Choose one of the following installation methods.
Install from PyPI (Recommended)
This method is best for using the package as a library or running the server without modifying the code.
- Install the package from PyPI:
pip install torrent-search-mcp
crawl4ai-setup # For crawl4ai/playwright
playwright install --with-deps chromium # If previous command fails
-
Create a
.envfile in the directory where you'll run the application (optional). -
Run the MCP server (default: stdio):
python -m torrent_search
For Local Development
This method is for contributors who want to modify the source code.
Using uv:
- Clone the repository:
git clone https://github.com/philogicae/torrent-search-mcp.git
cd torrent-search-mcp
- Install dependencies using
uv:
uv sync --frozen
uvx playwright install --with-deps chromium
- Create your configuration file by copying the example:
cp .env.example .env
- Run the MCP server (default: stdio):
uv run -m torrent_search
The repo also ships a dev.sh helper that locks/syncs deps, formats, lints, type-checks (ty) and runs the test suite with coverage:
./dev.sh
For Docker
This method uses Docker Compose to run two containers: the REST API + web UI, and an MCP server that proxies the API (no local scraping).
compose.yaml is configured to bypass DNS issues (using quad9 DNS).
| Container | Mode | Host port | Endpoints |
|---|---|---|---|
torrent-search-api |
fastapi |
8000 |
/ (web UI), /torrent/*, /sources, /docs |
torrent-search-mcp |
http |
8001 |
/mcp (MCP over streamable HTTP, TORRENT_SEARCH_API_URL=http://torrent-search-api:8000) |
- Clone the repository (if you haven't already):
git clone https://github.com/philogicae/torrent-search-mcp.git
cd torrent-search-mcp
- Create your configuration file by copying the example:
cp .env.example .env
- Build and run the containers using Docker Compose:
docker compose up --build -d
- Access container logs:
docker logs torrent-search-api -f
docker logs torrent-search-mcp -f
Usage
The package exposes a single entry point, torrent-search-mcp (installed by pip/uvx), equivalent to python -m torrent_search. It supports the following --mode values:
| Mode | Endpoint | Description |
|---|---|---|
cli |
- | Run a single search query and print results to stdout. |
stdio |
- | MCP server over stdio (default). |
http |
/mcp |
MCP server using streamable HTTP (fastmcp's canonical HTTP alias). |
streamable-http |
/mcp |
Same as http; the modern, MCP-spec-recommended HTTP transport. |
sse |
/sse |
MCP server using Server-Sent Events. Legacy HTTP transport (deprecated by the MCP spec in favor of streamable-http). |
fastapi |
/ |
Standalone FastAPI HTTP server (see As FastAPI Server). |
MCP modes (stdio, http, streamable-http, sse) run standalone by default (tools scrape locally). Set TORRENT_SEARCH_API_URL to switch to API mode: the tools proxy a running Torrent Search REST API instead.
Common flags (for http, streamable-http, sse and fastapi modes): --host (default 0.0.0.0), --port (default 8000), --reload, --workers (FastAPI only).
As CLI
Run a one-off search directly from the terminal. Prints each result as id (seeders|leechers|downloads) - filename, then fetches the magnet/torrent for the top hit.
# Using the installed entry point
torrent-search-mcp --mode cli "breaking bad"
# Or via uvx without installing
uvx torrent-search-mcp --mode cli "breaking bad"
# Or from source
uv run -m torrent_search --mode cli "breaking bad"
As Python Wrapper
from torrent_search import torrent_search_api
results = await torrent_search_api.search_torrents("breaking bad")
for torrent in results:
print(
f"{torrent.filename} | {torrent.size} | {torrent.seeders} SE | {torrent.leechers} LE | {torrent.date} | {torrent.source}"
)
search_torrents is async and accepts an optional max_items (default 10). popular_torrents(per_source=10) returns the current most popular torrents from sources with a top listing - up to per_source results per source, merged and ranked by seeders + leechers. Each Torrent exposes id, filename, size, seeders, leechers, date, source, and (when available) magnet_link. Pass a torrent's id to get_torrent() to retrieve its magnet link.
As MCP Server
from torrent_search import torrent_search_mcp
torrent_search_mcp.run(transport="sse")
As FastAPI Server
This project also includes a FastAPI server as an alternative way to interact with the library via a standard HTTP API. This can be useful for direct API calls, integration with other web services, or for testing purposes.
Running the FastAPI Server:
# With Python
python -m torrent_search --mode fastapi
# With uv
uv run -m torrent_search --mode fastapi
--host <host>: Default:0.0.0.0.--port <port>: Default:8000.--reload: Enables auto-reloading when code changes (useful for development).--workers <workers>: Default:1.
The FastAPI server will then be accessible at http://<host>:<port>.
Available Endpoints: The FastAPI server exposes similar functionalities to the MCP server. Key endpoints include:
GET /: Built-in dark-mode terminal-style web UI - search, popular listings, sortable results with magnet links.POST /torrent/search: Search for torrents. Query params:query(required) andmax_items(optional, default20).GET /torrent/popular: Get the most popular torrents. Query param:per_source(optional, default10).GET /torrent/{torrent_id}: Get the magnet link for a specific torrent by id. Returns the magnet URI as text./docs: Interactive API documentation (Swagger UI)./redoc: Alternative API documentation (ReDoc).
Environment variables are configured the same way as for the MCP server (via an .env file in the project root).
Via MCP Clients
Usable with any MCP-compatible client. Available tools:
search_torrents(user_intent, query): Search for torrents across all available sources.user_intent: A short description reflecting the user's overall intention (e.g."latest episode of Breaking Bad").query: Optimized, lowercase, space-separated keywords (e.g."breaking bad s01e05"). Generic/filler/technical terms should be stripped per the tool's docstring.- By default magnet links are stripped from the response to save tokens; set
INCLUDE_LINKS=trueto include them.
popular_torrents(per_source=10): Get the most popular torrents right now from sources with an official top listing (apibay, uindex, 1337x, YTS, nyaa, EZTV) - up toper_sourceresults each, merged and pre-ranked by seeders + leechers.- By default magnet links are stripped from the response to save tokens; set
INCLUDE_LINKS=trueto include them.
- By default magnet links are stripped from the response to save tokens; set
available_sources(): Get the list of available torrent sources.get_torrent(torrent_id): Get the magnet link for a specific torrent by id (theidreturned bysearch_torrentsorpopular_torrents).
Example with Devin
Configuration:
{
"mcpServers": {
...
# with stdio (only requires uv)
"torrent-search-mcp": {
"command": "uvx",
"args": [ "torrent-search-mcp" ]
},
# with streamable-http transport (Docker compose: MCP on port 8001; standalone server: 8000)
"torrent-search-mcp": {
"serverUrl": "http://127.0.0.1:8001/mcp"
},
# with sse transport (legacy; requires running server)
"torrent-search-mcp": {
"serverUrl": "http://127.0.0.1:8001/sse"
},
...
}
}
Changelog
See CHANGELOG.md for a history of changes to this project.
Contributing
Contributions are welcome! Please open an issue or submit a pull request.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file torrent_search_mcp-4.0.1.tar.gz.
File metadata
- Download URL: torrent_search_mcp-4.0.1.tar.gz
- Upload date:
- Size: 36.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9d4645315f6f221eea5cbdb3b0e81407f57f4485328643863ea06449aef655a2
|
|
| MD5 |
b335b6344dc28fce6f25c36740640ea4
|
|
| BLAKE2b-256 |
98764b97face97527d288cf964b3fa9c7304dca11a84f3a26d8bd002d1813c0b
|
Provenance
The following attestation bundles were made for torrent_search_mcp-4.0.1.tar.gz:
Publisher:
python-package-ci.yml on philogicae/torrent-search-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
torrent_search_mcp-4.0.1.tar.gz -
Subject digest:
9d4645315f6f221eea5cbdb3b0e81407f57f4485328643863ea06449aef655a2 - Sigstore transparency entry: 2582588869
- Sigstore integration time:
-
Permalink:
philogicae/torrent-search-mcp@e43bfd8e437cf7ab994811d9e6cf953831798955 -
Branch / Tag:
refs/tags/4.0.1 - Owner: https://github.com/philogicae
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-package-ci.yml@e43bfd8e437cf7ab994811d9e6cf953831798955 -
Trigger Event:
push
-
Statement type:
File details
Details for the file torrent_search_mcp-4.0.1-py3-none-any.whl.
File metadata
- Download URL: torrent_search_mcp-4.0.1-py3-none-any.whl
- Upload date:
- Size: 40.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
441303a8c40fbd150a12daaaa49a337907b69fcf44726b03f9dccd289860b5c5
|
|
| MD5 |
c2c9dff263ba4c220b86f64dce6de0a0
|
|
| BLAKE2b-256 |
d164f08d95ec1571b2f1dfcc8a89eab29c3951752bea064f1abdbaa4896e0455
|
Provenance
The following attestation bundles were made for torrent_search_mcp-4.0.1-py3-none-any.whl:
Publisher:
python-package-ci.yml on philogicae/torrent-search-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
torrent_search_mcp-4.0.1-py3-none-any.whl -
Subject digest:
441303a8c40fbd150a12daaaa49a337907b69fcf44726b03f9dccd289860b5c5 - Sigstore transparency entry: 2582588877
- Sigstore integration time:
-
Permalink:
philogicae/torrent-search-mcp@e43bfd8e437cf7ab994811d9e6cf953831798955 -
Branch / Tag:
refs/tags/4.0.1 - Owner: https://github.com/philogicae
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-package-ci.yml@e43bfd8e437cf7ab994811d9e6cf953831798955 -
Trigger Event:
push
-
Statement type: