ncore-api v0.6.0

ncore-api

What

It provides REST API for ncore torrent provider.

Why

As the time of the writing, ncore has no REST API at all. With the help of this package, a lot of new possibilities could be risen in terms of ncore related applications: torrent notifier, native applications ... etc.

How it works

It transforms html content to JSON output.

How it should be used

const createNcoreApi = require('ncore-api');

(async () => {
  try {
    const ncoreApi = await createNcoreApi({
      username: '', // needs to be filled
      password: '', // needs to be filled
    });
    const result = await ncoreApi.getMovies();
    console.log(result);
  } catch (error) {
    console.log(error);
  }
})();

API

getMovies

The result contains the first 25 item from movie section according to the given filters.

Parameter

It accepts only one parameter which is a filter object.

Return value

It returns an array with objects. This is how a movie object looks like:

getMovie

This returns the details of the given movie (with languages and resolutions)

Parameter

It accepts only one parameter which is a torrent id.

Return value

It returns an objects with this schema:

Versions contains objects that look like this:

getMovieByImdb

This returns the details of the movie that was searched by IMDB id.

Parameter

It accepts only one parameter which is a IMDB id.

Return value

It returns an objects with this schema:

Versions contains objects that look like this:

getTorrentFile

It returns a node.js stream that contains a torrent file.

Parameter

It accepts only one parameter which is a torrent id.

Return value

Example:

const createNcoreApi = require('ncore-api');
const { createWriteStream } = require('fs');

(async () => {
  try {
    const ncoreApi = await createNcoreApi({
      username: '*******',
      password: '*******',
      url: 'https://ncore.pro',
    });
    const result = await ncoreApi.getTorrentFile('2949391');
    result.pipe(createWriteStream('torrent.file'));
  } catch (error) {
    console.log(error);
  }
})();

Missing features

• pagination
• tv shows related endpoints