SoulofSukuna commited on
Commit
e371ee8
Β·
verified Β·
1 Parent(s): e9d67ff

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +9 -460
README.md CHANGED
@@ -1,460 +1,9 @@
1
- <h2 align='center'>Torrents Api ✨</h2>
2
- <p align="center">
3
- <a href="https://github.com/Ryuk-me"><img title="Author" src="https://img.shields.io/badge/Author-Ryuk--me-red.svg?style=for-the-badge&logo=github"></a>
4
- </p>
5
-
6
- <p align="center">
7
- <a href="https://github.com/Ryuk-me"><img title="Followers" src="https://img.shields.io/github/followers/Ryuk-me?color=teal&style=flat-square"></a>
8
- <a href="https://github.com/Ryuk-me/Torrent-Api-py/stargazers/"><img title="Stars" src="https://img.shields.io/github/stars/ryuk-me/Torrent-Api-py?color=brown&style=flat-square"></a>
9
- <a href="https://github.com/Ryuk-me/Torrent-Api-py/network/members"><img title="Forks" src="https://img.shields.io/github/forks/ryuk-me/Torrent-Api-py?color=lightgrey&style=flat-square"></a>
10
- <a href="https://github.com/Ryuk-me/Torrent-Api-py/issues"><img title="issues" src="https://img.shields.io/github/issues/Ryuk-me/Torrent-Api-py?style=flat-square">
11
- </a>
12
- <img src='https://visitor-badge.glitch.me/badge?page_id=ryuk-me.Torrent-Api-py'>
13
- </p>
14
-
15
- <p align="center">
16
- <span style='font-size: 19px'>
17
- An Unofficial API for <span style='font-weight:600;'>1337x</span>, <span style='font-weight:600;'>Piratebay</span>, <span style='font-weight:bold;'>Nyaasi</span>, <span style='font-weight:bold;'>Torlock</span>, <span style='font-weight:bold;'>Torrent Galaxy</span>, <span style='font-weight:600;'>Zooqle</span>, <span style='font-weight:600;'>Kickass</span>, <span style='font-weight:600;'>Bitsearch</span>, <span style='font-weight:600;'>MagnetDL, </span>Libgen, YTS, Limetorrent, TorrentFunk, Glodls, TorrentProject and YourBittorrent
18
- </span>
19
- </p>
20
-
21
- ## Installation
22
-
23
- ```sh
24
-
25
- # Clone the repo
26
- $ git clone https://github.com/Ryuk-me/Torrent-Api-py
27
-
28
- # Go to the repository
29
- $ cd Torrent-Api-py
30
-
31
- # Install virtualenv
32
- $ pip install virtualenv
33
-
34
- # Create Virtual Env
35
- $ py -3 -m venv api-py
36
-
37
- # Activate Virtual Env [Windows]
38
- $ .\api-py\Scripts\activate
39
-
40
- # Activate Virtual Env [Linux]
41
- $ source api-py/bin/activate
42
-
43
- # Install Dependencies
44
- $ pip install -r requirements.txt
45
-
46
- # Start
47
- $ python main.py
48
-
49
- # (optional) To Use a PROXY, set the HTTP Proxy environment variable
50
- # You can also use a tor proxy using dperson/torproxy:latest
51
- $ export HTTP_PROXY="http://proxy-host:proxy-port"
52
-
53
- # To access API Open any browser/API Testing tool & move to the given URL
54
- $ localhost:8009
55
-
56
- ```
57
-
58
-
59
- ---
60
-
61
- ## Supported Sites
62
-
63
- | Website | Keyword | Url | Cloudfare |
64
- | :------------: | :--------------: | :--------------------------: | :-------: |
65
- | 1337x | `1337x` | https://1337x.to | ❌ |
66
- | Torrent Galaxy | `tgx` | https://torrentgalaxy.to | ❌ |
67
- | Torlock | `torlock` | https://www.torlock.com | ❌ |
68
- | PirateBay | `piratebay` | https://thepiratebay10.org | ❌ |
69
- | Nyaasi | `nyaasi` | https://nyaa.si | ❌ |
70
- | Zooqle | `zooqle` | https://zooqle.com | ❌ |
71
- | KickAss | `kickass` | https://kickasstorrents.to | ❌ |
72
- | Bitsearch | `bitsearch` | https://bitsearch.to | ❌ |
73
- | MagnetDL | `magnetdl` | https://www.magnetdl.com | βœ… |
74
- | Libgen | `libgen` | https://libgen.is | ❌ |
75
- | YTS | `yts` | https://yts.mx | ❌ |
76
- | Limetorrent | `limetorrent` | https://www.limetorrents.pro | ❌ |
77
- | TorrentFunk | `torrentfunk` | https://www.torrentfunk.com | ❌ |
78
- | Glodls | `glodls` | https://glodls.to | ❌ |
79
- | TorrentProject | `torrentproject` | https://torrentproject2.com | ❌ |
80
- | YourBittorrent | `ybt` | https://yourbittorrent.com | ❌ |
81
-
82
- ---
83
-
84
- <details open>
85
- <summary style='font-size: 20px'><span style='font-size: 25px;font-weight:bold;'>Supported Methods and categories</span></summary>
86
-
87
- > If you want to change the default limit site wise [Visit Here](https://github.com/Ryuk-me/Torrent-Api-py/blob/main/helper/is_site_available.py#L39)
88
-
89
- <p>
90
-
91
- ```json
92
-
93
- {
94
- "1337x": {
95
- "trending_available": True,
96
- "trending_category": True,
97
- "search_by_category": True,
98
- "recent_available": True,
99
- "recent_category_available": True,
100
- "categories": ["anime", "music", "games", "tv","apps","documentaries", "other", "xxx", "movies"],
101
- "limit" : 100
102
- },
103
- "torlock": {
104
- "trending_available": True,
105
- "trending_category": True,
106
- "search_by_category": False,
107
- "recent_available": True,
108
- "recent_category_available": True,
109
- "categories": ["anime", "music", "games", "tv","apps", "documentaries", "other", "xxx", "movies", "books", "images"],
110
- "limit" : 50
111
- },
112
- "zooqle": {
113
- "trending_available": False,
114
- "trending_category": False,
115
- "search_by_category": False,
116
- "recent_available": False,
117
- "recent_category_available": False,
118
- "categories": [],
119
- "limit": 30
120
- },
121
- "magnetdl": {
122
- "trending_available": False,
123
- "trending_category": False,
124
- "search_by_category": False,
125
- "recent_available": True,
126
- "recent_category_available": True,
127
- "categories": ["apps", "movies", "music", "games", "tv", "books"],
128
- "limit": 40
129
- },
130
- "tgx": {
131
- "trending_available": True,
132
- "trending_category": True,
133
- "search_by_category": False,
134
- "recent_available": True,
135
- "recent_category_available": True,
136
- "categories": ["anime", "music", "games", "tv",
137
- "apps", "documentaries", "other", "xxx", "movies", "books"],
138
- "limit": 50
139
- },
140
- "nyaasi": {
141
- "trending_available": False,
142
- "trending_category": False,
143
- "search_by_category": False,
144
- "recent_available": True,
145
- "recent_category_available": False,
146
- "categories": [],
147
- "limit": 50
148
-
149
- },
150
- "piratebay": {
151
- "trending_available": True,
152
- "trending_category": False,
153
- "search_by_category": False,
154
- "recent_available": True,
155
- "recent_category_available": True,
156
- "categories": ["tv"],
157
- "limit": 50
158
- },
159
- "bitsearch": {
160
- "trending_available": True,
161
- "trending_category": False,
162
- "search_by_category": False,
163
- "recent_available": False,
164
- "recent_category_available": False,
165
- "categories": [],
166
- "limit": 50
167
- },
168
- "kickass": {
169
- "trending_available": True,
170
- "trending_category": True,
171
- "search_by_category": False,
172
- "recent_available": True,
173
- "recent_category_available": True,
174
- "categories": ["anime", "music", "games", "tv","apps", "documentaries", "other", "xxx", "movies", "books"],
175
- "limit": 50
176
- },
177
- "libgen'": {
178
- "trending_available": False,
179
- "trending_category": False,
180
- "search_by_category": False,
181
- "recent_available": False,
182
- "recent_category_available": False,
183
- "categories": [],
184
- "limit": 25
185
- },
186
- "yts": {
187
- "trending_available": True,
188
- "trending_category": False,
189
- "search_by_category": False,
190
- "recent_available": True,
191
- "recent_category_available": False,
192
- "categories": [],
193
- "limit": 20
194
- },
195
- "limetorrent": {
196
- "trending_available": True,
197
- "trending_category": False,
198
- "search_by_category": False,
199
- "recent_available": True,
200
- "recent_category_available": True,
201
- "categories": ["anime", "music", "games", "tv",
202
- "apps", "other", "movies", "books"], # applications and tv-shows
203
- "limit": 50
204
- },
205
- "torrentfunk": {
206
- "trending_available": True,
207
- "trending_category": True,
208
- "search_by_category": False,
209
- "recent_available": True,
210
- "recent_category_available": True,
211
- "categories": ["anime", "music", "games", "tv",
212
- "apps", "xxx", "movies", "books"], # television # software #adult # ebooks
213
- "limit": 50
214
- },
215
- "glodls": {
216
- "trending_available": True,
217
- "trending_category": False,
218
- "search_by_category": False,
219
- "recent_available": True,
220
- "recent_category_available": False,
221
- "categories": [],
222
- "limit": 45
223
- },
224
- "torrentproject": {
225
- "trending_available": False,
226
- "trending_category": False,
227
- "search_by_category": False,
228
- "recent_available": False,
229
- "recent_category_available": False,
230
- "categories": [],
231
- "limit": 20
232
- },
233
- "ybt": {
234
- "trending_available": True,
235
- "trending_category": True,
236
- "search_by_category": False,
237
- "recent_available": True,
238
- "recent_category_available": True,
239
- "categories": ["anime", "music", "games", "tv",
240
- "apps", "xxx", "movies", "books", "pictures", "other"], # book -> ebooks
241
- "limit": 20
242
- }
243
-
244
- }
245
- ```
246
-
247
- </p>
248
- </details>
249
-
250
- ---
251
-
252
- ## API Endpoints
253
-
254
- <details open>
255
- <summary style='font-size: 15px'><span style='font-size: 20px;font-weight:bold;'>Supported sites list</span></summary>
256
- <p>
257
-
258
- > [`api/v1/sites`](https://torrent-api-py-nx0x.onrender.com/api/v1/sites)
259
-
260
- </p>
261
- </details>
262
- <br>
263
-
264
- <details open>
265
- <summary style='font-size: 15px'><span style='font-size: 20px;font-weight:bold;'>Search</span></summary>
266
- <p>
267
-
268
- > [`api/v1/search`](https://torrent-api-py-nx0x.onrender.com/api/v1/search)
269
-
270
- | Parameter | Required | Type | Default | Example |
271
- | :-------: | :------: | :-----: | :-----: | :------------------------------------------------------: |
272
- | site | βœ… | string | None | `api/v1/search?site=1337x` |
273
- | query | βœ… | string | None | `api/v1/search?site=1337x&query=avengers` |
274
- | limit | ❌ | integer | Default | `api/v1/search?site=1337x&query=avengers&limit=20` |
275
- | page | ❌ | integer | 1 | `api/v1/search?site=1337x&query=avengers&limit=0&page=2` |
276
-
277
- </p>
278
- </details>
279
- <br>
280
-
281
- <details open>
282
- <summary style='font-size: 15px'><span style='font-size: 20px;font-weight:bold;'>Trending</span></summary>
283
- <p>
284
-
285
- > `api/v1/trending`
286
-
287
- | Parameter | Required | Type | Default | Example |
288
- | :-------: | :------: | :-----: | :-----: | :-----------------------------------------------------: |
289
- | site | βœ… | string | None | `api/v1/trending?site=1337x` |
290
- | limit | ❌ | integer | Default | `api/v1/trending?site=1337x&limit=10` |
291
- | category | ❌ | string | None | `api/v1/trending?site=1337x&limit=0&category=tv` |
292
- | page | ❌ | integer | 1 | `api/v1/trending?site=1337x&limit=6&category=tv&page=2` |
293
-
294
- </p>
295
- </details>
296
- <br>
297
-
298
- <details open>
299
- <summary style='font-size: 15px'><span style='font-size: 20px;font-weight:bold;'>Recent</span></summary>
300
- <p>
301
-
302
- > `api/v1/recent`
303
-
304
- | Parameter | Required | Type | Default | Example |
305
- | :-------: | :------: | :-----: | :-----: | :----------------------------------------------------: |
306
- | site | βœ… | string | None | `api/v1/recent?site=1337x` |
307
- | limit | ❌ | integer | Default | `api/v1/recent?site=1337x&limit=7` |
308
- | category | ❌ | string | None | `api/v1/recent?site=1337x&limit=0&category=tv` |
309
- | page | ❌ | integer | 1 | `api/v1/recent?site=1337x&limit=15&category=tv&page=2` |
310
-
311
- </p>
312
- </details>
313
- <br>
314
-
315
- <details open>
316
- <summary style='font-size: 15px'><span style='font-size: 20px;font-weight:bold;'>Search By Category</span></summary>
317
- <p>
318
-
319
- > `api/v1/category`
320
-
321
- | Parameter | Required | Type | Default | Example |
322
- | :-------: | :------: | :-----: | :-----: | :--------------------------------------------------------------------: |
323
- | site | βœ… | string | None | `api/v1/category?site=1337x` |
324
- | query | βœ… | string | None | `api/v1/category?site=1337x&query=avengers` |
325
- | category | βœ… | string | None | `api/v1/category?site=1337x&query=avengers&category=movies` |
326
- | limit | ❌ | integer | Default | `api/v1/category?site=1337x&query=avengers&category=movies&limit=10` |
327
- | page | ❌ | integer | 1 | `api/v1/category?site=1337x&query=avengers&category=tv&limit=0&page=2` |
328
-
329
- </p>
330
- </details>
331
-
332
- <br>
333
-
334
- <details open>
335
- <summary style='font-size: 15px'><span style='font-size: 20px;font-weight:bold;'>Search from all sites</span></summary>
336
- <p>
337
-
338
- > `api/v1/all/search`
339
-
340
- | Parameter | Required | Type | Default | Example |
341
- | :-------: | :------: | :-----: | :-----: | :----------------------------------------: |
342
- | query | βœ… | string | None | `api/v1/all/search?query=avengers` |
343
- | limit | ❌ | integer | Default | `api/v1/all/search?query=avengers&limit=5` |
344
-
345
- <pre>Here <b>limit = 5</b> will get 5 results from each site.</pre>
346
-
347
- > [api/v1/all/search?query=avengers](https://torrent-api-py-nx0x.onrender.com/api/v1/all/search?query=avengers)
348
-
349
- > [api/v1/all/search?query=avengers&limit=5](https://torrent-api-py-nx0x.onrender.com/api/v1/all/search?query=avengers&limit=5)
350
-
351
- </pre>
352
- </details>
353
-
354
- <br>
355
-
356
- <details open>
357
- <summary style='font-size: 15px'><span style='font-size: 20px;font-weight:bold;'>Get trending from all sites</span></summary>
358
- <p>
359
-
360
- > `api/v1/all/trending`
361
-
362
- | Parameter | Required | Type | Default | Example |
363
- | :-------: | :------: | :-----: | :-----: | :---------------------------: |
364
- | limit | ❌ | integer | Default | `api/v1/all/trending?limit=2` |
365
-
366
- > [api/v1/all/trending](https://torrent-api-py-nx0x.onrender.com/api/v1/all/trending)
367
-
368
- > [api/v1/all/trending?limit=2](https://torrent-api-py-nx0x.onrender.com/api/v1/all/trending?limit=2)
369
-
370
- </p>
371
- </details>
372
-
373
- <br>
374
-
375
- <details open>
376
- <summary style='font-size: 15px'><span style='font-size: 20px;font-weight:bold;'>Get recent from all sites</span></summary>
377
- <p>
378
-
379
- > `api/v1/all/recent`
380
-
381
- | Parameter | Required | Type | Default | Example |
382
- | :-------: | :------: | :-----: | :-----: | :-------------------------: |
383
- | limit | ❌ | integer | Default | `api/v1/all/recent?limit=2` |
384
-
385
- > [api/v1/all/recent](https://torrent-api-py-nx0x.onrender.com/api/v1/all/recent)
386
-
387
- > [api/v1/all/recent?limit=2](https://torrent-api-py-nx0x.onrender.com/api/v1/all/recent)
388
-
389
- </p>
390
- </details>
391
-
392
- ---
393
-
394
- ## Want to Try api ?
395
-
396
- > [api/v1/search?site=1337x&query=eternals](https://torrent-api-py-nx0x.onrender.com/api/v1/search?site=1337x&query=eternals)
397
-
398
- <details open>
399
- <summary> See response</summary>
400
- <p>
401
-
402
- ```json
403
- {
404
- "data": [
405
- {
406
- "name": "Eternals.2021.1080p.WEBRip.1600MB.DD5.1.x264-GalaxyRG",
407
- "size": "1.6 GB",
408
- "date": "Jan. 11th '22",
409
- "seeders": "3674",
410
- "leechers": "983",
411
- "url": "https://1337x.to/torrent/5110228/Eternals-2021-1080p-WEBRip-1600MB-DD5-1-x264-GalaxyRG/",
412
- "uploader": "TGxGoodies",
413
- "screenshot": [
414
- "https://everest.picturedent.org/images/2022/01/11/tmpposter23827.jpg",
415
- "https://everest.picturedent.org/images/2022/01/11/Harone8014.th.jpg",
416
- "https://everest.picturedent.org/images/2022/01/11/Harone31320.th.jpg",
417
- "https://everest.picturedent.org/images/2022/01/11/Harone8129XqiKn.th.jpg",
418
- "https://everest.picturedent.org/images/2022/01/11/Harone27162.th.jpg",
419
- "https://everest.picturedent.org/images/2022/01/11/Harone1352.th.jpg",
420
- "https://everest.picturedent.org/images/2022/01/11/Harone14355.th.jpg"
421
- ],
422
- "category": "Movies",
423
- "files": [
424
- "Eternals.2021.1080p.WEBRip.1600MB.DD5.1.x264-GalaxyRG.mkv (1.6 GB)",
425
- "[TGx]Downloaded from torrentgalaxy.to .txt (0.7 KB)"
426
- ],
427
- "poster": "https://lx1.dyncdn.cc/cdn/02/0251ab7772c031c1130bc92810758cd4.jpg",
428
- "magnet": "magnet:?xt=urn:btih:20F8D7C2942B143E6E2A0FB5562CDE7EE1B17822&dn=Eternals.2021.1080p.WEBRip.1600MB.DD5.1.x264-GalaxyRG&tr=udp://open.stealth.si:80/announce&tr=udp://tracker.tiny-vps.com:6969/announce&tr=udp://tracker.opentrackr.org:1337/announce&tr=udp://tracker.torrent.eu.org:451/announce&tr=udp://explodie.org:6969/announce&tr=udp://tracker.cyberia.is:6969/announce&tr=udp://ipv4.tracker.harry.lu:80/announce&tr=udp://p4p.arenabg.com:1337/announce&tr=udp://tracker.birkenwald.de:6969/announce&tr=udp://tracker.moeking.me:6969/announce&tr=udp://opentor.org:2710/announce&tr=udp://tracker.dler.org:6969/announce&tr=udp://9.rarbg.me:2970/announce&tr=https://tracker.foreverpirates.co:443/announce&tr=udp://tracker.opentrackr.org:1337/announce&tr=http://tracker.openbittorrent.com:80/announce&tr=udp://opentracker.i2p.rocks:6969/announce&tr=udp://tracker.internetwarriors.net:1337/announce&tr=udp://tracker.leechers-paradise.org:6969/announce&tr=udp://coppersurfer.tk:6969/announce&tr=udp://tracker.zer0day.to:1337/announce",
429
- "hash": "20F8D7C2942B143E6E2A0FB5562CDE7EE1B17822"
430
- }
431
- ],
432
- "current_page": 1,
433
- "total_pages": 7,
434
- "time": 1.276763677597046,
435
- "total": 20
436
- }
437
- ```
438
-
439
- </p>
440
- </details>
441
-
442
- ---
443
-
444
- ## Donations
445
-
446
- <p> If you feel like showing your appreciation for this project, then how about buying me a coffee?</p>
447
-
448
- [!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/ryukmee)
449
-
450
- ---
451
-
452
- ## DEPLOY
453
-
454
- <a href="https://render.com/deploy?repo=https://github.com/Ryuk-me/Torrent-Api-py">
455
- <img src="https://render.com/images/deploy-to-render-button.svg" alt="Deploy to Render" />
456
- </a>
457
-
458
- </br>
459
-
460
- [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
 
1
+ ---
2
+ title: Tor-Search-API
3
+ emoji: πŸ”₯
4
+ colorFrom: red
5
+ colorTo: blue
6
+ sdk: docker
7
+ pinned: false
8
+ short_description: 'Search all avaliable tors '
9
+ ---