OPENREC.tv API まとめ

OPENREC.tv API まとめ

メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/movies
概要
配信・動画一覧を取得する
認証
不要

パラメータ

パラメータ名型説明
is_livebool取得するものを生配信に限定するか？
is_uploadbool取得するものを動画に限定するか？
onair_statusnumber0は予約枠, 1は配信中, 2はVOD．
channel_idsstringchannel_idsを指定することで，特定のチャンネルのみに絞り込むことができる．
pagenumberページ数を指定できる．デフォルトは1．
sortstring取得するデータを並び変える．並び変えれる順番は次の通り． total_views | created_at | -created_at | schedule_at | onair_status | live_views | total_yells | -total_yells | popularity | published_at | -published_at
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/movies/{M_ID}
概要
M_IDで指定した任意の動画の情報を取得する．このM_IDは配信のURLのもの．例えば"https://www.openrec.tv/live/n9ze3m2w184"のM_IDは"n9ze3m2w184"である．
認証
不要
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/movies/{M_ID}/detail
概要
M_IDで指定した任意の動画の情報を取得する．認証情報を渡すため，動画ファイルのURLを得ることができる
認証
必要
メソッド
POST
エンドポイント
https://apiv5.openrec.tv/api/v5/movies/{M_ID}/reports
概要
M_IDで指定した任意の動画を通報できる．
認証
必要

パラメータ

パラメータ名型説明
reason_typenumber配信や動画の不適切な点のジャンルを指定する．1はわいせつな表現．2は他者を誹謗中傷する表現．3は著作権の侵害．4はプライバシーの侵害．5は過激な暴力や自傷行為．6はなりすまし行為．7は出会いを誘導する行為．8はねずみ講やマルチ商法．9は誤解を招く配信設定．10はゲームの録画禁止区域の配信．11は改造版・海賊版ソフトの配信．12は政治的・宗教的・人種的な内容．13はその他の問題．
movie_idstringURLで指定したM_IDと同じもの
messagestring通報内容
メソッド
POST
エンドポイント
https://www.openrec.tv/api-tv/session
概要
様々な機能で用いるcookie(uuid, token, random)を取得する．
認証
必要
メソッド
POST
エンドポイント
https://www.openrec.tv/viewapp/v4/mobile/user/login
概要
メールアドレスとパスワードを用いてログインする．このとき，cookieにuuid, token, randomを与える必要がある．また，レスポンスではaccess_tokenやuuid, token, randomがcookieにセットされる．
認証
必要

パラメータ

パラメータ名型説明
mailstringログインするアカウントのメールアドレスを指定する．
passwordstringログインするアカウントのパスワードを指定する．
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/movies/{M_ID}/chats
概要
M_IDで指定した任意の配信のコメントを取得する．
認証
不要

パラメータ

パラメータ名型説明
from_created_atISO8601 DATETIMEISO8601形式で指定した日時以降のコメントを取得する．例: 2023-03-20T12:48:47.265Z
to_created_atISO8601 DATETIMEISO8601形式で指定した日時までのコメントを取得する．from_created_atと同時に使用できない．
is_including_system_messageboolシステムメッセージを含めるか？(システムメッセージとはなんだろう？)
limitbool取得するコメントの数．1~300
メソッド
POST
エンドポイント
https://apiv5.openrec.tv/api/v5/movies/{M_ID}/chats
概要
M_IDで指定した任意の配信に対しコメントを投稿する．
認証
必要

パラメータ

パラメータ名型説明
messagestring送信するメッセージ内容．100字まで．
quality_typenumber0が低遅延，がを指す
league_key?何に使用するか不明だが一応空文字列を送信する．
to_user_id?何に使用するか不明だが一応空文字列を送信する．
consented_chat_termsbool基本的にはfalseでよさそう．
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/movies/{M_ID}/comments
概要
M_IDで指定した任意の配信のアーカイブのコメントを取得する．
認証
不要
メソッド
POST
エンドポイント
https://apiv5.openrec.tv/api/v5/movies/{M_ID}/comments
概要
M_IDで指定した任意の配信のアーカイブにコメントを投稿する．
認証
必要

