akintayosalu / letterboxd-client Goto Github PK

An unofficial Letterboxd API client. 📽️

• Installation
• Usage
  • User Authentication
• Available APIs
  • Auth
  • Comments
  • Contributors
  • Film Collections
  • Films
  • Lists
  • Log Entries
  • Me
  • Members
  • News
  • Search
  • Stories
• FAQ

npm install letterboxd-client

import Client from 'letterboxd-client';
// const { default: Client } = require('letterboxd-client')

const apiKey = 'your letterboxd api key';
const apiSecret = 'your letterboxd api secret';

const client = new Client(apiKey, apiSecret);
const { status, data } = await client.film.get('ljDs');

console.log(data.name) // RRR
console.log(data.tagline) // Rise Roar Revolt

To authenticate a user you will need their Letterboxd credentials (username + password), which you will supply to client.auth.requestAuthToken like so:

const { status, data } = await client.auth.requestAuthToken(username, password);

If successful you will receive back an AccessToken response that will contain the users acessToken that you can then pass back into the main Client instance in order to authenticate all API requests as that user.

Note

For all documentation on parameters or responses see the TypeScript types that we export to the package or consult https://api-docs.letterboxd.com/ for the endpoint you're using.

_{* Requires an authenticated Letterboxd user access token.}

The following methods are available on the client.auth.* namespace:

The following methods are available on the client.comment.* namespace:

The following methods are available on the client.contributor.* namespace:

The following methods are available on the client.filmCollection.* namespace:

The following methods are available on the client.film.* namespace:

The following methods are available on the client.list.* namespace:

The following methods are available on the client.logEntry.* namespace:

The following methods are available on the client.me.* namespace:

The following methods are available on the client.member.* namespace:

client.news will return you back recent news from the Letterboxd editors at https://letterboxd.com/journal/.

client.search is the main entry point for searching Letterboxd. See the parameter types or <a href="https://api-docs.letterboxd.com/#path--search>https://api-docs.letterboxd.com/#path--search for documentation.

The following methods are available on the client.story.* namespace:

https://letterboxd.com/api-beta/