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.

Install

npm install --save nyaa-sia
yarn add nyaa-sia
pnpm add nyaa-sia
bun add nyaa-sia

Usage

import { Nyaa } from 'nyaa-sia';

const nyaa = new Nyaa({
    baseUrl: 'https://nyaa.si',
    mode: 'html',
});

const result = await nyaa.search('One Piece', {
    page: 1,
    category: 'anime',
    filter: 'no filter',
    sort: 'date',
    order: 'desc',
});

console.log(result.data);

/**
 * {
 *     data: [{ id: 1234567, name: 'One Piece', ... }],
 *     total: 100,
 *     page: 1,
 *     totalPage: 10,
 *     perPage: 75,
 *     range: '1-75',
 *     nextPage: true,
 *     timeTaken: 150
 * }
 */

API

new Nyaa(options)

Create a new Nyaa instance.

options

{
    baseUrl: 'https://nyaa.si', // The base URL of the nyaa instance
    mode: 'html', // 'html' or 'rss'
}

search(query, options)

Search for torrents.

query

Type: string

The search query.

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
}

Returns

interface SearchResult {
    data: Torrent[];
    total: number | null;
    page: number;
    totalPage: number | null;
    perPage: number;
    nextPage: boolean;
    range: string | null;
    timeTaken: number;
}

interface Torrent {
    id: number;
    name: string;
    magnet: string;
    size: string;
    category: string;
    date: Date;
    seeders: number;
    leechers: number;
    downloads: number;
    viewUrl: string;
    torrentUrl: string;
    comments: number;
}

searchByUser(username, options)

Search for torrents by user.

username

Type: string

The username.

options

{
    "page": 1,
    "category": "all",
    "filter": "no filter",
    "sort": "date",
    "order": "desc",
    "query": "One Piece"
}

view(id)

Get torrent details by ID.

id

Type: number

The torrent ID.

Returns

interface TorrentDetail {
    id: number;
    title: string;
    name: string;
    category: string;
    subCategory: string;
    date: Date;
    seeders: number;
    leechers: number;
    downloads: number;
    completed: number;
    magnet: string;
    size: string;
    hash: string;
    submitter: string;
    submitterId?: string;
    information?: string;
    description: string;
    files: TorrentFile[];
    comments: number;
}

interface TorrentFile {
    name: string;
    size: string;
}

viewFromTorrent(torrent)

Get torrent details from a Torrent object.

torrent

Type: Torrent

getCategories()

Get the list of categories.

interface Category {
    id: string;
    name: string;
    subCategories?: Category[];
}

RSS Mode

const nyaa = new Nyaa({
    baseUrl: 'https://nyaa.si',
    mode: 'rss',
});

const result = await nyaa.search('One Piece');

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.