パラメータ

パラメータ名型説明
messagestring送信するメッセージの内容．100字まで
league_key?何に使用するか不明だが一応空文字列を送信する．
メソッド
POST
エンドポイント
https://apiv5.openrec.tv/api/v5/movies/{M_ID}/comments/{COMMENT_ID}/replies
概要
M_IDで指定した任意の配信のアーカイブにつけられたコメントに対し返信を投稿する．COMMENT_IDは"https://public.openrec.tv/external/api/v5/movies/{M_ID}/comments"から取得できる．
認証
必要

パラメータ

パラメータ名型説明
messagestring送信するメッセージの内容．100字まで
consented_comment_termsbooltrueにしておく
メソッド
WSS
エンドポイント
wss://chat.openrec.tv/socket.io/
概要
任意の配信のチャットやエールをリアルタイムで取得する．25秒ごとにping("2")を送る必要がある．※受信するメッセージはバックスラッシュでエスケープされたままだが `JSON.parse()`でうまく消せる．受信メッセージタイプ 0: コメント, 1: 同接, 3: 配信開始, 5: 配信終了, 6: ban追加, 7: ban解放, 8: モデ追加, 9: モデ解除, 11: タイトル変更などの情報, 12: テロップ追加, 13: テロップ削除, 29: アンケ開始, 30: アンケ途中結果, 31: アンケ結果, 43: プンレク拡張機能
認証
不要

パラメータ

パラメータ名型説明
movieIdstringMOVIE_IDは"https://public.openrec.tv/external/api/v5/movies/{M_ID}"から取得できる．
EIOnumber3
transportstring"websocket"
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/channel-ranks
概要
月間や週間のチャンネルランキングを取得する．
認証
不要

パラメータ

パラメータ名型説明
periodstringランキングの期間を指定する．hourly | daily | weekly | monthly
datenumber月間ランキングの年月をYYYYMMの形式で指定する．指定しなかった場合，現在の月になる．
tagstring不明
pagenumberページ数を指定する．デフォルトは1．
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/popular-channels
概要
？
認証
不要

パラメータ

パラメータ名型説明
pagenumberページ数を指定する．デフォルトは1．
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/channels/{USER_ID}
概要
USER_IDで指定したユーザのチャンネルの情報を取得する．
認証
不要
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/stats/daily-channels
概要
毎日配信しているチャンネルの一覧を取得する．
認証
不要

パラメータ

パラメータ名型説明
groupstringよくわからん．continuous_live_user_top?
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/search-movies
概要
任意のユーザの動画・VODの一覧を取得する．
認証
不要

パラメータ

パラメータ名型説明
sortstring並び順を指定できる．登録が新しい順: "published_at"，登録が古い順: "-published_at"，視聴数順: "total_views"．
include_deletedbool削除されたものを含めるか？(機能してる？)
channel_idsstring検索対象の配信者のID．指定しなかった場合は，OPENREC全体から結果が得られる
from_published_atstringISO8601形式で指定した日時以降の動画一覧を取得する．例: 2020-03-20T12:48:47.265Z．指定しなかった場合は，2015年1月1日以降として扱われる
to_published_atstringISO8601形式で指定した日時までの動画一覧を取得する．指定しなかった場合は，現在の日付までとして扱われる
game_idsstringゲームIDを指定して検索をフィルタする．
onair_statusnumber0が予約枠，1は配信中のもの，2がVODを指す
pagenumberページ数を指定する．デフォルトは1．
include_livebool配信を含めるか？
include_uploadbool投稿した動画を含めるか？
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/subs-channels/{USER_ID}
概要
USER_IDで指定したユーザが展開しているサブスクの情報を取得する．
認証
不要
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/ppv-events
概要
有料配信のリストを取得する．
認証
不要

パラメータ

