List

class trakt.objects.list.base.List(client, keys, user)

Bases: object

allow_comments = None
Type:bool

Flag indicating this list allows comments

comment_count = None
Type:int

Number of comments

created_at = None
Type:datetime

Timestamp of when this list was created

description = None
Type:str

Description

display_numbers = None
Type:bool

Flag indicating this list displays numbers

id

Retrieve the list identifier.

Return type:int
item_count = None
Type:int

Number of items

items(**kwargs)

Retrieve list items.

Parameters:kwargs (dict) – Extra request options
Returns:Current list items
Return type:list of trakt.objects.media.Media
keys = None
Type:list of tuple

Keys (for trakt, imdb, tvdb, etc..), defined as:

..code-block:

[
    (<service>, <id>)
]
like(**kwargs)

Like the list.

Parameters:kwargs (dict) – Extra request options
Returns:Boolean to indicate if the request was successful
Return type:bool
like_count

Retrieve the number of likes.

Return type:int
liked_at = None
Type:datetime

Timestamp of when this list was liked

likes = None
Type:int

Number of likes

name = None
Type:str

Name

pk

Retrieve the primary key (unique identifier for the list).

Returns:("trakt", <id>) or None if no primary key is available
Return type:tuple
privacy = None
Type:str

Privacy

Possible values:
  • private
  • friends
  • public
sort_by = None
Type:str

Sort By

Possible values:
  • rank
  • added
  • title
  • released
  • runtime
  • popularity
  • percentage
  • votes
  • my_rating
  • random
  • watched
  • collected
sort_how = None
Type:str

Sort Direction

Possible values:
  • asc
  • desc
unlike(**kwargs)

Un-like the list.

Parameters:kwargs (dict) – Extra request options
Returns:Boolean to indicate if the request was successful
Return type:bool
updated_at = None
Type:datetime

Timestamp of when this list was last updated

user = None
Type:trakt.objects.User

Author

username

Retrieve author username.

Return type:str