https://github.com/stylesuxx/yts.to

NPM module for the yts.to API
https://github.com/stylesuxx/yts.to

Last synced: about 1 month ago
JSON representation

NPM module for the yts.to API

• Host: GitHub
• URL: https://github.com/stylesuxx/yts.to
• Owner: stylesuxx
• Created: 2015-10-11T15:41:04.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-10-15T10:06:40.000Z (about 8 years ago)
• Last Synced: 2024-10-05T08:09:23.342Z (about 1 month ago)
• Language: JavaScript
• Size: 207 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# yts.to API wrapper

[![Build pass](https://travis-ci.org/stylesuxx/yts.to.svg?branch=master)](https://travis-ci.org/stylesuxx/yts.to?branch=master)  [![Dependencies](https://david-dm.org/stylesuxx/yts.to.svg)](https://david-dm.org/stylesuxx/yts.to)

This is a *JavaScript* wrapper for the [yts.to API](https://yts.to/api) that returns promises.

Calls to the classes methods return promises. All [API](https://yts.to/api) functionality is wrapped.

The parameters for the methods are the mandatory fields. Where optional fields may be passed this may be done via options object. For optional parameters please refer to the [yts.to API documentation](https://yts.to/api). JSON is returned directly as the API returns it. The interesting content is in the *data* field of the response.

## Installation

    npm install yts.to --save

## Usage example

``` JavaScript

var YTS = require('yts.to');

var yts = new YTS();

yts.findMovie('Snatch', {with_rt_ratings: true}).then( function(movies) {

  console.log(movies);

});

```

## Available methods

The *YTS* class provides the following methods:

### public accessible endpoints

* findMovie(searchString, options = {})

* getDetails(movieId, options = {})

* getSuggestions(movieId)

* getComments(movieId)

* getReviews(movieId)

* getParentalGuides(movieId)

* getUpcoming()

* getUserDetails(userId, options = {})

### Require application and/or user key

* getUserKey(username, password, applicationId)

* getUserProfile(userKey)

* editUserSettings(userKey, applicationKey, options = {})

* registerUser(applicationKey, username, password, email)

* forgotPassword(applicationKey, email)

* resetPassword(resetCode, newPassword, applicationKey)

* likeMovie(userKey, movieId, applicationKey)

* getBookmarks(userKey, options = {})

* addBookmark(userKey, movieId, applicationKey)

* deleteBookmark(userKey, movieId, applicationKey)

* makeComment(userKey, movieId, commentText, applicationKey)

* likeComment(userKey, commentId, applicationKey)

* reportComment(userKey, commentId, applicationKey)

* deleteComment(userKey, commentId, applicationKey)

* makeRequest(userKey, movieTitle, applicationKey, options = {})

## Testing

An extensive test suite is provided and may be invoked by running:

    npm run test