twitcaspy.API --- Twitcasting API v2 Reference
- class twitcaspy.API(auth=None, *, host='apiv2.twitcasting.tv', parser=None, user_agent=None, signature=None)
Twitcasting API v2.0 Interface
- パラメータ
auth (
AuthHandler) -- 使用される認証ハンドラーhost (
str) -- 使用されるREST APIのホストサーバーURLparser (
Parser) --Twitcastingからのレスポンスを解析するために使用するParserインスタンス。デフォルトはModelParserのインスタンスです。user_agent (
str) -- 使用されるユーザーエージェントsignature (
str) -- WebHookの正規のリクエストであることを証明するキー
- 例外
TypeError -- 指定されたparserがParserインスタンスではない場合
参照
Twitcasting API v2 Endpoint |
|
|---|---|
|
|
User
get_user_info
- API.get_user_info(*, id=None, screen_id=None)
- ユーザーの情報を取得します。idまたはscreen_idのいずれかを指定する必要があります。
- パラメータ
- 戻り値
- 戻り値の型
- 例外
TwitcaspyException -- idとscreen_idの両方が指定されていないとき
参照
verify_credentials
- API.verify_credentials()
アクセストークンに関するアプリケーションとユーザーの情報を取得します。
- 戻り値
- 戻り値の型
参照
Live Thumbnail
get_live_thumbnail_image
- API.get_live_thumbnail_image(*, id=None, screen_id=None, size='small', position='latest')
- 指定されたユーザーにおける配信中のライブのサムネイル画像を取得します。ユーザーが配信中でない場合はオフライン画像を返します。idまたはscreen_idのいずれかを指定する必要があります。
ちなみに
認証は必要ありません。
- パラメータ
- 戻り値
- 画像データはcontent属性に格納されています。
- 戻り値の型
requests.models.Response- 例外
TwitcaspyException -- idとscreen_idの両方が指定されていないとき
参照
Movie
get_movie_info
- API.get_movie_info(movie_id)
ライブ情報を取得します。
参照
get_movies_by_user
- API.get_movies_by_user(*, id=None, screen_id=None, offset=0, limit=20, slice_id=None)
- ユーザーが保有する過去ライブ（録画）の一覧を作成日時の降順で取得します。idまたはscreen_idのいずれかを指定する必要があります。
- パラメータ
id (
str) -- ライブ配信者のユーザID このパラメータを指定した場合、screen_idは無視されます。screen_id (
str) -- ライブ配信者のID(例: @~~)offset(optional) (
int) --先頭からの位置0から1000の範囲で指定できます。(デフォルト: 0)limit(optional) (
int) --最大取得件数1から50の範囲で指定できます。(デフォルト: 20)(場合により、指定件数に満たない数の動画を返す可能性があります。)slice_id(optional) (
intorNone) --このslice_id以前のライブを取得します。1以上の範囲で指定できます。(デフォルトでは指定されていません。[=None])このパラメータを指定した場合、offsetは無視されます。
- 戻り値
- 戻り値の型
- 例外
TwitcaspyException -- idとscreen_idの両方が指定されていないとき
参照
get_current_live
- API.get_current_live(*, id=None, screen_id=None)
- ーザーが配信中の場合、ライブ情報を取得します。idまたはscreen_idのいずれかを指定する必要があります。
- パラメータ
- 戻り値
- 戻り値の型
- 例外
TwitcaspyException -- idとscreen_idの両方が指定されていないとき
参照
set_current_live_subtitle
- API.set_current_live_subtitle(subtitle, *, cut_out=False)
- ユーザーが配信中の場合、ライブのテロップを設定する。
- パラメータ
- 戻り値
- 戻り値の型
- 例外
TwitcaspyException: -- subtitleが1文字より少ないとき subtitleが17文字より多く、cut_outがFalseのとき
参照
unset_current_live_subtitle
- API.unset_current_live_subtitle()
- ユーザーが配信中の場合、ライブのテロップを削除する。
- 戻り値
- 戻り値の型
参照
https://apiv2-doc.twitcasting.tv/#unset-current-live-subtitle
set_current_live_hashtag
- API.set_current_live_hashtag(hashtag, *, cut_out=False)
- ユーザーが配信中の場合、ライブのハッシュタグを設定する。
- パラメータ
- 戻り値
- 戻り値の型
- 例外
TwitcaspyException: -- hashtagが1文字より少ないとき/hashtagが26文字より多く、cut_outがFalseのとき
参照
unset_current_live_hashtag
- API.unset_current_live_hashtag()
- ユーザーが配信中の場合、ライブのハッシュタグを削除する。
- 戻り値
- 戻り値の型
参照
https://apiv2-doc.twitcasting.tv/#unset-current-live-hashtag
Comment
get_comments
- API.get_comments(movie_id, *, offset=0, limit=20, slice_id=None)
- 指定した動画のコメントの一覧を作成日時の降順で取得します。
- パラメータ
movie_id (
str) -- ライブのIDoffset(optional) (
int) --先頭からの位置0以上の範囲で指定できます。(デフォルト: 0)limit(optional) (
int) --最大取得件数1から50の範囲で指定できます。(デフォルト: 10)(場合により、指定件数に満たない数の動画を返す可能性があります。)slice_id(optional) (
intorNone) --このslice_id以前のコメントを取得します。1以上の範囲で指定できます。(デフォルトでは指定されていません。[=None])このパラメータを指定した場合、offsetは無視されます。slice_id に指定可能な最小値が 1 になりました。
- 戻り値
- 戻り値の型
参照
post_comment
- API.post_comment(movie_id, comment, *, sns='none')
- コメントを投稿します。ユーザ単位でのみ実行可能です。
- パラメータ
- 戻り値
- 戻り値の型
- 例外
TwitcaspyException: -- comment が 1-140 文字でないとき
参照
delete_comment
- API.delete_comment(movie_id, comment_id)
- コメントを削除します。ユーザ単位でのみ実行可能です。原則として削除できるコメントは、投稿者がアクセストークンに紐づくユーザと同一のものに限られます。ただし、Movieのオーナーであるユーザーのアクセストークンを用いる場合は他ユーザが投稿したコメントを削除することが出来ます。
参照
Gift
get_gifts
Supporter
get_supporting_status
- API.get_supporting_status(target_user_id, *, id=None, screen_id=None)
- ユーザーが、ある別のユーザのサポーターであるかの状態を取得する。idまたはscreen_idのいずれかを指定する必要があります。
- パラメータ
警告
Supporterとは異なり、supported_time 属性がないことに注意してください。- 戻り値
- 戻り値の型
- 例外
TwitcaspyException -- idとscreen_idの両方が指定されていないとき
参照
support_user
unsupport_user
supporting_list
- API.supporting_list(*, id=None, screen_id=None, offset=0, limit=20)
- 指定したユーザーがサポートしているユーザーの一覧を取得するidまたはscreen_idのいずれかを指定する必要があります。
- パラメータ
- 戻り値
- 戻り値の型
- 例外
TwitcaspyException -- idとscreen_idの両方が指定されていないとき
参照
supporter_list
- API.supporter_list(sort='ranking', *, id=None, screen_id=None, offset=0, limit=20)
- 指定したユーザーをサポートしているユーザーの一覧を取得する。idまたはscreen_idのいずれかを指定する必要があります。
- パラメータ
sort (
str) --ソート順sort は下記のいずれかである必要があります。'new' : 新着順'ranking' : 貢献度順id (
str) -- ライブ配信者のユーザID このパラメータを指定した場合、screen_idは無視されます。screen_id (
str) -- ライブ配信者のID(例: @~~)offset(optional) (
int) --先頭からの位置0以上の範囲で指定できます。(デフォルト: 0)limit(optional) (
int) --最大取得件数1から20の範囲で指定できます。(デフォルト: 20)(場合により、指定件数に満たない数のサポートしているユーザーを返す可能性があります。)
- 戻り値
- 戻り値の型
- 例外
TwitcaspyException -- idとscreen_idの両方が指定されていないとき
TwitcaspyException -- sort が 'new' か 'ranking' でないとき
参照
Category
get_categories
- API.get_categories(lang='ja')
- 配信中のカテゴリのみを取得する。
- パラメータ
lang (
str) --検索対象の言語lang は下記のいずれかである必要があります。'ja' : 日本語'en' : 英語- 戻り値
- 戻り値の型
- 例外
TwitcaspyException -- sort が 'ja' か 'en' でないとき
参照
Search users and movies
search_users
- API.search_users(words, *, limit=10, lang='ja')
- ユーザを検索する
- パラメータ
- 戻り値
- 戻り値の型
- 例外
TwitcaspyException -- lang が 'ja' でないとき
TwitcaspyException -- words が指定されていないとき
TwitcaspyException -- words が
strまたはlistまたはtupleではないとき
参照
search_live_movies
- API.search_live_movies(*, type='word', content)
- 配信中のライブを検索する。
- パラメータ
- 戻り値
- 戻り値の型
- 例外
TwitcaspyException -- type が指定されていないとき
TwitcaspyException -- type の値が tag, word, category, new, recommend のいずれかでないとき。
TwitcaspyException -- type が tag, word, category のいずれかで、 content が指定されていないとき
TwitcaspyException -- lang が 'ja' でないとき
参照
WebHook
incoming_webhook
- API.incoming_webhook(data, secure=True)
- 指定したWebHook URLへの通知をパースします。
ヒント
WebHook API を利用すると、特定の配信者の配信開始・終了イベントを予め指定した WebHook URL へ通知することが出来ます。
ちなみに
認証は必要ありません。
注釈
Method : POST
- パラメータ
- 戻り値
- 戻り値の型
- 例外
TwitcaspyException -- secure が真でかつ signature が一致しないとき
参照
get_webhook_list
- API.get_webhook_list(limit=50, offset=0, user_id)
- アプリケーションに紐づく WebHook の一覧を取得する。
ちなみに
アプリケーション単位でのみ実行可能です。- パラメータ
ヒント
limit 及び offset パラメータは、 user_id の指定が無い場合のみ有効です。注釈
user_idは数字のid(例: 182224938)か文字列(例: twitcasting_jp)を指定することが可能です。- 戻り値
- 戻り値の型
参照
register_webhook
- API.register_webhook(user_id, event)
- WebHookを新規登録します。
ちなみに
アプリケーション単位でのみ実行可能です。- パラメータ
注釈
user_idは数字のid(例: 182224938)か文字列(例: twitcasting_jp)を指定することが可能です。- 戻り値
- 戻り値の型
- 例外
TwitcaspyException -- eventsが
listまたはtupleではないときTwitcaspyException -- events が livestart または liveend ではないとき
参照
remove_webhook
- API.remove_webhook(user_id, event)
- Remove WebHook.
ちなみに
アプリケーション単位でのみ実行可能です。- パラメータ
注釈
user_idは数字のid(例: 182224938)か文字列(例: twitcasting_jp)を指定することが可能です。- 戻り値
- 戻り値の型
- 例外
TwitcaspyException -- eventsが
listまたはtupleではないときTwitcaspyException -- events が livestart または liveend ではないとき
参照
Broadcasting
get_rtmp_url
- API.get_rtmp_url()
- アクセストークンに紐づくユーザの配信用のURL(RTMP)を取得する。
ちなみに
アプリケーション単位以外でのみ実行可能です。- 戻り値
- 戻り値の型
参照
get_webm_url
- API.get_webm_url()
- アクセストークンに紐づくユーザの配信用のURL(WebM, WebSocket)を取得する。
ちなみに
アプリケーション単位以外でのみ実行可能です。- 戻り値
- 戻り値の型
参照