Rust API client for The Movie Database (TMDB)

Overview

This API client was generated by the OpenAPI Generator project, with a custom tmdb_oas.json OAS file.

• API version: 3
• Package version: 1.8.0
• Build package: org.openapitools.codegen.languages.RustClientCodegen

Features

• Almost all API functions are supported.
• From 1.5.0 version, library provides helper functions to download and parse TMDB ids from daily exports (requires daily-exports feature from 1.8.0).
• From 1.6.0 version, rate limiter is removed, since TMDB does not have rate limit anymore.
• From 1.7.0 version, error implements std::error::Error.
• From 1.8.0 version, TLS backend selection and daily exports becomes an optional feature.

Known issues

• All API functions have not been tested. Since the OAS file used for generation is not official, there can be missing fields/methods.
• Generated code is not fluent. All API parameters are required in call functions.

Installation

Add the following to Cargo.toml under [dependencies]:

tmdb_client = "1.8.0"

Optional Features (from version 1.8.0)

SSL/TLS Backend

By default, the library uses native-tls for SSL/TLS connections. You can choose an alternative TLS implementation by disabling default features and selecting the desired backend:

Using rustls instead of native-tls:

tmdb_client = { version = "1.8.0", default-features = false, features = ["rustls-tls"] }

Available TLS backends:

• native-tls (default) - Uses the platform's native TLS implementation
• rustls-tls - Pure Rust TLS implementation

Daily Exports

The daily-exports feature enables helper functions to download and parse TMDB's daily export files (gzipped JSON files containing entity IDs). This feature is optional and adds the flate2 dependency for decompression.

Enable daily exports:

tmdb_client = { version = "1.8.0", features = ["daily-exports"] }

Usage example:

use tmdb_client::files::exports;
use chrono::NaiveDate;

let date = NaiveDate::from_ymd_opt(2024, 1, 15).unwrap();
let movie_ids = exports::get_movie_ids(date)?;

Combine features:

# Use rustls with daily exports
tmdb_client = { version = "1.8.0", default-features = false, features = ["rustls-tls", "daily-exports"] }

Usage example

use tmdb_client::apis::Error;
use tmdb_client::apis::client::APIClient;
use tmdb_client::models::MoviePaginated;

fn search_movie() -> Result<MoviePaginated, Error> {
    let client = APIClient::new_with_api_key("###TMDB_API_KEY###");
    // Parameters: title, year, primary_release_year, language, page, include_adult, region
    client.search_api().get_search_movie_paginated("Movie title", None, None, None, None, None, None)
}

Documentation for API Endpoints

All URIs are relative to https://api.themoviedb.org/3

Documentation For Models

• AccessTokenBody
• AccountDetails
• AccountStates
• AccountdetailsAvatar
• AccountdetailsAvatarGravatar
• AlternativeNamesList
• AlternativenameslistResults
• AlternativetitleslistItem
• Cast
• CastDetails
• Certification
• Certifications
• CertificationsCertifications
• ChangeDetails
• ChangedetailsChanges
• ChangedetailsItems
• ChangesObject
• ChangesPaginated
• CollectionObject
• CollectionPaginated
• CollectionPart
• CompanyDetails
• CompanyObject
• CompanyPaginated
• Configuration
• ConfigurationImages
• Creator
• Credit
• CreditMedia
• CreditMediaSeasons
• CreditPerson
• Credits
• Crew
• CrewDetails
• EpisodeDetails
• EpisodeGroupDetails
• EpisodeGroupGroup
• EpisodeGroupList
• EpisodeGroupObject
• EpisodeRatingList
• EpisoderatinglistRated
• EpisoderatinglistResults
• ExternalIds
• FindByExternalIdResults
• Genre
• GenresList
• GuestSessionResponse
• GuestStar
• Image
• Images
• ItemStatus
• Jobs
• Keyword
• KeywordPaginated
• KeywordsList
• ListBody
• ListDetails
• ListObject
• ListStatusResponse
• ListsPaginated
• MediaFavoriteBody
• MediaIdBody
• MediaType
• MediaWatchlistBody
• MovieAlternativeTitlesList
• MovieDetails
• MovieObject
• MoviePaginated
• MovieobjectDates
• Network
• PersonCredits
• PersonDetails
• PersonObject
• PersonPaginated
• PersonTaggedImagesPaginated
• RatingsList
• RatingslistResults
• ReleaseDate
• ReleaseDatesList
• ReleasedateslistResults
• Review
• ReviewObject
• ReviewsPaginated
• SearchMultiResultsPaginated
• SeasonDetails
• SeasonEpisodeIds
• SeasonEpisodeList
• SeasonObject
• SessionResponse
• StatusCodeMessage
• SuccessResponse
• TaggedImage
• Timezones
• TokenResponse
• TokenResponseWithExpiration
• Translation
• TranslationData
• TranslationsList
• TvAlternativeTitlesList
• TvDetails
• TvEpisodeObject
• TvEpisodesPaginated
• TvObject
• TvPaginated
• ValueBody
• Video
• VideosList

To get access to the crate's generated documentation, use:

cargo doc --open

Author