@datafire/hillbillysoftware_shinobi v4.0.0

@datafire/hillbillysoftware_shinobi

Client library for shinobiapi

Installation and Usage

npm install --save @datafire/hillbillysoftware_shinobi

let hillbillysoftware_shinobi = require('@datafire/hillbillysoftware_shinobi').create();

.then(data => {
  console.log(data);
});

Description

Actions

Actor_Get

Returns data on queried actor/actress. Result set limited to 5 records

hillbillysoftware_shinobi.Actor_Get({
  "accesstoken": "",
  "Query": ""
}, context)

Input

• input object
  • accesstoken required string
  • Query required string

Output

• output array
  • items Actor

AddActor_Post

Add new actor or actress to database

hillbillysoftware_shinobi.AddActor_Post({
  "Value": {}
}, context)

Input

• input object
  • Value required ActorPost

Output

• output PostResult

AddTVShow_Post

Add new show to database

hillbillysoftware_shinobi.AddTVShow_Post({
  "Value": {}
}, context)

Input

• input object
  • Value required TVInformationPost

Output

• output PostResult

AliasesByID_Get

Get known aliases for Movies or Television shows from passed imdbID

hillbillysoftware_shinobi.AliasesByID_Get({
  "AccessToken": "",
  "imdbID": ""
}, context)

Input

• input object
  • AccessToken required string
  • imdbID required string

Output

• output array
  • items Aliases

Aliases_Get

Get known aliases for Movies or Television shows

hillbillysoftware_shinobi.Aliases_Get({
  "AccessToken": "",
  "Title": ""
}, context)

Input

• input object
  • AccessToken required string
  • Title required string: Title of movie or television show

Output

• output array
  • items Aliases

AwardsbyWinner_Get

Gets all awards by nominiee

hillbillysoftware_shinobi.AwardsbyWinner_Get({
  "AccessToken": "",
  "Nominee": ""
}, context)

Input

• input object
  • AccessToken required string
  • Nominee required string

Output

• output array
  • items _Awards

awards_Get

Gets all awards for requested year

hillbillysoftware_shinobi.awards_Get({
  "Year": ""
}, context)

Input

• input object
  • Year required string

Output

• output array
  • items _Awards

ScheduleByDate_Get

Gets TV Schedule for selected data

hillbillysoftware_shinobi.ScheduleByDate_Get({
  "AccessToken": "",
  "Date": "",
  "Country": ""
}, context)

Input

• input object
  • AccessToken required string
  • Date required string: date format year-month-day
  • Country required string: US / CA / NL / BE / DE / GB or FR

Output

• output array
  • items schedule

CalendarCountries_Get

Returns list of available countries in calendar database

hillbillysoftware_shinobi.CalendarCountries_Get({
  "AccessToken": ""
}, context)

Input

• input object
  • AccessToken required string

Output

• output array
  • items Country

CalendarNetworks_Get

Gets a list of available networks

hillbillysoftware_shinobi.CalendarNetworks_Get({
  "AccessToken": ""
}, context)

Input

• input object
  • AccessToken required string

Output

• output array
  • items Networks

CalendarShowSeasons_Get

Returns list of seasons available in the calendar for show

hillbillysoftware_shinobi.CalendarShowSeasons_Get({
  "AccessToken": "",
  "Name": ""
}, context)

Input

• input object
  • AccessToken required string
  • Name required string

Output

• output array
  • items ShowSeasons

CalendarbyShownameSeason_Get

Get Calendar by showname and season

hillbillysoftware_shinobi.CalendarbyShownameSeason_Get({
  "AccessToken": "",
  "Name": "",
  "Season": ""
}, context)

Input

• input object
  • AccessToken required string
  • Name required string
  • Season required string

Output

• output array
  • items schedule

CalendarByShowName_Get

Will return show schedule for queried showname and year

hillbillysoftware_shinobi.CalendarByShowName_Get({
  "AccessToken": "",
  "Name": "",
  "Year": ""
}, context)

Input

• input object
  • AccessToken required string
  • Name required string
  • Year required string

Output

• output array
  • items schedule

CalendarToday_Get

