Skip to content

Latest commit

 

History

History
1000 lines (978 loc) · 96.9 KB

README.md

File metadata and controls

1000 lines (978 loc) · 96.9 KB
Raw

Julia API client for TheMovieDB

Julia client for themoviedb.

API Read Access Token

Please apply for your themoviedb API Read Access Token first. Then paste your api key at $HOME/.config/TMDB_KEY.txt. Or save api key to TMDB_KEY environment variable.

Initialization

Before calling any interface, you need to initialize the TMDB API with init_api().

For example, get a list of movies that are currently in theatres:

julia> using TheMovieDB
julia> api = init_api()
julia> first(movie_now_playing_list(api))
{
  "dates": {
    "maximum": "2024-05-08",
    "minimum": "2024-03-27"
  },
  "page": 1,
  "results": [
    {
      "adult": false,
      "backdrop_path": "/qrGtVFxaD8c7et0jUtaYhyTzzPg.jpg",
      "genre_ids": [
        28,
        878,
        12
      ],
      "id": 823464,
      "original_language": "en",
      "original_title": "Godzilla x Kong: The New Empire",
      "overview": "Following their explosive showdown, Godzilla and Kong must reunite against a colossal undiscovered threat hidden within our world, challenging their very existence – and our own.",
      "popularity": 1773.662,
      "poster_path": "/1DTP1Ph4uzNO6ofRUm7eAimWoKD.jpg",
      "release_date": "2024-03-27",
      "title": "Godzilla x Kong: The New Empire",
      "video": false,
      "vote_average": 6.462,
      "vote_count": 956
    }...
  ]
}

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 3
  • Generator version: 7.5.0
  • Build package: org.openapitools.codegen.languages.JuliaClientCodegen

API Endpoints

