calikevuche / lotr-sdk

This SDK makes it easier to interact with the Lord of the Rings API to retrieve information about movies and quotes

Lord of the Rings SDK

Looking to explore the wonders of Middle Earth? Uchenna's The Lord of the Rings SDK has got you covered! With this user-friendly SDK, you can easily interact with the Lord of the Rings API to retrieve information about movies and quotes. We have support for filter, pagination, and more! Whether you're a die-hard fan or just starting your journey, the Uchenna's LotR SDK makes it easy to access the fascinating world of Middle Earth.

Easy Installation like a Wizard of Middle Earth

To install the SDK, run:

npm install uche-lotr-sdk

Compile locally, if you dare!

To compile the SDK, run:

npm run compile

Run locally, at your own peril

To run the SDK locally, take a look at the example script and run:

node local_run.js

Run tests

To execute the tests, run:

npm run test

How to use the client like Gandalf

Import the LotrAPIClient class and create an instance with your API key:

import { LotrSDK } from 'uche-lotr-sdk';

const apiKey = 'LOTR-API-KEY';
const LotrClient = new LotrSDK(apiKey);

Note: Replace 'api-key' with your actual API key! You can obtain an API key from the official Lord of the Rings API website

Quotes

Get Quotes

const quotes = await LotrClient.quotes();

Get Quote

const quoteId = '5cd96e05de30eff6ebccf124';
const quote = await LotrClient.quote(quoteId);

Movies

List Movies

const movies = await LotrClient.movies();

Get Movie

const movieId = '5cd95395de30eff6ebccde5d';
const movie = await LotrClient.movie(movieId);

Movie-Quotes

Get Movie Quotes

const movieId = '5cd95395de30eff6ebccde5d';
const quotes = await LotrClient.movieQuotes(movieId);