パラメータ名型説明
user_idstringuser_idを指定すれば，特定のユーザのPPVのみを抽出できる．
pagenumberページ数を指定する．デフォルトは1．
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/users/{USER_ID}/teams
概要
USER_IDで指定したユーザが所属しているチームの情報を取得する．
認証
不要

パラメータ

パラメータ名型説明
pagenumberページ数を指定する．デフォルトは1．
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/playlists
概要
プレイリスト．
認証
不要

パラメータ

パラメータ名型説明
create_user_idstringプレイリスト作成者のユーザID．
playlist_typestringタイプを指定．movie | capture
pagenumberページ数を指定する．デフォルトは1．
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/capture-ranks
概要
人気のキャプチャの一覧を取得する．
認証
不要

パラメータ

パラメータ名型説明
periodstringランキングの期間を指定する．daily | weekly| monthly
datenumber月間ランキングの年月をYYYYMMの形式で指定する．このパラメータを指定した場合， periodでdailyを指定したとしても月間ランキングとなる．
is_channel_uniquebool各チャンネルにつきキャプチャを1つに制限するか？
pagenumberページ数を指定する．デフォルトは1．
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/captures
概要
特定のチャンネルや配信のキャプチャを取得する．
認証
不要

パラメータ

パラメータ名型説明
channel_idstringキャプチャの元の配信者のIDを指定することで，取得するキャプチャをその配信者だけに限定する．
movie_idstringキャプチャ元の配信を指定できる．{M_ID}
sortstring取得するデータを並び変える．並び変えれる順番は次の通り． views | public_at
sort_directionstring昇順か降順か指定する．ASC | DESC
pagenumberページ数を指定できる．デフォルトは1．
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/captures/{CAPTURE_ID}
概要
CAPTURE_IDで指定した任意の動画の情報を取得する．このCAPTURE_IDはキャプチャページのURLのもの．例えば"https://www.openrec.tv/capture/w6dl8gljq92"のCAPTURE_IDは"w6dl8gljq92"である．
認証
不要
メソッド
POST
エンドポイント
https://apiv5.openrec.tv/everyone/api/v5/reactions
概要
任意のキャプチャに対しリアクションをつける．ログインユーザであれば1つのキャプチャに5つまでリアクションをつけることができる．非ログインユーザでも1つだけリアクションをつけることができる．
認証
必要

パラメータ

パラメータ名型説明
target_idstringcapture_id
target_typestring"capture"
reaction_idstring送信するリアクションをここで指定する．指定できるリアクションは次の通り． arara | bikkuri | gg | hatena | kakke | kami | kansya | kawaii | kusa | music | nice | odoroki | sugo | tsuyo | umai | wakuwaku | wara | yaba
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/popular-movies
概要
動画一覧を取得
認証
不要

パラメータ

パラメータ名型説明
popular_typestring取得するタイプを指定できる．archive | upload | upload_archive
pagenumberページ数を指定する．デフォルトは1．
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/yell-ranks
概要
任意の配信や宛先配信者へのエールを金額の多い順のリストを取得する．
認証
不要

パラメータ

パラメータ名型説明
movie_idstringM_IDで指定した任意の配信のエールを取得する．M_IDは配信のURLのもの．
user_idstringエールの宛先を限定できる．
monthnumber年月をYYYYMMの形式で指定する．
pagenumberページ数を指定する．デフォルトは1．
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/yell-logs
概要
任意の配信へのエールを時系列順に取得する．
認証
不要

パラメータ

パラメータ名型説明
movie_idstringM_IDで指定した任意の配信のエールを取得する．M_IDは配信のURLのもの．
pagenumberページ数を指定する．デフォルトは1．
メソッド
GET
エンドポイント
https://apiv5.openrec.tv/api/v5/users/me?include_hidden_channels=true
概要
ログイン中のユーザに関する情報を取得する．
認証
必要

パラメータ