Class Method
DefaultApi account_add_favorite
POST /3/account/{account_id}/favorite
Add Favorite
DefaultApi account_add_to_watchlist
POST /3/account/{account_id}/watchlist
Add To Watchlist
DefaultApi account_details
GET /3/account/{account_id}
Details
DefaultApi account_favorite_tv
GET /3/account/{account_id}/favorite/tv
Favorite TV
DefaultApi account_get_favorites
GET /3/account/{account_id}/favorite/movies
Favorite Movies
DefaultApi account_lists
GET /3/account/{account_id}/lists
Lists
DefaultApi account_rated_movies
GET /3/account/{account_id}/rated/movies
Rated Movies
DefaultApi account_rated_tv
GET /3/account/{account_id}/rated/tv
Rated TV
DefaultApi account_rated_tv_episodes
GET /3/account/{account_id}/rated/tv/episodes
Rated TV Episodes
DefaultApi account_watchlist_movies
GET /3/account/{account_id}/watchlist/movies
Watchlist Movies
DefaultApi account_watchlist_tv
GET /3/account/{account_id}/watchlist/tv
Watchlist TV
DefaultApi alternative_names_copy
GET /3/network/{network_id}/images
Images
DefaultApi authentication_create_guest_session
GET /3/authentication/guest_session/new
Create Guest Session
DefaultApi authentication_create_request_token
GET /3/authentication/token/new
Create Request Token
DefaultApi authentication_create_session
POST /3/authentication/session/new
Create Session
DefaultApi authentication_create_session_from_login
POST /3/authentication/token/validate_with_login
Create Session (with login)
DefaultApi authentication_create_session_from_v4_token
POST /3/authentication/session/convert/4
Create Session (from v4 token)
DefaultApi authentication_delete_session
DELETE /3/authentication/session
Delete Session
DefaultApi authentication_validate_key
GET /3/authentication
Validate Key
DefaultApi certification_movie_list
GET /3/certification/movie/list
Movie Certifications
DefaultApi certifications_tv_list
GET /3/certification/tv/list
TV Certifications
DefaultApi changes_movie_list
GET /3/movie/changes
Movie List
DefaultApi changes_people_list
GET /3/person/changes
People List
DefaultApi changes_tv_list
GET /3/tv/changes
TV List
DefaultApi collection_details
GET /3/collection/{collection_id}
Details
DefaultApi collection_images
GET /3/collection/{collection_id}/images
Images
DefaultApi collection_translations
GET /3/collection/{collection_id}/translations
Translations
DefaultApi company_alternative_names
GET /3/company/{company_id}/alternative_names
Alternative Names
DefaultApi company_details
GET /3/company/{company_id}
Details
DefaultApi company_images
GET /3/company/{company_id}/images
Images
DefaultApi configuration_countries
GET /3/configuration/countries
Countries
DefaultApi configuration_details
GET /3/configuration
Details
DefaultApi configuration_jobs
GET /3/configuration/jobs
Jobs
DefaultApi configuration_languages
GET /3/configuration/languages
Languages
DefaultApi configuration_primary_translations
GET /3/configuration/primary_translations
Primary Translations
DefaultApi configuration_timezones
GET /3/configuration/timezones
Timezones
DefaultApi credit_details
GET /3/credit/{credit_id}
Details
DefaultApi details_copy
GET /3/network/{network_id}/alternative_names
Alternative Names
DefaultApi discover_movie
GET /3/discover/movie
Movie
DefaultApi discover_tv
GET /3/discover/tv
TV
DefaultApi find_by_id
GET /3/find/{external_id}
Find By ID
DefaultApi genre_movie_list
GET /3/genre/movie/list
Movie List
DefaultApi genre_tv_list
GET /3/genre/tv/list
TV List
DefaultApi guest_session_rated_movies
GET /3/guest_session/{guest_session_id}/rated/movies
Rated Movies
DefaultApi guest_session_rated_tv
GET /3/guest_session/{guest_session_id}/rated/tv
Rated TV
DefaultApi guest_session_rated_tv_episodes
GET /3/guest_session/{guest_session_id}/rated/tv/episodes
Rated TV Episodes
DefaultApi keyword_details
GET /3/keyword/{keyword_id}
Details
DefaultApi keyword_movies
GET /3/keyword/{keyword_id}/movies
Movies
DefaultApi list_add_movie
POST /3/list/{list_id}/add_item
Add Movie
DefaultApi list_check_item_status
GET /3/list/{list_id}/item_status
Check Item Status
DefaultApi list_clear
POST /3/list/{list_id}/clear
Clear
DefaultApi list_create
POST /3/list
Create
DefaultApi list_delete
DELETE /3/list/{list_id}
Delete
DefaultApi list_details
GET /3/list/{list_id}
Details
DefaultApi list_remove_movie
POST /3/list/{list_id}/remove_item
Remove Movie
DefaultApi lists_copy
GET /3/tv/{series_id}/lists
Lists
DefaultApi movie_account_states
GET /3/movie/{movie_id}/account_states
Account States
DefaultApi movie_add_rating
POST /3/movie/{movie_id}/rating
Add Rating
DefaultApi movie_alternative_titles
GET /3/movie/{movie_id}/alternative_titles
Alternative Titles
DefaultApi movie_changes
GET /3/movie/{movie_id}/changes
Changes
DefaultApi movie_credits
GET /3/movie/{movie_id}/credits
Credits
DefaultApi movie_delete_rating
DELETE /3/movie/{movie_id}/rating
Delete Rating
DefaultApi movie_details
GET /3/movie/{movie_id}
Details
DefaultApi movie_external_ids
GET /3/movie/{movie_id}/external_ids
External IDs
DefaultApi movie_images
GET /3/movie/{movie_id}/images
Images
DefaultApi movie_keywords
GET /3/movie/{movie_id}/keywords
Keywords
DefaultApi movie_latest_id
GET /3/movie/latest
Latest
DefaultApi movie_lists
GET /3/movie/{movie_id}/lists
Lists
DefaultApi movie_now_playing_list
GET /3/movie/now_playing
Now Playing
DefaultApi movie_popular_list
GET /3/movie/popular
Popular
DefaultApi movie_recommendations
GET /3/movie/{movie_id}/recommendations
Recommendations
DefaultApi movie_release_dates
GET /3/movie/{movie_id}/release_dates
Release Dates
DefaultApi movie_reviews
GET /3/movie/{movie_id}/reviews
Reviews
DefaultApi movie_similar
GET /3/movie/{movie_id}/similar
Similar
DefaultApi movie_top_rated_list
GET /3/movie/top_rated
Top Rated
DefaultApi movie_translations
GET /3/movie/{movie_id}/translations
Translations
DefaultApi movie_upcoming_list
GET /3/movie/upcoming
Upcoming
DefaultApi movie_videos
GET /3/movie/{movie_id}/videos
Videos
DefaultApi movie_watch_providers
GET /3/movie/{movie_id}/watch/providers
Watch Providers
DefaultApi network_details
GET /3/network/{network_id}
Details
DefaultApi person_changes
GET /3/person/{person_id}/changes
Changes
DefaultApi person_combined_credits
GET /3/person/{person_id}/combined_credits
Combined Credits
DefaultApi person_details
GET /3/person/{person_id}
Details
DefaultApi person_external_ids
GET /3/person/{person_id}/external_ids
External IDs
DefaultApi person_images
GET /3/person/{person_id}/images
Images
DefaultApi person_latest_id
GET /3/person/latest
Latest
DefaultApi person_movie_credits
GET /3/person/{person_id}/movie_credits
Movie Credits
DefaultApi person_popular_list
GET /3/person/popular
Popular
DefaultApi person_tagged_images
GET /3/person/{person_id}/tagged_images
Tagged Images
DefaultApi person_tv_credits
GET /3/person/{person_id}/tv_credits
TV Credits
DefaultApi review_details
GET /3/review/{review_id}
Details
DefaultApi search_collection
GET /3/search/collection
Collection
DefaultApi search_company
GET /3/search/company
Company
DefaultApi search_keyword
GET /3/search/keyword
Keyword
DefaultApi search_movie
GET /3/search/movie
Movie
DefaultApi search_multi
GET /3/search/multi
Multi
DefaultApi search_person
GET /3/search/person
Person
DefaultApi search_tv
GET /3/search/tv
TV
DefaultApi translations
GET /3/person/{person_id}/translations
Translations
DefaultApi trending_all
GET /3/trending/all/{time_window}
All
DefaultApi trending_movies
GET /3/trending/movie/{time_window}
Movies
DefaultApi trending_people
GET /3/trending/person/{time_window}
People
DefaultApi trending_tv
GET /3/trending/tv/{time_window}
TV
DefaultApi tv_episode_account_states
GET /3/tv/{series_id}/season/{season_number}/episode/{episode_number}/account_states
Account States
DefaultApi tv_episode_add_rating
POST /3/tv/{series_id}/season/{season_number}/episode/{episode_number}/rating
Add Rating
DefaultApi tv_episode_changes_by_id
GET /3/tv/episode/{episode_id}/changes
Changes
DefaultApi tv_episode_credits
GET /3/tv/{series_id}/season/{season_number}/episode/{episode_number}/credits
Credits
DefaultApi tv_episode_delete_rating
DELETE /3/tv/{series_id}/season/{season_number}/episode/{episode_number}/rating
Delete Rating
DefaultApi tv_episode_details
GET /3/tv/{series_id}/season/{season_number}/episode/{episode_number}
Details
DefaultApi tv_episode_external_ids
GET /3/tv/{series_id}/season/{season_number}/episode/{episode_number}/external_ids
External IDs
DefaultApi tv_episode_group_details
GET /3/tv/episode_group/{tv_episode_group_id}
Details
DefaultApi tv_episode_images
GET /3/tv/{series_id}/season/{season_number}/episode/{episode_number}/images
Images
DefaultApi tv_episode_translations
GET /3/tv/{series_id}/season/{season_number}/episode/{episode_number}/translations
Translations
DefaultApi tv_episode_videos
GET /3/tv/{series_id}/season/{season_number}/episode/{episode_number}/videos
Videos
DefaultApi tv_season_account_states
GET /3/tv/{series_id}/season/{season_number}/account_states
Account States
DefaultApi tv_season_aggregate_credits
GET /3/tv/{series_id}/season/{season_number}/aggregate_credits
Aggregate Credits
DefaultApi tv_season_changes_by_id
GET /3/tv/season/{season_id}/changes
Changes
DefaultApi tv_season_credits
GET /3/tv/{series_id}/season/{season_number}/credits
Credits
DefaultApi tv_season_details
GET /3/tv/{series_id}/season/{season_number}
Details
DefaultApi tv_season_external_ids
GET /3/tv/{series_id}/season/{season_number}/external_ids
External IDs
DefaultApi tv_season_images
GET /3/tv/{series_id}/season/{season_number}/images
Images
DefaultApi tv_season_translations
GET /3/tv/{series_id}/season/{season_number}/translations
Translations
DefaultApi tv_season_videos
GET /3/tv/{series_id}/season/{season_number}/videos
Videos
DefaultApi tv_season_watch_providers
GET /3/tv/{series_id}/season/{season_number}/watch/providers
Watch Providers
DefaultApi tv_series_account_states
GET /3/tv/{series_id}/account_states
Account States
DefaultApi tv_series_add_rating
POST /3/tv/{series_id}/rating
Add Rating
DefaultApi tv_series_aggregate_credits
GET /3/tv/{series_id}/aggregate_credits
Aggregate Credits
DefaultApi tv_series_airing_today_list
GET /3/tv/airing_today
Airing Today
DefaultApi tv_series_alternative_titles
GET /3/tv/{series_id}/alternative_titles
Alternative Titles
DefaultApi tv_series_changes
GET /3/tv/{series_id}/changes
Changes
DefaultApi tv_series_content_ratings
GET /3/tv/{series_id}/content_ratings
Content Ratings
DefaultApi tv_series_credits
GET /3/tv/{series_id}/credits
Credits
DefaultApi tv_series_delete_rating
DELETE /3/tv/{series_id}/rating
Delete Rating
DefaultApi tv_series_details
GET /3/tv/{series_id}
Details
DefaultApi tv_series_episode_groups
GET /3/tv/{series_id}/episode_groups
Episode Groups
DefaultApi tv_series_external_ids
GET /3/tv/{series_id}/external_ids
External IDs
DefaultApi tv_series_images
GET /3/tv/{series_id}/images
Images
DefaultApi tv_series_keywords
GET /3/tv/{series_id}/keywords
Keywords
DefaultApi tv_series_latest_id
GET /3/tv/latest
Latest
DefaultApi tv_series_on_the_air_list
GET /3/tv/on_the_air
On The Air
DefaultApi tv_series_popular_list
GET /3/tv/popular
Popular
DefaultApi tv_series_recommendations
GET /3/tv/{series_id}/recommendations
Recommendations
DefaultApi tv_series_reviews
GET /3/tv/{series_id}/reviews
Reviews
DefaultApi tv_series_screened_theatrically
GET /3/tv/{series_id}/screened_theatrically
Screened Theatrically
DefaultApi tv_series_similar
GET /3/tv/{series_id}/similar
Similar
DefaultApi tv_series_top_rated_list
GET /3/tv/top_rated
Top Rated
DefaultApi tv_series_translations
GET /3/tv/{series_id}/translations
Translations
DefaultApi tv_series_videos
GET /3/tv/{series_id}/videos
Videos
DefaultApi tv_series_watch_providers
GET /3/tv/{series_id}/watch/providers
Watch Providers
DefaultApi watch_provider_tv_list
GET /3/watch/providers/tv
TV Providers
DefaultApi watch_providers_available_regions
GET /3/watch/providers/regions
Available Regions
DefaultApi watch_providers_movie_list
GET /3/watch/providers/movie
Movie Providers

Models

Authorization

Authentication schemes defined for the API:

sec0

  • Type: API key

Example

    using OpenAPI
    using OpenAPI.Clients
    import OpenAPI.Clients: Client
    client = Client(server_uri)
    api = MyApi(client)
    result = callApi(api, args...; api_key)

Author