moviequotebot-api/README.md

MovieQuoteBot API

A simple API written in Rust for MovieQuoteBot that returns JSON data via HTTP.

This API is in an unstable state: it will surely change a lot.

The data Structures are like:

Except the user ids that have been redacted and removed from the API.

Endpoints

Health

You can query /health and if Healthy is returned, the API is alive.

V1

List subtitles

You can use /v1/subtitles/list to list subtitles stored in database.

Structure

• subtitles: all subtitles stored in database
• films: the films associated with these subtitles, linked by their id: subtitles.film_id -> films.id
• languages: the languages associated with these subtitles, linked by their id: subtitles.language_id -> languages.id

The time is represented using the UTC Timezone.

List subtitles

You can use /v1/languages/list to list languages stored in database.