jordan_bourne-sdk v1.0.1

Installing

Using NPM

npm install jordan_bourne-sdk

Using Yarn

yarn add jordan_bourne-sdk

Methods

getMovies(apiKey: String, movieOptions?: MovieOptions)

Returns list of Lord of the Rings movies accoring to passed in options

Parameters

• apiKey - Your API key from https://the-one-api.dev/
• movieOptions - Object - Optional parameter for customizing your movie search
  • limit - Number - Number of results to limit search to
  • page - Number - Page number
  • offset - Number - Offset number
  • sort - Object - Object detailing the field and direction to sort
    • field - String - One of the following fields
      • name | runtimeInMinutes | budgetInMillions | boxOfficeRevenueInMillions | academyAwardNominations | academyAwardWins | rottenTomatoesScore
    • direction - String - Sort directions
      • asc | desc
  • includeNames - String[] - List of movie names to include in results
  • excludeNames - String[] - List of movie names to exclude from results
  • maxRuntimeInMinutes - Number - Maximum runtime
  • minRuntimeInMinutes - Number - Minimum runtime
  • runtimeInMinutes - Number - Exact runtime
  • maxBudgetInMillions - Number - Maximum budget in millions
  • minBudgetInMillions - Number - Minimum budget in millions
  • budgetInMillions - Number - Exact budget in millions
  • maxBoxOfficeRevenueInMillions - Number - Maximum box office revenue in millions
  • minBoxOfficeRevenueInMillions - Number - Minimum box office revenue in millions
  • boxOfficeRevenueInMillions - Number - Exact box office revenue in millions
  • maxAcademyAwardNominations - Number - Maximum Academy Award nominations
  • minAcademyAwardNominations - Number - Minimum Academy Award nominations
  • academyAwardNominations - Number - Exact Academy Award nominations
  • maxAcademyAwardWins - Number - Maximum Academy Award wins
  • minAcademyAwardWins - Number - Minimum Academy Award wins
  • academyAwardWins - Number - Exact Academy Award wins
  • maxRottenTomatoesScore - Number - Maximum Rotten Tomatoes score
  • minRottenTomatoesScore - Number - Minimum Rotten Tomatoes score
  • rottenTomatoesScore - Number - Exact Rotten Tomatoes score

Response

• docs - Array of movies
  • _id - ID
  • academyAwardNominations - Number - Academy Award Nominations
  • academyAwardWins - Number - Academy Award Wins
  • boxOfficeRevenueInMillions - Number - Box Office Revenue in Millions
  • budgetInMillions - Number - Budget In Millions
  • name - Number - Name
  • rottenTomatoesScore - Number - Rotten Tomatoes Score
  • runtimeInMinutes - Number - Runtime In Minutes
• limit - Number - Number of movies response is limited to
• offset - Number - Offset of start of list of movies
• page - Number - Page number
• pages - Number - Total number of pages
• total - Number - Number of movies in response

Example

JavaScript

TypeScript