Skip to content

Rust client for TheTVDB API v3

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

roignpar/thetvdb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

thetvdb

crates.io Released API docs Minimum rustc version CI

TheTVDB API v3 Rust async client.

Minimum Rust version: 1.40.0

In order to use this client you will need an API key. To create a new API key log in and go to the API Keys page.

NOTE: Because it depends on reqwest, thetvdb currently only works with tokio.

Install

Add with cargo edit:

cargo add thetvdb

or add to Cargo.toml:

[dependencies]
thetvdb = "0.1.0-beta.2"

Use

Search series by title:

use thetvdb::{Client, params::SearchBy};

let client = Client::new("YOUR_API_KEY").await?;
let search_results = client.search(SearchBy::Name("Planet Earth")).await?;

For more examples check the documentation.

Supported requests:

Authentication

  • POST /login (used internally; cannot be manually requested)

Episodes

  • GET /episodes/{id}

Languages

  • GET /languages
  • GET /languages/{id}

Movies

  • GET /movies/{id}
  • GET /movieupdates

Search

  • GET /search/series

Series

  • GET /series/{id}
  • HEAD /series/{id}
  • GET /series/{id}/actors
  • GET /series/{id}/episodes
  • GET /series/{id}/episodes/query
  • GET /series/{id}/episodes/summary
  • GET /series/{id}/filter
  • GET /series/{id}/images
  • GET /series/{id}/images/query
  • GET /series/{id}/images/query/params

Updates

  • GET /updated/query

Integration tests

export THETVDB_APIKEY=<API_KEY>
cargo t --test client

License

Licensed under either of Apache License, Version 2.0 or MIT at your option.

About

Rust client for TheTVDB API v3

Topics

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Packages

No packages published

Languages