Skip to content

Latest commit

 

History

History
525 lines (352 loc) · 16.2 KB

OtherApi.md

File metadata and controls

525 lines (352 loc) · 16.2 KB

seerr.OtherApi

All URIs are relative to http://localhost:5055/api/v1

Method HTTP request Description
get_certifications_movie GET /certifications/movie Get movie certifications
get_certifications_tv GET /certifications/tv Get TV certifications
get_keyword_by_keyword_id GET /keyword/{keywordId} Get keyword
list_watchproviders_movies GET /watchproviders/movies Get watch provider movies
list_watchproviders_regions GET /watchproviders/regions Get watch provider regions
list_watchproviders_tv GET /watchproviders/tv Get watch provider series

get_certifications_movie

CertificationResponse get_certifications_movie()

Get movie certifications

Returns list of movie certifications from TMDB.

Example

  • Api Key Authentication (apiKey):
  • Api Key Authentication (cookieAuth):
import seerr
from seerr.models.certification_response import CertificationResponse
from seerr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5055/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = seerr.Configuration(
    host = "http://localhost:5055/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with seerr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = seerr.OtherApi(api_client)

    try:
        # Get movie certifications
        api_response = api_instance.get_certifications_movie()
        print("The response of OtherApi->get_certifications_movie:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OtherApi->get_certifications_movie: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

CertificationResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
500 Unable to retrieve movie certifications -
2XX Movie certifications returned -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_certifications_tv

CertificationResponse get_certifications_tv()

Get TV certifications

Returns list of TV show certifications from TMDB.

Example

  • Api Key Authentication (apiKey):
  • Api Key Authentication (cookieAuth):
import seerr
from seerr.models.certification_response import CertificationResponse
from seerr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5055/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = seerr.Configuration(
    host = "http://localhost:5055/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with seerr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = seerr.OtherApi(api_client)

    try:
        # Get TV certifications
        api_response = api_instance.get_certifications_tv()
        print("The response of OtherApi->get_certifications_tv:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OtherApi->get_certifications_tv: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

CertificationResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
500 Unable to retrieve TV certifications -
2XX TV certifications returned -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_keyword_by_keyword_id

Keyword get_keyword_by_keyword_id(keyword_id)

Get keyword

Returns a single keyword in JSON format.

Example

  • Api Key Authentication (apiKey):
  • Api Key Authentication (cookieAuth):
import seerr
from seerr.models.keyword import Keyword
from seerr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5055/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = seerr.Configuration(
    host = "http://localhost:5055/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with seerr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = seerr.OtherApi(api_client)
    keyword_id = 1 # float | 

    try:
        # Get keyword
        api_response = api_instance.get_keyword_by_keyword_id(keyword_id)
        print("The response of OtherApi->get_keyword_by_keyword_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OtherApi->get_keyword_by_keyword_id: %s\n" % e)

Parameters

Name Type Description Notes
keyword_id float

Return type

Keyword

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
500 Internal server error -
2XX Keyword returned (null if not found) -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_watchproviders_movies

List[WatchProviderDetails] list_watchproviders_movies(watch_region)

Get watch provider movies

Returns a list of all available watch providers for movies.

Example

  • Api Key Authentication (apiKey):
  • Api Key Authentication (cookieAuth):
import seerr
from seerr.models.watch_provider_details import WatchProviderDetails
from seerr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5055/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = seerr.Configuration(
    host = "http://localhost:5055/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with seerr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = seerr.OtherApi(api_client)
    watch_region = 'US' # str | 

    try:
        # Get watch provider movies
        api_response = api_instance.list_watchproviders_movies(watch_region)
        print("The response of OtherApi->list_watchproviders_movies:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OtherApi->list_watchproviders_movies: %s\n" % e)

Parameters

Name Type Description Notes
watch_region str

Return type

List[WatchProviderDetails]

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
2XX Watch providers for movies returned -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_watchproviders_regions

List[WatchProviderRegion] list_watchproviders_regions()

Get watch provider regions

Returns a list of all available watch provider regions.

Example

  • Api Key Authentication (apiKey):
  • Api Key Authentication (cookieAuth):
import seerr
from seerr.models.watch_provider_region import WatchProviderRegion
from seerr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5055/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = seerr.Configuration(
    host = "http://localhost:5055/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with seerr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = seerr.OtherApi(api_client)

    try:
        # Get watch provider regions
        api_response = api_instance.list_watchproviders_regions()
        print("The response of OtherApi->list_watchproviders_regions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OtherApi->list_watchproviders_regions: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[WatchProviderRegion]

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
2XX Watch provider regions returned -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_watchproviders_tv

List[WatchProviderDetails] list_watchproviders_tv(watch_region)

Get watch provider series

Returns a list of all available watch providers for series.

Example

  • Api Key Authentication (apiKey):
  • Api Key Authentication (cookieAuth):
import seerr
from seerr.models.watch_provider_details import WatchProviderDetails
from seerr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5055/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = seerr.Configuration(
    host = "http://localhost:5055/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with seerr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = seerr.OtherApi(api_client)
    watch_region = 'US' # str | 

    try:
        # Get watch provider series
        api_response = api_instance.list_watchproviders_tv(watch_region)
        print("The response of OtherApi->list_watchproviders_tv:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OtherApi->list_watchproviders_tv: %s\n" % e)

Parameters

Name Type Description Notes
watch_region str

Return type

List[WatchProviderDetails]

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
2XX Watch providers for series returned -

[Back to top] [Back to API list] [Back to Model list] [Back to README]