https://github.com/hemantapkh/1337x
✖️ Unofficial API of 1337x.to
https://github.com/hemantapkh/1337x
1337x 1337x-api 1337x-to torrent-search-api torrents
Last synced: about 2 months ago
JSON representation
✖️ Unofficial API of 1337x.to
- Host: GitHub
- URL: https://github.com/hemantapkh/1337x
- Owner: hemantapkh
- License: mit
- Created: 2021-04-23T17:49:34.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-15T16:17:50.000Z (11 months ago)
- Last Synced: 2024-10-11T01:46:18.439Z (8 months ago)
- Topics: 1337x, 1337x-api, 1337x-to, torrent-search-api, torrents
- Language: Python
- Homepage: https://pypi.org/project/1337x
- Size: 106 KB
- Stars: 104
- Watchers: 4
- Forks: 25
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
The ultimate Python API wrapper for 1337x.
## Table of Contents
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Examples](#examples)
- [Asynchronous Usage](#asynchronous-usage)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [License](#license)
## Installation
Install via [PyPi](https://www.pypi.org/project/1337x):
```bash
pip install 1337x
```
Or install from the source:
```bash
pip install git+https://github.com/hemantapkh/1337x
```
## Examples
### Searching Torrents
```python
import py1337x
torrents = py1337x.Py1337x()
# Basic search
results = torrents.search('ubuntu', page=1)
for result in results.items:
print(f"Title={result.name} Seeders={result.seeders}")
# Search with sorting by seeders
results = torrents.search('vlc', sort_by=py1337x.sort.SEEDERS, category=py1337x.category.APPS)
print(results)
# Get today's trending torrents
results = torrents.trending()
print(results)
```
### Getting Torrent Information
To get magnetlink and other information of the torrent.
```python
# Getting info the the first result of the above search
torrent_id = results.items[0].torrent_id
info = torrents.info(torrent_id=torrent_id)
print(info)
# Convert the result to dictionary
info_dict = info.to_dict()
print(info_dict)
```
## Asynchronous Usage
For asynchronous usage, all functionalities are the same; use `AsyncPy1337x` instead of `Py1337x`:
```python
import asyncio
from py1337x import AsyncPy1337x
async def main():
torrents = AsyncPy1337x()
results = await torrents.search('vlc media player')
print(results)
asyncio.run(main())
```
## Documentation
The detailled documentation of the project is available [here](https://1337x.readthedocs.org/en/latest/).
## Contributing
Any contributions you make are **greatly appreciated**.
*Thanks to every [contributors](https://github.com/hemantapkh/1337x/graphs/contributors) who have contributed in this project.*
## License
Distributed under the MIT License. See [LICENSE](https://github.com/hemantapkh/1337x/blob/main/LICENSE) for more information.
-----
Author/Maintainer: [Hemanta Pokharel](https://github.com/hemantapkh/)