SlyYTDAPI.ytdapi

Functions

get_dict_path(d, *keys)
yt_date(date)

Classes

Channel(source, yt)
Comment(source)
CommentOrder(value)	An enumeration.
Order(value)	An enumeration.
Part(value)	An enumeration.
Playlist(id, yt)
PrivacyStatus(value)	An enumeration.
SafeSearch(value)	An enumeration.
Scope()
Video(source, yt)
YouTubeData(app_or_api_key)

class SlyYTDAPI.ytdapi.Scope

Bases: object

READONLY = 'https://www.googleapis.com/auth/youtube.readonly'

MEMBERS = 'https://www.googleapis.com/auth/youtube.channel-memberships.creator'

class SlyYTDAPI.ytdapi.Part(value)

Bases: Enum

An enumeration.

ID = 'id'

DETAILS = 'contentDetails'

SNIPPET = 'snippet'

STATUS = 'status'

STATISTICS = 'statistics'

REPLIES = 'replies'

class SlyYTDAPI.ytdapi.PrivacyStatus(value)

Bases: Enum

An enumeration.

PRIVATE = 'private'

UNLISTED = 'unlisted'

PUBLIC = 'public'

class SlyYTDAPI.ytdapi.SafeSearch(value)

Bases: Enum

An enumeration.

SAFE = 'strict'

MODERATE = 'moderate'

UNSAFE = 'none'

class SlyYTDAPI.ytdapi.Order(value)

Bases: Enum

An enumeration.

DATE = 'date'

LIKES = 'rating'

RELEVANCE = 'relevance'

ALPHABETICAL = 'title'

VIEWS = 'viewCount'

class SlyYTDAPI.ytdapi.CommentOrder(value)

Bases: Enum

An enumeration.

RELEVANCE = 'relevance'

TIME = 'time'

SlyYTDAPI.ytdapi.yt_date(date)

Parameters:

date (str) –

Return type:

datetime

SlyYTDAPI.ytdapi.get_dict_path(d, *keys)

Parameters:

• d (dict[str, Any]) –

• keys (str) –

Return type:

Any

class SlyYTDAPI.ytdapi.Comment(source)

Bases: object

Parameters:

source (dict[str, Any]) –

property author_name

replies: list['Comment'] | None

id: str

author_display_name: str

author_channel_id: str

body: str

created_at: datetime

class SlyYTDAPI.ytdapi.Video(source, yt)

Bases: object

Parameters:

• source (dict[str, Any]) –

• yt (YouTubeData) –

view_count: int

like_count: int

comment_count: int

id: str

title: str

description: str

published_at: datetime

channel_id: str

channel_name: str

tags: list[str]

is_livestream: bool

duration: int

privacy: PrivacyStatus

link(short=False)

Parameters:

short (bool) –

Return type:

str

comments(limit=100)

Parameters:

limit (int | None) –

Return type:

AsyncTrans[Comment]

await channel()

Return type:

Channel

class SlyYTDAPI.ytdapi.Playlist(id, yt)

Bases: object

Parameters:

• id (str) –

• yt (YouTubeData) –

id: str

link()

Return type:

str

class SlyYTDAPI.ytdapi.Channel(source, yt)

Bases: object

Parameters:

• source (dict[str, Any]) –

• yt (YouTubeData) –

property custom_url

property name

id: str

display_name: str

description: str

created_at: datetime

profile_image_url: str | None = None

at_username: str

uploads_playlist: Playlist

view_count: int

subscriber_count: int

video_count: int

link()

Return type:

str

await update()

videos(limit=None, mine=None)

Parameters:

• limit (int | None) –

• mine (bool | None) –

Return type:

AsyncTrans[Video]

class SlyYTDAPI.ytdapi.YouTubeData(app_or_api_key)

Bases: WebAPI

Parameters:

app_or_api_key (str | OAuth2 | UrlApiKey) –

base_url: str = 'https://www.googleapis.com/youtube/v3'

await my_channel(parts=Part.SNIPPET)

Parameters:

parts (Part) –

Return type:

Channel

await channels(channel_ids, parts)

Parameters:

• channel_ids (list[str]) –

• parts (Part) –

Return type:

list[SlyYTDAPI.ytdapi.Channel]

await channel(channel_id, parts=Part.SNIPPET)

Parameters:

• channel_id (str) –

• parts (Part) –

Return type:

Channel

videos(video_ids, parts={<Part.ID: 'id'>, <Part.SNIPPET: 'snippet'>})

Parameters:

• video_ids (list[str]) –

• parts (Part | set[SlyYTDAPI.ytdapi.Part]) –

Return type:

AsyncTrans[Video]

await video(id, parts={<Part.ID: 'id'>, <Part.SNIPPET: 'snippet'>})

Parameters:

• id (str) –

• parts (Part | set[SlyYTDAPI.ytdapi.Part]) –

Return type:

Video

get_playlist_videos(playlist_id, parts=Part.SNIPPET, limit=None)

Parameters:

• playlist_id (str) –

• parts (Part | set[SlyYTDAPI.ytdapi.Part]) –

• limit (int | None) –

Return type:

AsyncTrans[Video]

search_videos(query=None, channel_id=None, after=None, before=None, mine=None, order=Order.RELEVANCE, safeSearch=SafeSearch.MODERATE, parts=Part.SNIPPET, limit=50)

Parameters:

• query (str | None) –

• channel_id (str | None) –

• after (datetime | None) –

• before (datetime | None) –

• mine (bool | None) –

• order (Order) –

• safeSearch (SafeSearch) –

• parts (Part | set[SlyYTDAPI.ytdapi.Part]) –

• limit (int | None) –

Return type:

AsyncTrans[Video]

comments(video_id, query=None, parts={<Part.SNIPPET: 'snippet'>, <Part.REPLIES: 'replies'>}, order=CommentOrder.TIME, limit=None)

Parameters:

• video_id (str) –

• query (str | None) –

• parts (Part | set[SlyYTDAPI.ytdapi.Part]) –

• order (CommentOrder) –

• limit (int | None) –

Return type:

AsyncTrans[Comment]