TvRubika SDK | مستندات کامل متدها

فهرست سریع متدها

__init__ get_me get_Listing get_custom_menu_items get_Property_Types get_list_items get_media_by_id get_cast_info get_cast_medias get_Season_Episodes get_Related search_video get_wish_list like_media un_like_media add_wish_media close

__init__

سازنده کلاس TvRubika — راه‌اندازی با auth

ورودی

پارامتر	نوع	توضیحات
auth	str	توکن احراز هویت حساب کاربری (اجباری)
proxy	str \| None	آدرس پراکسی (اختیاری)
headers	Dict[str, str] \| None	هدرهای سفارشی (اختیاری)

خروجی

None	شیء TvRubika ساخته می‌شود

Python

from rubka import TvRubika

# راه‌اندازی با auth
bot = TvRubika("YOUR_AUTH_TOKEN")

# با پراکسی
bot = TvRubika("YOUR_AUTH_TOKEN", proxy="http://proxy:8080")

get_me

دریافت اطلاعات حساب کاربری (اکانت)

ورودی

—

ندارد

خروجی

dict	اطلاعات حساب شامل id، نام، شماره و...

Python

account_info = await bot.get_me()
print(account_info)

get_Listing

دریافت لیست‌بندی صفحات اصلی (خانه، فیلم، سریال)

ورودی

پارامتر	نوع	توضیحات
listing_id	str \| None	شناسه لیست (پیشفرض "home")

خروجی

dict	لیست محتواهای صفحه

Python

# دریافت صفحه اصلی
home = await bot.get_Listing()
# دریافت صفحه فیلم
movies = await bot.get_Listing("movies")

get_custom_menu_items

دریافت آیتم‌های منوی سفارشی

ورودی

—

ندارد

خروجی

dict	لیست منوهای سفارشی

Python

menu = await bot.get_custom_menu_items()

get_Property_Types

دریافت انواع ویژگی‌های محتوا (ژانرها، دسته‌بندی‌ها)

ورودی

—

ندارد

خروجی

dict	لیست انواع ویژگی‌ها

Python

property_types = await bot.get_Property_Types()

get_list_items

دریافت آیتم‌های یک لیست خاص (مثل لیست پربیننده‌ها)

ورودی

پارامتر	نوع	توضیحات
list_id	str	شناسه لیست
type	str	نوع آیتم‌ها (پیشفرض "Media")
start_id	str	شناسه شروع برای صفحه‌بندی (پیشفرض "0")

خروجی

dict	لیست آیتم‌ها

Python

items = await bot.get_list_items("most_viewed", type="Media", start_id="0")

get_media_by_id

دریافت اطلاعات کامل یک ویدئو/مدیا با شناسه

ورودی

پارامتر	نوع	توضیحات
media_id	str	شناسه مدیا
track_id	str \| None	شناسه ردیابی (اختیاری)

خروجی

dict	اطلاعات کامل ویدئو (لینک، توضیحات، کست و...)

Python

media = await bot.get_media_by_id("media_id_here")
print(media['title'])

get_cast_info

دریافت اطلاعات بازیگر/کارگردان (کست)

ورودی

cast_id

str

شناسه کست (بازیگر/کارگردان)

خروجی

dict	اطلاعات کست شامل نام، بیوگرافی، عکس و...

Python

cast = await bot.get_cast_info("cast_id_here")

get_cast_medias

دریافت لیست آثار یک بازیگر/کارگردان

ورودی

پارامتر	نوع	توضیحات
cast_id	str	شناسه کست
start_id	str	شناسه شروع برای صفحه‌بندی (پیشفرض "0")

خروجی

dict	لیست آثار کست

Python

medias = await bot.get_cast_medias("cast_id_here", start_id="0")

get_Season_Episodes

دریافت قسمت‌های یک فصل از سریال

ورودی

پارامتر	نوع	توضیحات
season_id	str	شناسه فصل
series_id	str	شناسه سریال

خروجی

dict	لیست قسمت‌های فصل

Python

episodes = await bot.get_Season_Episodes("season_id", "series_id")

get_Related

دریافت محتواهای مرتبط با یک ویدئو

ورودی

پارامتر	نوع	توضیحات
media_id	str	شناسه مدیا
start_id	str	شناسه شروع (پیشفرض "0")

خروجی

dict	لیست محتواهای مرتبط

Python

related = await bot.get_Related("media_id_here")

search_video

جستجوی ویدئو در سرویس vod.rubika.ir

ورودی

پارامتر	نوع	توضیحات
text	str	متن جستجو
start_id	str \| None	شناسه شروع برای صفحه‌بندی

خروجی

dict	لیست نتایج جستجو

Python

results = await bot.search_video("rubika", start_id="0")
for item in results.get('items', []):
    print(item['title'])

get_wish_list

دریافت لیست علاقه‌مندی‌های کاربر

ورودی

start_id

str | None

شناسه شروع برای صفحه‌بندی

خروجی

dict	لیست ویدئوهای ذخیره شده در علاقه‌مندی‌ها

Python

wishlist = await bot.get_wish_list()
for media in wishlist.get('items', []):
    print(media['title'])

like_media

لایک کردن یک ویدئو

ورودی

media_id

str

شناسه مدیا

خروجی

dict	نتیجه عملیات

Python

result = await bot.like_media("media_id_here")

un_like_media

لغو لایک ویدئو

ورودی

media_idstrشناسه مدیا

خروجی

dictنتیجه عملیات

Python

result = await bot.un_like_media("media_id_here")

add_wish_media

افزودن ویدئو به لیست علاقه‌مندی‌ها

ورودی

media_idstrشناسه مدیا

خروجی

dictنتیجه عملیات

Python

result = await bot.add_wish_media("media_id_here")

بستن نشست httpx (مهم برای مدیریت منابع)

ورودی

—

ندارد

نکات مهم

نکات استفاده از TvRubika

📌 راه‌اندازی

Python

from rubka import TvRubika

bot = TvRubika("YOUR_AUTH_TOKEN")
await bot.get_me()

📌 استفاده با Async Context Manager

Python

async with TvRubika("YOUR_AUTH_TOKEN") as bot:
    info = await bot.get_me()
    print(info)

📌 نکات

کلاس TvRubika از httpx.AsyncClient استفاده می‌کند
برای دریافت auth به سرویس vod.rubika.ir نیاز دارید
همه متدها async/await هستند
پس از پایان کار حتماً await bot.close() را فراخوانی کنید
یا از async with استفاده کنید تا خودکار بسته شود