Skip to content

UpdatesApi.md

Latest commit

 

History

History
116 lines (79 loc) · 4.18 KB

UpdatesApi.md

File metadata and controls

116 lines (79 loc) · 4.18 KB
Raw

tvdb_api.UpdatesApi

All URIs are relative to https://localhost

Method HTTP request Description
updated_query_get GET /updated/query
updated_query_params_get GET /updated/query/params

updated_query_get

UpdateData updated_query_get(from_time, to_time=to_time, accept_language=accept_language)

Returns an array of series that have changed in a maximum of one week blocks since the provided fromTime. The user may specify a toTime to grab results for less than a week. Any timespan larger than a week will be reduced down to one week automatically.

Example

from __future__ import print_function
import time
import tvdb_api
from tvdb_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: jwtToken
configuration = tvdb_api.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = tvdb_api.UpdatesApi(tvdb_api.ApiClient(configuration))
from_time = 'from_time_example' # str | Epoch time to start your date range.
to_time = 'to_time_example' # str | Epoch time to end your date range. Must be one week from `fromTime`. (optional)
accept_language = 'accept_language_example' # str | Records are returned with the some fields in the desired language, if it exists. If there is no translation for the given language, then the record is still returned but with empty values for the translated fields. (optional)

try:
    api_response = api_instance.updated_query_get(from_time, to_time=to_time, accept_language=accept_language)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UpdatesApi->updated_query_get: %s\n" % e)

Parameters

Name Type Description Notes
from_time str Epoch time to start your date range.
to_time str Epoch time to end your date range. Must be one week from `fromTime`. [optional]
accept_language str Records are returned with the some fields in the desired language, if it exists. If there is no translation for the given language, then the record is still returned but with empty values for the translated fields. [optional]

Return type

UpdateData

Authorization

jwtToken

HTTP request headers

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

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

updated_query_params_get

UpdateDataQueryParams updated_query_params_get()

Returns an array of valid query keys for the /updated/query/params route.

Example

from __future__ import print_function
import time
import tvdb_api
from tvdb_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: jwtToken
configuration = tvdb_api.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = tvdb_api.UpdatesApi(tvdb_api.ApiClient(configuration))

try:
    api_response = api_instance.updated_query_params_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UpdatesApi->updated_query_params_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

UpdateDataQueryParams

Authorization

jwtToken

HTTP request headers

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

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