Rarbg-torrentapi

Perl Module to interact with https://torrentapi.org
git clone https://git.e1e0.net/Rarbg-torrentapi.git
Log | Files | Refs | README | LICENSE

README.md (3245B)

      1 # NAME
      2 
      3 Rarbg::torrentapi - Wrapper around Rarbg torrentapi ([https://torrentapi.org/apidocs\_v2.txt](https://torrentapi.org/apidocs_v2.txt))
      4 
      5 # SYNOPSIS
      6 
      7     use Rarbg::torrentapi;
      8     my $tapi = Rarbg::torrentapi->new();
      9 
     10     # list lastest torrents
     11     my $last_added = $tapi->list();
     12 
     13     # list torrents sorted by seeders
     14     my $last_added = $tapi->list({
     15         sort => 'seeders',
     16         limit => 50,
     17         category => 'tv'
     18     });
     19 
     20     # search by string
     21     # You can use all attributes also
     22     my $search = $tapi->search({
     23         search_string => 'the beatles',
     24         category => '23;24;25;26',
     25         min_seeders => 20
     26     });
     27 
     28     # search by imdb id
     29     my $search = $tapi->search({
     30         search_imdb => 'tt123456'
     31     });
     32 
     33     # search by themoviedb id
     34     my $search = $tapi->search({
     35         search_themoviedb => '123456'
     36     });
     37 
     38     # search by tvdb id
     39     my $search = $tapi->search({
     40         search_tvdb => '123456'
     41     });
     42 
     43 # DESCRIPTION
     44 
     45 Rarbg::torrentapi is a simple wrapper around Rarbg's torrentapi.
     46 
     47 # ATTRIBUTES
     48 
     49 Those attributes can be used on all public methods. In fact you can use them also when creating the object. Some of them make more sense at creation time, some others when calling the method. It's your call.
     50 
     51 The only difference is that you should pass them as an anonymous hash if you pass them to a method.
     52 
     53 You can find more info about their values at [https://torrentapi.org/apidocs\_v2.txt](https://torrentapi.org/apidocs_v2.txt)
     54 
     55 ## search\_string
     56 
     57 ## search\_imdb
     58 
     59 This is the Imdb id (http://imdb.com) in the form 'tt123456'
     60 
     61 ## search\_themoviedb
     62 
     63 ## search\_tvdb
     64 
     65 ## category
     66 
     67 Category can be quite confusing.
     68 It accepts 'tv' and 'movies'. But, for the rest of categories only accepts its id numbers (or a semi-colon separated list of them).
     69 
     70 - XXX (18+) => 4
     71 - Movies/XVID => 14
     72 - Movies/XVID/720 => 48
     73 - Movies/x264 => 17
     74 - Movies/x264/1080 => 44
     75 - Movies/x264/720 => 45
     76 - Movies/x264/3D => 47
     77 - Movies/x264/4k => 50
     78 - Movies/x265/4k => 51
     79 - Movies/x264/4k/HDR => 52
     80 - Movies/Full BD => 42
     81 - Movies/BD Remux => 46
     82 - TV Episodes => 18
     83 - TV HD Episodes => 41
     84 - TV UHD Episodes => 49
     85 - Movies/MP3 => 23
     86 - Movies/FLAC => 25
     87 - Games/PC ISO => 27
     88 - Games/PC RIP => 28
     89 - Games/PS3 => 40
     90 - Games/XBOX-360 => 32
     91 - Software/PC ISO => 33
     92 - Games/PS4 => 53
     93 
     94 ## limit
     95 
     96 It can be 25, 50 or 100.
     97 
     98 ## sort
     99 
    100 It can be seeders, leechers or last
    101 
    102 ## min\_seeders
    103 
    104 ## min\_leechers
    105 
    106 ## ranked
    107 
    108 This marks if you want to get all indexed torrents or just the ones from rarbg team.
    109 Defaults to all (0).
    110 
    111 # METHODS
    112 
    113 ## new
    114 
    115 Just a simple constructor.
    116 
    117 ## search
    118 
    119 Makes a call to the API in 'search' mode. It returns either a Rarbg::torrentapi::Error or an array of [Rarbg::torrentapi::Res](https://metacpan.org/pod/Rarbg::torrentapi::Res).
    120 
    121 ## list
    122 
    123 Makes a call to the API in 'list' mode. It returns either a Rarbg::torrentapi::Error or an array of [Rarbg::torrentapi::Res](https://metacpan.org/pod/Rarbg::torrentapi::Res).
    124 
    125 # AUTHORS
    126 
    127 Paco Esteban <paco@onna.be>
    128 Baptiste C. [https://github.com/baptistecdr](https://github.com/baptistecdr)
    129 
    130 # COPYRIGHT
    131 
    132 Copyright 2015- Paco Esteban
    133 
    134 # LICENSE
    135 
    136 This library is free software; you can redistribute it and/or modify
    137 it under the same terms as Perl itself.