Will return show schedule for today for all countries in database

hillbillysoftware_shinobi.CalendarToday_Get({
  "AccessToken": ""
}, context)

Input

• input object
  • AccessToken required string

Output

• output array
  • items schedule

ActorInShows_Get

Returns all shows queried actor/actress is or has been in

hillbillysoftware_shinobi.ActorInShows_Get({
  "AccessToken": "",
  "Actor": ""
}, context)

Input

• input object
  • AccessToken required string
  • Actor required string: Part of, or full name of actor

Output

• output array
  • items TVShowActor

CastByActor_Get

Returns list of show actor is appearing in

hillbillysoftware_shinobi.CastByActor_Get({
  "AccessToken": "",
  "Actor": ""
}, context)

Input

• input object
  • AccessToken required string
  • Actor required string: Full name of actor

Output

• output array
  • items TVShowActor

ActorsInTVShow_Get

Returns all actors in queried tvshow

hillbillysoftware_shinobi.ActorsInTVShow_Get({
  "accesstoken": "",
  "ShowName": ""
}, context)

Input

• input object
  • accesstoken required string
  • ShowName required string

Output

• output array
  • items TVShowActor

CrewByID_Get

Get crew list by ID

hillbillysoftware_shinobi.CrewByID_Get({
  "AccessToken": "",
  "ID": ""
}, context)

Input

• input object
  • AccessToken required string
  • ID required string: IMDBID, TVmazeID, or TVDBID

Output

• output array
  • items Crew

CrewByPerson_Get

Gets list of productions searched person is/was involved in.

hillbillysoftware_shinobi.CrewByPerson_Get({
  "AccessToken": "",
  "PersonName": ""
}, context)

Input

• input object
  • AccessToken required string
  • PersonName required string

Output

• output array
  • items Crew

CrewbyShowname_Get

Get crew list by showname

hillbillysoftware_shinobi.CrewbyShowname_Get({
  "AccessToken": "",
  "ShowName": ""
}, context)

Input

• input object
  • AccessToken required string
  • ShowName required string: Full exact showname

Output

• output array
  • items Crew

Crew_Get

Returns crew for queried show.

hillbillysoftware_shinobi.Crew_Get({
  "AccessToken": "",
  "Phrase": ""
}, context)

Input

• input object
  • AccessToken required string
  • Phrase required string: Part of, or full showname to search for

Output

• output array
  • items Crew

EpisodesByID_Get

Gets all episodes for selected ID

hillbillysoftware_shinobi.EpisodesByID_Get({
  "AccessToken": "",
  "ID": ""
}, context)

Input

• input object
  • AccessToken required string
  • ID required string: imdbID

Output

• output array
  • items Episode

EpisodesBySeason_Get

Gets list of episodes for specified imdbID and Season number

hillbillysoftware_shinobi.EpisodesBySeason_Get({
  "AccessToken": "",
  "ID": "",
  "Season": ""
}, context)

Input

• input object
  • AccessToken required string
  • ID required string: imdbID
  • Season required string: Season number

Output

• output array
  • items Episode

Episodes_Get

Gets all episodes for selected show

hillbillysoftware_shinobi.Episodes_Get({
  "AccessToken": "",
  "Showname": ""
}, context)

Input

• input object
  • AccessToken required string
  • Showname required string

Output

• output array
  • items Episode

EpisodesLastAvailableSeasonbyName_Get

Gets latest season number based on show name

hillbillysoftware_shinobi.EpisodesLastAvailableSeasonbyName_Get({
  "AccessToken": "",
  "Name": ""
}, context)

Input

• input object
  • AccessToken required string
  • Name required string

Output

• output LastAvailableSeason

EpisodesLastAvailableSeason_Get

Returns last available season number in database, based on passed imdbID

hillbillysoftware_shinobi.EpisodesLastAvailableSeason_Get({
  "AccessToken": "",
  "ID": ""
}, context)

Input

• input object
  • AccessToken required string
  • ID required string: imdbID

Output

• output LastAvailableSeason

EpisodesSeasonCount_Get

Returns number of available seasons and episodes