パラメータ名型説明
include_hidden_channelsbool?
メソッド
GET
エンドポイント
https://apiv5.openrec.tv/api/v5/users/me/timelines/movies
概要
登録しているチャンネルの配信・VODの一覧を取得する．
認証
必要

パラメータ

パラメータ名型説明
onair_statusnumber1が配信中のもの，2がVODを指す
limitnumber取得数の上限を指定する．
include_uploadbool?
メソッド
GET
エンドポイント
https://apiv5.openrec.tv/api/v5/users/me/timeline-movies/comingups
概要
登録チャンネルの予約枠の一覧を取得する．
認証
必要

パラメータ

パラメータ名型説明
limitnumber取得数の上限を指定する．
offsetnumberオフセット(トップからのずれ)を指定する．
メソッド
GET
エンドポイント
https://apiv5.openrec.tv/api/v5/users/me/notifications/count
概要
ログイン中のユーザの通知数を取得する．
認証
必要
メソッド
GET
エンドポイント
https://apiv5.openrec.tv/api/v5/users/me/notifications
概要
ログイン中のユーザの通知の内容を取得する．
認証
必要

パラメータ

パラメータ名型説明
offsetnumber取得する通知のオフセットを指定する．
limitnumber取得数の上限を指定する．
notification_typestring通知のタイプを指定する．normal | important
メソッド
PUT
エンドポイント
https://apiv5.openrec.tv/api/v5/users/me/chat-setting
概要
ログイン中のユーザのチャット設定を変更する．
認証
必要

パラメータ

パラメータ名型説明
name_colorstringチャットの名前の色を変更する．16進のカラーコードで指定する．(プレ垢限定機能)
is_fixed_phrase_hiddenbool定型文を表示するか？
muted_warned_userbool警告ユーザを非表示にするか？
muted_fresh_userbool🔰新参ユーザを非表示にするか？
muted_banned_wordboolNGワードに登録した単語を含むコメントを非表示にするか？
muted_unauthenticated_userbool未ログインユーザを非表示にするか？
adjust_chat_delaybool超低遅延ユーザのコメントの表示を遅延させるか？
is_small_size_stampboolスタンプの表示を小さくするか？
is_subs_badge_hiddenbool自身のサブスクバッジを非表示にするか？
is_premium_hiddenbool自身がプレ垢であることを非表示にするか？
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/spotlights
概要
プンレクトップに載っているバナーの情報を取得する．
認証
不要

パラメータ

パラメータ名型説明
device_typestringデバイスタイプを指定する． web | android | ios
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/informations
概要
プンレクからのお知らせを取得する．メンテの情報など
認証
不要

パラメータ

パラメータ名型説明
device_typestringデバイスタイプを指定する． web | android | ios
user_typenumber?
group_keystringinformation_top?
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/feature-tags
概要
配信中の枠の人気タグを取得する．
認証
不要
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/fes-events
概要
フェス一覧
認証
不要

パラメータ

パラメータ名型説明
statusstringopened | closed | scheduled
pagenumberページ数を指定する．デフォルトは1．
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/fes-events/{FES_ID}
概要
FES_IDで指定したイベントの詳細情報を取得する．
認証
不要

パラメータ

パラメータ名型説明
secret_keystringよくわからん．undefinedでいい？
include_contentboolよくわからん
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/popular-games
概要
現在，配信されているゲームを同接が高い順に取得する．
認証
不要

パラメータ

パラメータ名型説明
pagenumberページ数を指定する．デフォルトは1．
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/search-users
概要
OPENRECのユーザを検索する．
認証
不要

パラメータ

パラメータ名型説明
search_querystring検索文字列
channel_onlybool配信者権限があるユーザのみに限定するか？
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/search-games
概要
ゲームの検索
認証
不要

パラメータ

パラメータ名型説明
search_querystring検索文字列
メソッド
GET
エンドポイント
https://public.openrec.tv/external/api/v5/search-movies
概要
配信・動画の検索
認証
不要

パラメータ

パラメータ名型説明
search_querystring検索文字列