Git Product home page Git Product logo

nyaa-api's Introduction

Nyaa-si

This is an unofficial API for nyaa - https://nyaa.si or https://nyaa.land or whatever domain you want to use. This allows you to search for torrents by name, category, or even user. Use at your own risk.

npm npm NPM

Install

npm install --save nyaa-si
yarn add nyaa-si
pnpm add nyaa-si

Usage

const Nyaa = require('nyaa-si'); // or import Nyaa from 'nyaa-si'

const options = {
    baseUrl: 'https://nyaa.si', // or https://nyaa.land or whatever domain you want to use
    mode: 'html', // or "rss"
}; // this is optional

const nyaa = new Nyaa(options);

const queryOptions = {
    page: 1,
    category: 'all', // all, anime, audio, literature, live-action, pictures, software, games
    filter: 'no filter', // no filter, trusted only, no remakes
    sort: 'date', // date, downloads, size, seeders, leechers, comments
    order: 'desc', // desc, asc
};

// Search for torrents
const result = await nyaa.search('One Piece', queryOptions);
/**
 * {
 *      data:[
 *          {
 *          id: 000000,
 *          name: 'One Piece by Oda',
 *          date: 2023-08-13T04:20:50.000Z,
 *          seeders: 69,
 *          leechers: 69420,
 *          downloads: 6969,
 *          magnet: 'magnet:?xt=urn:btih:a5fe...',
 *          size: '507.6 MiB',
 *          category: 'Anime - English-translated',
 *          }, ...
 *     ],
 *     total: 100,
 *     page: 1,
 *     totalPage: 10,
 *     perPage: 75
 *     totalPage: 2,
 *     range: 1-75
 *     nextPage: true,
 *     timeTaken: 0.69
 * }
 */

API

search(query, options)

Search for torrents.

query

Type: string

The search query.

options

Type: object

The search options.

{
    "page": 1,
    "category": "all", // all, anime, audio, literature, live-action, pictures, software, games
    "filter": "no filter", // no filter, trusted only, no remakes
    "sort": "date", // date, downloads, size, seeders, leechers, comments
    "order": "desc" // desc, asc
}

searchByUser(username, options)

Search for torrents by user.

username

Type: string

The username.

options

Type: object

The search options.

{
    "page": 1,
    "category": "all", // all, anime, audio, literature, live-action, pictures, software, games
    "filter": "no filter", // no filter, trusted only, no remakes
    "sort": "date", // date, downloads, size, seeders, leechers, comments
    "order": "desc", // desc, asc
    "query": "One Piece" // The search query
}

TODO

  • Add support for sorting by various fields
  • Add support for searching by category
  • Add support for searching by user
  • Add pagination support - still partial support (only for html and normal query)
  • Add sukebei support
  • Write tests for apis - Added partial tests

License

MIT ©

Disclaimer

This is an unofficial API for nyaa. I am not affiliated with nyaa in any way. Use at your own risk.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

nyaa-api's People

Contributors

sayeed205 avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Forkers

n-sudy

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.