letterboxd-api
v1.0.2
Published
get public diary data for letterboxd users
Downloads
3
Readme
letterboxd-api
get public data for letterboxd users
currently only consumes the RSS feeds from letterboxd, when API is released this will be used
This project is not affiliated with letterboxd
It's also a fork of letterboxd by zaccolley with added support for typescript
Much love for the original author <3
installation
npm install letterboxd-api
Usage
function(username, [callback])
Returns a promise if no callback is provided.
import letterboxd from "letterboxd-api";
letterboxd("zeromero")
.then((items) => console.log(items))
.catch((error) => console.log(error));
Example using typescript
import letterboxd from "../index";
import type { Letterboxd } from "../src/letterboxd";
letterboxd("zeromero")
.then((items) => logItems(items))
.catch((error) => console.log(error));
function logItems(items: Letterboxd[]) {
const diaryEntries = items.filter((item) => item.type === "diary");
const lists = items.filter((item) => item.type === "list");
console.log("");
console.log(`Diary entries (${diaryEntries.length}):\n`);
diaryEntries.map((diaryEntry) => {
if ("film" in diaryEntry) {
console.log(` + ${diaryEntry.film.title} (${diaryEntry.uri})\n`);
}
});
console.log(`\nLists (${lists.length}):\n`);
lists.map((list) => {
if ("title" in list) {
console.log(` + ${list.title} (${list.uri})\n`);
}
});
console.log("");
}
output
output is an array of items.
there are two types of items: diary entries and lists.
due to the limitation of the data source (scraping a RSS feed), only the 20 most recent diary entries are returned
items of note for the list type:
ranked
: shows if it was set to ranked (1, 2, 3, 4).films
: films in the list, capped at 10totalFilms
: the total amount of films in the list, only 10 films are given here.
[
{
type: "diary",
film: {
title: "Zootopia",
year: "2016",
image: { tiny: "...", small: "...", medium: "...", large: "..." },
},
rating: { text: "★★★★", score: 4 },
review: "proper cute, funny and interesting through out. ...",
spoilers: false,
isRewatch: false,
date: { watched: 1463702400000, published: 1463784779000 },
uri: "https://letterboxd.com/zaccolley/film/zootopia/",
},
//...
{
type: "list",
date: {
published: 1473470608000,
},
title: "All The Toy Stories",
description: "I fucking love these films lol",
ranked: false,
films: [
{ title: "Toy Story", uri: "https://letterboxd.com/film/toy-story/" },
{ title: "Toy Story 2", uri: "https://letterboxd.com/film/toy-story-2/" },
{ title: "Toy Story 3", uri: "https://letterboxd.com/film/toy-story-3/" },
{
title: "Toy Story That Time Forgot",
uri: "https://letterboxd.com/film/toy-story-that-time-forgot/",
},
{
title: "Toy Story of Terror!",
uri: "https://letterboxd.com/film/toy-story-of-terror/",
},
],
totalFilms: 56,
uri: "https://letterboxd.com/zaccolley/list/tiff-2016/",
},
//...
];
types
type Diary = {
type: "diary";
date: {
published: number;
watched: number;
};
film: {
title: string;
year?: string;
image?: ImageSchema;
};
rating: {
text: string;
score: number;
};
review?: string;
spoilers?: boolean;
isRewatch?: boolean;
uri: string;
};
type List = {
type: "list";
date: {
published: number;
};
title: string;
description: string;
ranked: boolean;
films: {
title: string;
uri: string;
}[];
totalFilms: number;
uri: string;
};
type ImageSchema = {
tiny?: string;
small?: string;
medium?: string;
large?: string;
};
type Letterboxd = Diary | List;