Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vankasteelj/trakt.tv
A Trakt.tv API wrapper for Node.js
https://github.com/vankasteelj/trakt.tv
nodejs trakt wrapper-api
Last synced: 18 days ago
JSON representation
A Trakt.tv API wrapper for Node.js
- Host: GitHub
- URL: https://github.com/vankasteelj/trakt.tv
- Owner: vankasteelj
- Created: 2015-11-18T04:39:24.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-08-11T08:18:30.000Z (over 1 year ago)
- Last Synced: 2024-10-25T18:29:15.984Z (23 days ago)
- Topics: nodejs, trakt, wrapper-api
- Language: JavaScript
- Size: 172 KB
- Stars: 142
- Watchers: 8
- Forks: 32
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# trakt.tv
**Trakt.tv API wrapper for Node.js, featuring:**
- [All Trakt.tv API v2 methods](docs/available_methods.md)
- [Plugin extension](docs/plugins.md)
*For more information about the trakt.tv API, read http://docs.trakt.apiary.io/*
## Example usage
#### Setup
npm install trakt.tv
#### Initialize
```js
const Trakt = require('trakt.tv');
let options = {
client_id: ,
client_secret: ,
redirect_uri: null, // defaults to 'urn:ietf:wg:oauth:2.0:oob'
api_url: null, // defaults to 'https://api.trakt.tv'
useragent: null, // defaults to 'trakt.tv/'
pagination: true // defaults to false, global pagination (see below)
};
const trakt = new Trakt(options);
```
Add `debug: true` to the `options` object to get debug logs of the requests executed in your console.
#### OAUTH
1. Generate Auth URL
```js
const traktAuthUrl = trakt.get_url();
```
2. Authentication is done at that URL, it redirects to the provided uri with a code and a state
3. Verify code (and optionally state for better security) from returned auth, and get a token in exchange
```js
trakt.exchange_code('code', 'csrf token (state)').then(result => {
// contains tokens & session information
// API can now be used with authorized requests
});
```
#### Alternate OAUTH "device" method
```js
trakt.get_codes().then(poll => {
// poll.verification_url: url to visit in a browser
// poll.user_code: the code the user needs to enter on trakt
// verify if app was authorized
return trakt.poll_access(poll);
}).catch(error => {
// error.message == 'Expired' will be thrown if timeout is reached
});
```
#### Refresh token
```js
trakt.refresh_token().then(results => {
// results are auto-injected in the main module cache
});
```
#### Storing token over sessions
```js
// get token, store it safely.
const token = trakt.export_token();
// injects back stored token on new session.
trakt.import_token(token).then(newTokens => {
// Contains token, refreshed if needed (store it back)
});
```
#### Revoke token
```js
trakt.revoke_token();
```
#### Actual API requests
See methods in [methods.json](methods.json) or [the docs](docs/available_methods.md).
```js
trakt.calendars.all.shows({
start_date: '2015-11-13',
days: '7',
extended: 'full'
}).then(shows => {
// Contains Object{} response from API (show data)
});
```
```js
trakt.search.text({
query: 'tron',
type: 'movie,person'
}).then(response => {
// Contains Array[] response from API (search data)
});
```
```js
trakt.search.id({
id_type: 'imdb',
id: 'tt0084827'
}).then(response => {
// Contains Array[] response from API (imdb data)
});
```
#### Using pagination
You can extend your calls with `pagination: true` to get the extra pagination info from headers.
```js
trakt.movies.popular({
pagination: true
}).then(movies => {
/**
movies = Object {
data: [],
pagination: {
item-count: "80349",
limit: "10",
page: "1",
page-count: "8035"
}
}
**/
});
```
Note: _this will contain `data` and `pagination` for all calls, even if no pagination is available (`result.pagination` will be `false`). it's typically for advanced use only_
#### Load plugins
When calling `new Trakt()`, include desired plugins in an object (must be installed from npm):
```js
const trakt = new Trakt({
client_id: ,
client_secret: ,
plugins: { // load plugins
images: require('trakt.tv-images')
}
options: { // pass options to plugins
images: {
smallerImages: true
}
}
});
```
The plugin can be accessed with the key you specify. For example `trakt.images.get()`.
#### Write plugins
See the [documentation](docs/writing_plugins.md).
#### Notes
- You can use 'me' as username if the user is authenticated.
- Timestamps (such as token _expires_ property) are Epoch in milliseconds.
## LICENSE
The MIT License (MIT) - author: Jean van Kasteel
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.