hillbillysoftware_shinobi.EpisodesSeasonCount_Get({
  "AccessToken": "",
  "ID": ""
}, context)

Input

• input object
  • AccessToken required string
  • ID required string: imdbID

Output

• output TVShowSeasons

GetIMDBid_GetAsync

Gets list of avaiable IMDB ids from Movies and TV Show databases, you can use those to query other end points that need ID's

hillbillysoftware_shinobi.GetIMDBid_GetAsync({
  "AccessToken": "",
  "Query": ""
}, context)

Input

• input object
  • AccessToken required string
  • Query required string

Output

• output array
  • items imdbID

Images_Get

Get images available for movie/tv show with passed imdbID

hillbillysoftware_shinobi.Images_Get({
  "AccessToken": "",
  "imdbID": ""
}, context)

Input

• input object
  • AccessToken required string
  • imdbID required string

Output

• output array
  • items imdbImages

ImageSearch_Get

Get images available for movie/tv show with passed query

hillbillysoftware_shinobi.ImageSearch_Get({
  "Accesstoken": "",
  "Query": ""
}, context)

Input

• input object
  • Accesstoken required string
  • Query required string: Name or part of name from Movie or Show
  • Strictmatch boolean

Output

• output array
  • items imdbImages

MagnetsByDate_GetAsync

Gets available magnet hashes on passed date (yyyy-mm-dd). Feature not available on free plan, please donate to be able to use this feature.

hillbillysoftware_shinobi.MagnetsByDate_GetAsync({
  "AccessToken": "",
  "Date": ""
}, context)

Input

• input object
  • AccessToken required string
  • Date required string

Output

• output array
  • items Magnets

MagnetsByimdbID_GetAsync

Returns list of magnet hashes for passed IMDBID. Feature not available on free plan, please donate to be able to use this feature.

hillbillysoftware_shinobi.MagnetsByimdbID_GetAsync({
  "AccessToken": "",
  "imdbID": ""
}, context)

Input

• input object
  • AccessToken required string
  • imdbID required string: ID with or without tt prefix

Output

• output array
  • items Magnets

magnetsMovieByID_GetAsync

Try and find magnet links for queried movie. Feature not available on free plan, please donate to be able to use this feature

hillbillysoftware_shinobi.magnetsMovieByID_GetAsync({
  "AccessToken": "",
  "Query": ""
}, context)

Input

• input object
  • AccessToken required string
  • Query required string: Name or part of name of movie or tv show

Output

• output array
  • items Magnets

TVShowsearch_Get

Returns results based on query, Feature not available on free plan, please donate to be able to use this feature.

hillbillysoftware_shinobi.TVShowsearch_Get({
  "AccessToken": "",
  "TVShow": ""
}, context)

Input

• input object
  • AccessToken required string
  • TVShow required string

Output

• output array
  • items Magnets

MovieID_Get

hillbillysoftware_shinobi.MovieID_Get({
  "accesstoken": "",
  "imdbID": ""
}, context)

Input

• input object
  • accesstoken required string
  • imdbID required string

Output

• output MovieInformation

MovieSearch_GetAsync

Searches for movies, result set limited to 5 records

hillbillysoftware_shinobi.MovieSearch_GetAsync({
  "AccessToken": "",
  "Query": ""
}, context)

Input

• input object
  • AccessToken required string
  • Query required string

Output

• output array
  • items MovieInformation

musicAlbumArt_Get

Returns Albumart for passed AlbumID

hillbillysoftware_shinobi.musicAlbumArt_Get({
  "AccessToken": "",
  "AlbumID": ""
}, context)

Input

• input object
  • AccessToken required string
  • AlbumID required string

Output

• output AlbumArt

musicCDCovers_Get

Gets CD art for passed MusicBrainzID

hillbillysoftware_shinobi.musicCDCovers_Get({
  "AccessToken": "",
  "MBID": ""
}, context)

Input

• input object
  • AccessToken required string
  • MBID required string: MusicBrainzID

Output

• output array
  • items CDCoverArt

MusicByMusicBrainz_Get

Get Artist / Band information on MusicBrainzID

