jordan_bourne-sdk
v1.0.1
Published
Hello World
Downloads
1
Readme
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 searchlimit
-Number
- Number of results to limit search topage
-Number
- Page numberoffset
-Number
- Offset numbersort
-Object
- Object detailing the field and direction to sortfield
-String
- One of the following fieldsname
|runtimeInMinutes
|budgetInMillions
|boxOfficeRevenueInMillions
|academyAwardNominations
|academyAwardWins
|rottenTomatoesScore
direction
-String
- Sort directionsasc
|desc
includeNames
-String[]
- List of movie names to include in resultsexcludeNames
-String[]
- List of movie names to exclude from resultsmaxRuntimeInMinutes
-Number
- Maximum runtimeminRuntimeInMinutes
-Number
- Minimum runtimeruntimeInMinutes
-Number
- Exact runtimemaxBudgetInMillions
-Number
- Maximum budget in millionsminBudgetInMillions
-Number
- Minimum budget in millionsbudgetInMillions
-Number
- Exact budget in millionsmaxBoxOfficeRevenueInMillions
-Number
- Maximum box office revenue in millionsminBoxOfficeRevenueInMillions
-Number
- Minimum box office revenue in millionsboxOfficeRevenueInMillions
-Number
- Exact box office revenue in millionsmaxAcademyAwardNominations
-Number
- Maximum Academy Award nominationsminAcademyAwardNominations
-Number
- Minimum Academy Award nominationsacademyAwardNominations
-Number
- Exact Academy Award nominationsmaxAcademyAwardWins
-Number
- Maximum Academy Award winsminAcademyAwardWins
-Number
- Minimum Academy Award winsacademyAwardWins
-Number
- Exact Academy Award winsmaxRottenTomatoesScore
-Number
- Maximum Rotten Tomatoes scoreminRottenTomatoesScore
-Number
- Minimum Rotten Tomatoes scorerottenTomatoesScore
-Number
- Exact Rotten Tomatoes score
Response
docs
- Array of movies_id
- IDacademyAwardNominations
-Number
- Academy Award NominationsacademyAwardWins
-Number
- Academy Award WinsboxOfficeRevenueInMillions
-Number
- Box Office Revenue in MillionsbudgetInMillions
-Number
- Budget In Millionsname
-Number
- NamerottenTomatoesScore
-Number
- Rotten Tomatoes ScoreruntimeInMinutes
-Number
- Runtime In Minutes
limit
-Number
- Number of movies response is limited tooffset
-Number
- Offset of start of list of moviespage
-Number
- Page numberpages
-Number
- Total number of pagestotal
-Number
- Number of movies in response
Example
JavaScript
TypeScript