addic7ed-subtitles-api

addic7ed-subtitles-api

API for Addic7ed subtitles.

Install

npm install addic7ed-subtitles-api --save

Usage

Following API request will display list of English language subtitles for Game of Thrones, season 6, episode 4.

var subs = require('addic7ed-subtitles-api');

subs(1245, 6, 4)
	.then(function ( subs ) {
		console.log(subs);
		/* [
			{
				"version": "AVS",
				"worksWith": [],
				"downloads": [
					{
						"type": "original",
						"url": "/original/112218/0"
					}
				],
				"referer": "/show/1245",
				"description": "NOT FOR TRANSLATIONS!",
				"stats": {
					"edits": 0,
					"downloads": 65238,
					"sequences": 701
				},
				"corrected": true,
				"hearingImpaired": true,
				"language": 1,
				"uploader": {
					"name": "elderman",
					"url": "/user/11400"
				},
				"pubDate": "2016-09-12T23:20:00.000Z",
				"completed": true
			},
			…
		] */
	});

subs.download('/original/112218/0')
	.then(function ( sub ) {
		console.log(sub);
		// <Buffer ef bb bf ... >
	});

API

subs(id, season, episode, [options])

Returns: Promise

Displays list of subtitles for show based on show ID, season and episode number.

id

Type: Integer

Addic7ed subtitles show ID.

season

Type: Integer

Season number.

episode

Type: Integer

Episode number.

options

Type: Object

language

Type: Integer|String
Default: 1 (English)

Subtitles language based on Addic7ed languages ID or locale string. Locales are mapped as close as possible to their Addic7ed ID equivalent.

subs.download(url)

Returns: Promise

Downloads subtitle from URL or reject promise if download count is exceeded. Returns Buffer with custom filename property containing proposed output filename.

url

Type: String

Addic7ed subtitle URL.

References

• Basic idea from same31/addic7ed-api project but expanded with additional functionality, proper show handling and test coverage

License

MIT © Ivan Nikolić