hillbillysoftware_shinobi.MusicByMusicBrainz_Get({
  "AccessToken": "",
  "MBID": ""
}, context)

Input

• input object
  • AccessToken required string
  • MBID required string: MusicBrainzID

Output

• output array
  • items BandInfo

musicAlbums_Get

Get albums from passed ArtistID

hillbillysoftware_shinobi.musicAlbums_Get({
  "AccessToken": "",
  "ArtistID": ""
}, context)

Input

• input object
  • AccessToken required string
  • ArtistID required string: ID of artist or band to retrieve albums from

Output

• output array
  • items BandAlbums

musicCoverArt_Get

Retrieves artist / band Banner and logo based on ArtistID

hillbillysoftware_shinobi.musicCoverArt_Get({
  "AccessToken": "",
  "ArtistID": ""
}, context)

Input

• input object
  • AccessToken required string
  • ArtistID required string: ArtistID of artist or band

Output

• output ArtistArt

musicCoverArtByName_Get

Retrieves artist / band Banner and logo based on artist or bandname

hillbillysoftware_shinobi.musicCoverArtByName_Get({
  "AccessToken": "",
  "Name": ""
}, context)

Input

• input object
  • AccessToken required string
  • Name required string: Name of artist or band

Output

• output ArtistArt

musicArtistExtended_Get

Provides extended information, which includes all known albums and music videos of artist / band

hillbillysoftware_shinobi.musicArtistExtended_Get({
  "AccessToken": "",
  "Name": ""
}, context)

Input

• input object
  • AccessToken required string
  • Name required string

Output

• output array
  • items BandInfoExtended

Music_Get

Get information about passed band name or artist

hillbillysoftware_shinobi.Music_Get({
  "AccessToken": "",
  "Name": ""
}, context)

Input

• input object
  • AccessToken required string
  • Name required string: Name (or part) of band or artist name

Output

• output array
  • items BandInfo

musicLyricsbyAlbumID_Get

Returns all lyrics for requested AlbumID

hillbillysoftware_shinobi.musicLyricsbyAlbumID_Get({
  "AccessToken": "",
  "AlbumID": ""
}, context)

Input

• input object
  • AccessToken required string
  • AlbumID required string

Output

• output array
  • items Lyric

musicLyrics_Get

Get lyrics for band or artist (record set limited to 25)

hillbillysoftware_shinobi.musicLyrics_Get({
  "AccessToken": "",
  "Name": ""
}, context)

Input

• input object
  • AccessToken required string
  • Name required string: Name (or partial) of band or artist (record set limited to 25)

Output

• output array
  • items Lyric

musicLyricsBySong_Get

Get lyrics on song title

hillbillysoftware_shinobi.musicLyricsBySong_Get({
  "AccessToken": "",
  "Song": ""
}, context)

Input

• input object
  • AccessToken required string
  • Song required string: Name or part of song name

Output

• output array
  • items Lyric

musicTracks_Get

Get all tracks from requested album

hillbillysoftware_shinobi.musicTracks_Get({
  "AccessToken": "",
  "AlbumID": ""
}, context)

Input

• input object
  • AccessToken required string
  • AlbumID required string: AlbumID (can be retrieved via album endpoint)

Output

• output array
  • items AlbumTracks

MusiVideos_Get

Lists all videos available for this Artist / Band

hillbillysoftware_shinobi.MusiVideos_Get({
  "AccessToken": "",
  "ArtistID": ""
}, context)

Input

• input object
  • AccessToken required string
  • ArtistID required string

Output

• output array
  • items MusicVideo

Rating_Get

Returns ratings from various resources(IMDB,Rotten Tomatoes, metaCritics, TVMaze etc) of passed IMDBid

hillbillysoftware_shinobi.Rating_Get({
  "AccessToken": "",
  "imdbID": ""
}, context)

Input

• input object
  • AccessToken required string
  • imdbID required string

Output

• output RatingItem

RatingByName_Get

hillbillysoftware_shinobi.RatingByName_Get({
  "AccessToken": "",
  "Name": ""
}, context)

Input

• input object
  • AccessToken required string
  • Name required string

Output

• output array
  • items RatingItem

ShowStatus_Get

Returns status of queried show (query can be IMDB, TVDB, or showname)

hillbillysoftware_shinobi.ShowStatus_Get({
  "AccessToken": "",
  "Query": ""
}, context)

Input

• input object
  • AccessToken required string
  • Query required string: Query can be IMDB, TVDB, or Show name

Output

• output array
  • items _ShowStatus

TVShowID_Get

Returns TVShow information based on IMDBid

hillbillysoftware_shinobi.TVShowID_Get({
  "accesstoken": "",
  "id": "",
  "imdbID": ""
}, context)

Input

• input object
  • accesstoken required string
  • id required string: imdbID of show you want info on
  • imdbID required string

Output

• output TVInformation

TVShowByName_Get

Returns results based on query, result set limited to 5 records

hillbillysoftware_shinobi.TVShowByName_Get({
  "AccessToken": "",
  "Query": ""
}, context)

Input

• input object
  • AccessToken required string
  • Query required string

Output

• output array
  • items TVInformation

TrailersbyID_Get

Get Trailers for passed imdbID

hillbillysoftware_shinobi.TrailersbyID_Get({
  "AccessToken": "",
  "imdbID": ""
}, context)

Input

• input object
  • AccessToken required string
  • imdbID required string

Output

• output array
  • items Trailer

TrailerCountByID_Get

Get trailer count for passed ID

hillbillysoftware_shinobi.TrailerCountByID_Get({
  "AccessToken": "",
  "imdbID": ""
}, context)

Input

• input object
  • AccessToken required string
  • imdbID required string

Output

• output TrailerCount

TrailerCountByName_Get

Get trailer count for passed name (Movie title or TVShow name)

hillbillysoftware_shinobi.TrailerCountByName_Get({
  "AccessToken": "",
  "Name": ""
}, context)

Input

• input object
  • AccessToken required string
  • Name required string

Output

• output TrailerCount

TrailerSearch_Get

Gets trailers by search phrase (limited to 10 records)

hillbillysoftware_shinobi.TrailerSearch_Get({
  "AccessToken": "",
  "Phrase": ""
}, context)

Input

• input object
  • AccessToken required string
  • Phrase required string: Trailer you like to search for

Output

• output array
  • items Trailer

Definitions

Actor

• Actor object
  • Bio string
  • BirthYear string
  • DeathYear string
  • Gender string
  • Name string
  • PopularityIndex string
  • ProfileImage string

ActorPost

• ActorPost object
  • AccessToken string
  • Bio string
  • BirthYear string
  • DeathYear string
  • Gender string
  • Name string
  • PopularityIndex string
  • ProfileImage string

AlbumArt

• AlbumArt object
  • AlbumID string
  • Albumname string
  • Art string

AlbumTracks

• AlbumTracks object
  • AlbumID string
  • ArtistID string
  • Length string
  • TrackName string
  • TrackNo string

Aliases

• Aliases object
  • Aka string
  • ExternalIDs array
    • items ExternalIDs
  • Name string
  • OriginalName string

ArtistArt

• ArtistArt object
  • ArtistID string
  • Banner string
  • Logo string
  • Name string

BandAlbums

• BandAlbums object
  • AlbumArt string
  • AlbumID string
  • ArtistID string
  • Bibliography string
  • Label string
  • Name string
  • Releaseyear string

BandInfo

• BandInfo object
  • ArtistID string
  • Banner string
  • Biography string
  • DisbandedYear string
  • FormationYear string
  • Genre string
  • Logo string
  • Members string
  • MusicBrainzID string
  • Name string
  • SocialMedia string
  • WebSite string

BandInfoExtended

• BandInfoExtended object
  • Albums array
    • items BandAlbums
  • ArtistID string
  • Banner string
  • Biography string
  • DisbandedYear string
  • FormationYear string
  • Genre string
  • Logo string
  • Members string
  • MusicBrainzID string
  • Name string
  • SocialMedia string
  • Videos array
    • items MusicVideo
  • WebSite string

CDCoverArt

• CDCoverArt object
  • CoverImage string
  • CoverThumbMedium string
  • CoverThumbSmall string
  • CoverType string
  • MusicBrainzID string

Country

• Country object
  • Name string

Crew

• Crew object
  • Externals array
    • items ExternalIDs
  • Image string
  • Name string
  • ShowName string
  • Type string

Episode

• Episode object
  • Airdate string
  • Airtime string
  • EpisodeNo string
  • Externals array
    • items ExternalIDs
  • Image string
  • Season string
  • Synopsis string
  • Title string

ExternalIDs

• ExternalIDs object
  • ID string
  • Name string

LastAvailableSeason

• LastAvailableSeason object
  • Season string

Lyric

• Lyric object
  • AlbumID string
  • Artist string
  • Lyrics string
  • Song string

Magnets

• Magnets object
  • Externals array
    • items ExternalIDs
  • FirstSeenDate string: Date this hash was first detected
  • Hash string: The actual hash you need to construct your magnet
  • Image string
  • Name string
  • Peers string: Number of Peers available at FirstSeenDate
  • Seeds string: Number of Seeds available at FirstSeenDate
  • Size string
  • Title string
  • Type string

MovieInformation

• MovieInformation object
  • ID string
  • ImdbID string
  • ReleaseYear string
  • Runtime string
  • Synopsis string
  • Title string

MusicVideo

• MusicVideo object
  • AlbumID string
  • ArtistID string
  • Decription string
  • Video string

Networks

• Networks object
  • Country string
  • Network string

PostResult

• PostResult object
  • Status string

RatingItem

• RatingItem object
  • EpisoDate string
  • IMDB string
  • MetaCritics string
  • Name string
  • RottenTomatoes string
  • RottenTomatoesAudienceScore string
  • TVDB string
  • TVMaze string
  • Trakt string
  • imdbID string

ShowSeasons

• ShowSeasons object
  • Year string

TVInformation

• TVInformation object
  • EpisodeCount string
  • EpisodeRuntime string
  • Externals array
    • items ExternalIDs
  • ID string
  • ReleaseYear string
  • Seasons string
  • ShowImage string
  • ShowStatus string
  • Synopsis string
  • Title string

TVInformationPost

• TVInformationPost object
  • AccessToken string
  • EpisodeCount string
  • EpisodeRuntime string
  • Genres string
  • ImdbID string
  • PremierYear string
  • Seasons string
  • ShowImage string
  • ShowStatus string
  • Synopsis string
  • Title string

TVShowActor

• TVShowActor object
  • Externals array
    • items ExternalIDs
  • Image string
  • Name string
  • Role string
  • ShowName string

TVShowSeasons

• TVShowSeasons object
  • Episodes string
  • Externals array
    • items ExternalIDs
  • Seasons string
  • Showname string

Trailer

• Trailer object
  • Episode string
  • Key string: Key for trailer, usually end part of uri for youtube links
  • MediaType string: Returns Media Type, either C (Channel) T (Television) or M (Movie)
  • Season string
  • Site string
  • TrailerName string
  • TrailerSize string
  • TrailerType string: Returns Trailer type (trailer, teaser, channel, episode,credits, clip etc)
  • YouTubeEmbeddedCode string
  • YouTubeURL string

TrailerCount

• TrailerCount object
  • Count integer

_Awards

• _Awards object
  • Category string
  • Nominee string
  • Type string
  • Winner string
  • Year string

_ShowStatus

• _ShowStatus object
  • Enddate string
  • ID string
  • Title string
  • YearsOn string
  • imdbID string
  • status string
  • tvdbID string

imdbID

• imdbID object
  • ID string
  • ShinobiID string
  • Title string
  • Type string

imdbImages

• imdbImages object
  • Backdrops array
    • items string
  • Posters array
    • items string
  • Type string
  • imdbID string

schedule

• schedule object
  • AirDate string
  • AirTime string
  • Country string
  • DaysOn string
  • Episode string
  • ID string
  • Image string
  • Network string
  • PremiereDate string
  • Runtime string
  • Season string
  • ShowName string
  • Summary string
  • Title string