Contents List
初めに #
MikoAPI v2 はのふれむが1年以上前に脳死で適当に作って多数のバグが放置されていたMikoAPIを新たにDocker環境を用いて、Python3.9で書き直したWeb APIです。
MikoAPIとは? #
MikoAPIはホロライブ所属、エリート(ポンコツ)巫女「さくらみこ」さんのYouTube, Twitter, Twitchの情報を可能な限りリアルタイムに取得することをコンセプトにのふれむが制作したWeb APIです。
MikoAPI v2の中身 #
今回、新しく書き直したMikoAPI v2 は、Docker環境で動作しています。
構成は以下の通りです。
- FastAPI
- Worker
- Dashboard
- Redis
- MariaDB
- phpMyAdmin
これらをDocker Composeで管理しているので上記6つのDockerイメージをコマンド１つで構築から起動ができます。
Wokerでは、CeleryというPythonライブラリを用いてタスクのスケジューリングを行い、定期的に各種APIにリクエストを行い情報を取得しています。
スケジュール管理データはRedisに保存し、各種APIから取得したデータはMariaDBに保存しています。
YouTube DataAPI v3の認証にはAPI KeyではなくOAuth2.0認証を用いることによってメンバー限定配信の情報も取得できるようにしています。
現在は、GCPのQuotaの制限によってデータの更新頻度が遅いですが、増量申請が通り次第、更新頻度を引き上げます。
Dashboardでは、Celeryのタスク実行状況をWebから見れるようにしています。各種APIリクエストでエラーが出た時にそのエラー内容をWebからチェック出来るので便利です。
phpMyAdminはMariaDBの中身を確認や編集を行うために使用しています。WorkerからMariaDBへの接続はDocker Compose内のネットワークで完結しているので外部からのDBへアクセスが出来ない為です。
MikoAPI v2の最重要機能であるWeb APIを提供する部分にはFastAPIというPythonライブラリを使用しています。
APIの非同期処理が簡単にできることで使われてことが多いライブラリですが今回は一部処理を除いて基本的に非同期処理は行わない処理になっています。
今後非同期処理についての知識が十分身についたら少しずつ非同期処理に書きなをしていく予定です。
APIリファレンス #
MikoAPI v2にアクセスすると全てJsonでレスポンスが返ってきます。
もしJson以外のレスポンスがあった場合、MikoAPI 側で何らかのエラーが発生していることになります。
MikoAPI v2の使用方法 #
https://api.nyahello.jp/v2/<Path>/?<QueryParms>MikoAPI v2は上記のURLで提供されています。
<Path>や<QueryParms>を設定することで様々なデータを取得する事が可能です。
このURLにGetリクエストを行うとJsonでデータを取得できます。
以下のリストから取得できる情報の詳細を見る事ができます。
基本情報の取得 #
<Path>や<QueryParms>を設定せずにアクセスするとMikoAPI v2についての基本情報が返ってきます。
https://api.nyahello.jp/v2/レスポンス詳細
レスポンスは以下の通りです
{
"Message": "NyaHello world!",
"Docs": "https://api.nyahello.jp/v2/docs",
"Redoc": "https://api.nyahello.jp/v2/redoc",
"Source": "https://github.com/Elite35P-Server/MikoAPI",
"Organization": "Elite35P Server",
"HP": "https://nyahello.jp",
"Twitter": "https://twitter.com/35p_discord",
"Contact": "admin@nyahello.jp"
}レスポンス内容の詳細はこちら
| レスポンスキー名称 | データ型 | 詳細 |
|---|---|---|
| Message | String | にゃっはろ〜! |
| Docs | String | FastAPIによる自動生成のOpenAPIドキュメントリンク1 |
| Redoc | String | FastAPIによる自動生成のOpenAPIドキュメントリンク2 |
| Source | String | MikoAPI v2のソースコードリンク(GitHub) ※現在はプライベートリポジトリ |
| Organization | String | 開発組織名: えりーと35P サーバー/Elite35P Server |
| HP | String | ホームページリンク |
| String | 開発組織のTwitterリンク | |
| Contact | String | このAPIに関してのお問合せ用E-mailアドレス |
HTTPステータスコード一覧
| HTTPステータスコード | 詳細 |
|---|---|
| 200 | 正常に処理が終了 |
| 400~500 | API側でエラーが発生 |
OpenAPIドキュメント
FastAPIが自動生成したOpenAPIドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから
実際に試す
下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。
トークン認証 #
※現在トークン認証はご利用いただけません。
MikoAPI v2の全ての機能が認証なしでご利用いただけます。
今後APIのアクセスが増加しサーバー負荷が高くなった場合トークン認証やレート制限を設定する可能性があります。
YouTubeデータの取得 #
YouTube関連のデータを取得できます。
取得できるデータは以下のリストの通りです。
- みこちのYouTubeチャンネルの取得
- みこちのYouTubeチャンネル内の動画/配信アーカイブデータの複数取得
- みこちのYouTubeチャンネル内の動画/配信アーカイブデータの単体取得
- みこちのYoutubeチャンネル内の動画/配信アーカイブのコメントデータ複数取得
- みこちのYoutubeチャンネル内の動画/配信アーカイブのコメントデータ単体取得
- みこちのYoutubeチャンネル内の配信アーカイブのライブチャットデータ複数取得
- みこちのYoutubeチャンネル内の配信アーカイブのライブチャットデータ単体取得
- YouTubeアカウント情報の単体取得
みこちのYouTubeチャンネルの取得
みこちのYouTubeチャンネルの情報を取得することができます。
https://api.nyahello.jp/v2/youtube/?<QueryParms>クエリパラメータ詳細
クエリパラメータの詳細は以下の通りです。
| パラメータ名称 | データ型 | 必須/任意 | デフォルト | 意味 | 詳細 |
|---|---|---|---|---|---|
| video | Boolean | 任意 | false | 動画取得の有無 | このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内の動画データを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。 |
| video_skip | Integer | 任意 | 0 | 取得開始位置 | videoがtrueの時のみに有効なパラメータです。動画取得の開始位置を設定します。 |
| video_limit | Integer | 任意 | 10 | 取得終了位置 | videoがtrueの時のみに有効なパラメータです。動画取得の終了位置を設定します。動画情報は１回のリクエストで35件まで取得できます。それ以上の値を指定しても自動で取得数が35件に制限されます。 |
| comment | Boolean | 任意 | false | コメント取得の有無 | このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のコメントデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。 |
| comment_skip | Integer | 任意 | 0 | 取得開始位置 | commentがtrueの時のみに有効なパラメータです。コメント取得の開始位置を設定します。 |
| comment_limit | Integer | 任意 | 20 | 取得終了位置 | commentがtrueの時のみに有効なパラメータです。コメント取得の終了位置を設定します。動画情報は１回のリクエストで70件まで取得できます。それ以上の値を指定しても自動で取得数が70件に制限されます。 |
| live_comment | Boolean | 任意 | false | ライブチャット取得の有無 | このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のライブチャットデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずchat_noが最新のものから順に取得されます。 |
| live_comment_skip | Integer | 任意 | 0 | 取得開始位置 | live_commentがtrueの時のみに有効なパラメータです。ライブチャット取得の開始位置を設定します。 |
| live_comment_limit | Integer | 任意 | 50 | 取得終了位置 | live_commentがtrueの時のみに有効なパラメータです。ライブチャット取得の終了位置を設定します。動画情報は１回のリクエストで135件まで取得できます。それ以上の値を指定しても自動で取得数が135件に制限されます。 |
レスポンス詳細
レスポンス例は以下の通りです。
{
"id": "UC-hM6YJuNYVAmUWxeIr9FeA",
"name": "Miko Ch. さくらみこ",
"icon": "https://yt3.ggpht.com/ytc/AKedOLQlZnbXr-RooUQezemDKu7alJrZcEMy8_5P07I...",
"description": "にゃっはろ～！\nホロライブ所属のエリート巫女アイドル さくらみこ (Sakura Miko)だにぇ🐱🌸...",
"subsc_count": 1400000,
"play_count": 187261634,
"video_count": 704,
"status": "none",
"videos": [],
"comments": [],
"live_comments": [],
"updated_at": "2022-03-11T06:30:00"
}レスポンス内容の詳細はこちら
| レスポンスキー名称 | データ型 | 詳細 |
|---|---|---|
| id | String | YouTubeチャンネルID |
| name | String | YouTubeチャンネル名 |
| icon | String | YouTubeチャンネルアイコンURL |
| description | String | YouTubeチャンネル概要 |
| subsc_count | Integer | YouTubeチャンネル登録者数 |
| play_count | Integer | YouTubeチャンネル総再生聴回数 |
| video_count | Integer | YouTubeチャンネル総動画本数 |
| status | String | YouTubeチャンネルステータス live(配信中),upcoming(待機枠あり),none(配信及び待機枠なし)の3種類です |
| videos | Dict | YouTubeチャンネル内の動画データ 詳細はこちら |
| comments | Dict | YouTubeチャンネル内のコメントデータ 詳細はこちら ※コメントが無効化されている場合には[]となります |
| live_comments | Dict | YouTubeチャンネル内のライブチャットデータ 詳細はこちら ※アーカイブのチャットリプレイが無効化されている場合には[]となります |
| update_at | DateTime | YouTubeチャンネル情報の更新時刻(UTC) |
HTTPステータスコード一覧
| HTTPステータスコード(HTTP Status Code) | 詳細(Details) |
|---|---|
| 200 | 正常に処理が終了 |
| 422 | クエリパラメータエラー |
| 400~500 | API側でエラーが発生 |
OpenAPIドキュメント
FastAPIが自動生成したドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから
実際に試す
下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。
みこちのYouTubeチャンネル内の動画/配信アーカイブデータの複数取得
みこちのYouTubeチャンネル内の動画/アーカイブの情報を複数取得することができます。
https://api.nyahello.jp/v2/youtube/videos/?<QueryParms>クエリパラメータ詳細
クエリパラメータの詳細は以下の通りです
| パラメータ名称 | データ型 | 必須/任意 | デフォルト | 意味 | 詳細 |
|---|---|---|---|---|---|
| order | String | 任意 | created_at | 動画取得オプション | 動画取得の順序や絞り込みが行えます。使用可能オプション created_at(作成順),ss_time(開始予定時刻順),like_count(高評価数順),play_count(再生回数順),comment_count(コメント数順),live(配信orプレミア公開中の動画),upcoming(配信待機枠),none(statusがlive、upcomingの動画) |
| skip | Integer | 任意 | 0 | 取得開始位置 | 動画取得の開始位置を設定します。 |
| limit | Integer | 任意 | 10 | 取得終了位置 | 動画取得の終了位置を設定します。動画情報は１回のリクエストで35件まで取得できます。それ以上の値を指定しても自動で取得数が35件に制限されます。 |
| comment | Boolean | 任意 | false | コメント取得の有無 | このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のコメントデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。 |
| comment_skip | Integer | 任意 | 0 | 取得開始位置 | commentがtrueの時のみに有効なパラメータです。コメント取得の開始位置を設定します。 |
| comment_limit | Integer | 任意 | 20 | 取得終了位置 | commentがtrueの時のみに有効なパラメータです。コメント取得の終了位置を設定します。動画情報は１回のリクエストで70件まで取得できます。それ以上の値を指定しても自動で取得数が70件に制限されます。 |
| live_comment | Boolean | 任意 | false | ライブチャット取得の有無 | このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のライブチャットデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずchat_noが最新のものから順に取得されます。 |
| live_comment_skip | Integer | 任意 | 0 | 取得開始位置 | live_commentがtrueの時のみに有効なパラメータです。ライブチャット取得の開始位置を設定します。 |
| live_comment_limit | Integer | 任意 | 50 | 取得終了位置 | live_commentがtrueの時のみに有効なパラメータです。ライブチャット取得の終了位置を設定します。動画情報は１回のリクエストで135件まで取得できます。それ以上の値を指定しても自動で取得数が135件に制限されます。 |
レスポンス詳細
レスポンス例は以下の通りです。リスト型でレスポンスが返ってきます。
[
{
"id": "X9zw0QF12Kc",
"title": "サクラカゼ / さくらみこ【オリジナル曲】",
"thumbnails": {
"default": {
"url": "https://i.ytimg.com/vi/X9zw0QF12Kc/default.jpg",
"width": 120,
"height": 90
},
"medium": {
"url": "https://i.ytimg.com/vi/X9zw0QF12Kc/mqdefault.jpg",
"width": 320,
"height": 180
},
"high": {
"url": "https://i.ytimg.com/vi/X9zw0QF12Kc/hqdefault.jpg",
"width": 480,
"height": 360
},
"standard": {
"url": "https://i.ytimg.com/vi/X9zw0QF12Kc/sddefault.jpg",
"width": 640,
"height": 480
},
"maxres": {
"url": "https://i.ytimg.com/vi/X9zw0QF12Kc/maxresdefault.jpg",
"width": 1280,
"height": 720
}
},
"description": "さくらみこ 2ndオリジナル楽曲\n 『サクラカゼ』\n\n2020年10月22日0時より...",
"url": "https://youtu.be/X9zw0QF12Kc",
"play_count": 2379449,
"like_count": 75559,
"comment_count": 1993,
"comments": [],
"live_comments": [],
"status": "none",
"current_viewers": null,
"ss_time": "2020-03-27T11:00:00",
"as_time": "2020-03-27T11:00:12",
"ae_time": "2020-03-27T11:05:56",
"created_at": "2020-03-27T12:48:32",
"updated_at": "2022-03-11T06:00:00"
}
]レスポンス内容の詳細はこちら
| レスポンスキー名称 | データ型 | 詳細 |
|---|---|---|
| id | String | YouTube 動画ID |
| title | String | 動画タイトル |
| thumbnails | Dict | 動画サムネイルURL 解像度別に複数辞書型で5種類の画像URLが取得できます |
| description | String | 動画概要 |
| url | String | 動画リンク |
| play_count | Integer | 動画再生回数 |
| like_count | Integer | 高評価数 |
| comment_count | Integer | コメント数 |
| comments | Dict | 動画内のコメントデータ 詳細はこちら ※コメントが無効化されている場合には[]となります |
| live_comments | Dict | 動画内のライブチャットデータ 詳細はこちら ※アーカイブのチャットリプレイが無効化されている場合には[]となります |
| status | String | 動画テータス live(配信中),upcoming(待機状態),none(アーカイブor動画)の3種類です |
| current_viewers | Integer | 配信中の同時接続数(同時視聴者数) ※配信中以外はnullとなります |
| ss_time | DateTime | Scheduled Stream Start Time(配信開始予定時刻/プレミア公開予定時刻) ※配信アーカイブ/プレミア公開動画以外(通常のアップロード動画)やゲリラ配信時(配信待機枠を作成せず配信を開始した場合)はnullとなります |
| as_time | DateTime | Actuary Stream Start Time(配信開始時刻/プレミア公開時刻) ※配信アーカイブ/プレミア公開動画以外(通常のアップロード動画)はnullとなります |
| ae_time | DateTime | Actuary Stream End Time(配信終了時刻/プレミア公開終了時刻) ※配信アーカイブ/プレミア公開動画以外(通常のアップロード動画)はnullとなります |
| created_at | DateTime | 動画の作成時刻(UTC) |
| update_at | DateTime | 動画の更新時刻(UTC) |
HTTPステータスコード一覧
| HTTPステータスコード(HTTP Status Code) | 詳細(Details) |
|---|---|
| 200 | 正常に処理が終了 |
| 400 | orderクエリエラー |
| 422 | クエリパラメータエラー |
| 400~500 | API側でエラーが発生 |
OpenAPIドキュメント
FastAPIが自動生成したOpenAPIドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから
実際に試す
下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。
みこちのYouTubeチャンネル内の動画/配信アーカイブデータの単体取得
みこちのYouTubeチャンネル内の動画/アーカイブの情報を動画IDを指定して単体で取得することができます。
https://api.nyahello.jp/v2/youtube/videos/{video_id}/?<QueryParms>パラメータ詳細
パラメータの詳細は以下の通りです。
| パラメータ名称 | データ型 | 必須/任意 | デフォルト | 意味 | 詳細 |
|---|---|---|---|---|---|
| video_id | String | 必要 | N/A | 動画ID | YouTube 動画ID |
| comment | Boolean | 任意 | false | コメント取得の有無 | このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のコメントデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。 |
| comment_skip | Integer | 任意 | 0 | 取得開始位置 | commentがtrueの時のみに有効なパラメータです。コメント取得の開始位置を設定します。 |
| comment_limit | Integer | 任意 | 20 | 取得終了位置 | commentがtrueの時のみに有効なパラメータです。コメント取得の終了位置を設定します。動画情報は１回のリクエストで70件まで取得できます。それ以上の値を指定しても自動で取得数が70件に制限されます。 |
| live_comment | Boolean | 任意 | false | ライブチャット取得の有無 | このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のライブチャットデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずchat_noが最新のものから順に取得されます。 |
| live_comment_skip | Integer | 任意 | 0 | 取得開始位置 | live_commentがtrueの時のみに有効なパラメータです。ライブチャット取得の開始位置を設定します。 |
| live_comment_limit | Integer | 任意 | 50 | 取得終了位置 | live_commentがtrueの時のみに有効なパラメータです。ライブチャット取得の終了位置を設定します。動画情報は１回のリクエストで135件まで取得できます。それ以上の値を指定しても自動で取得数が135件に制限されます。 |
レスポンス詳細
レスポンス例は以下の通りです。
{
"id": "X9zw0QF12Kc",
"title": "サクラカゼ / さくらみこ【オリジナル曲】",
"thumbnails": {
"default": {
"url": "https://i.ytimg.com/vi/X9zw0QF12Kc/default.jpg",
"width": 120,
"height": 90
},
"medium": {
"url": "https://i.ytimg.com/vi/X9zw0QF12Kc/mqdefault.jpg",
"width": 320,
"height": 180
},
"high": {
"url": "https://i.ytimg.com/vi/X9zw0QF12Kc/hqdefault.jpg",
"width": 480,
"height": 360
},
"standard": {
"url": "https://i.ytimg.com/vi/X9zw0QF12Kc/sddefault.jpg",
"width": 640,
"height": 480
},
"maxres": {
"url": "https://i.ytimg.com/vi/X9zw0QF12Kc/maxresdefault.jpg",
"width": 1280,
"height": 720
}
},
"description": "さくらみこ 2ndオリジナル楽曲\n 『サクラカゼ』\n\n2020年10月22日0時より...",
"url": "https://youtu.be/X9zw0QF12Kc",
"play_count": 2379449,
"like_count": 75559,
"comment_count": 1993,
"comments": [],
"live_comments": [],
"status": "none",
"current_viewers": null,
"ss_time": "2020-03-27T11:00:00",
"as_time": "2020-03-27T11:00:12",
"ae_time": "2020-03-27T11:05:56",
"created_at": "2020-03-27T12:48:32",
"updated_at": "2022-03-11T06:00:00"
}レスポンス内容の詳細はこちら
| レスポンスキー名称 | データ型 | 詳細 |
|---|---|---|
| id | String | YouTube 動画ID |
| title | String | 動画タイトル |
| thumbnails | Dict | 動画サムネイルURL 解像度別に複数辞書型で5種類の画像URLが取得できます |
| description | String | 動画概要 |
| url | String | 動画リンク |
| play_count | Integer | 動画再生回数 |
| like_count | Integer | 高評価数 |
| comment_count | Integer | コメント数 |
| comments | Dict | 動画内のコメントデータ 詳細はこちら ※コメントが無効化されている場合には[]となります |
| live_comments | Dict | 動画内のライブチャットデータ 詳細はこちら ※アーカイブのチャットリプレイが無効化されている場合には[]となります |
| status | String | 動画テータス live(配信中),upcoming(待機状態),none(アーカイブor動画)の3種類です |
| current_viewers | Integer | 配信中の同時接続数(同時視聴者数) ※配信中以外はnullとなります |
| ss_time | DateTime | Scheduled Stream Start Time(配信開始予定時刻/プレミア公開予定時刻) ※配信アーカイブ/プレミア公開動画以外(通常のアップロード動画)やゲリラ配信時(配信待機枠を作成せず配信を開始した場合)はnullとなります |
| as_time | DateTime | Actuary Stream Start Time(配信開始時刻/プレミア公開時刻) ※配信アーカイブ/プレミア公開動画以外(通常のアップロード動画)はnullとなります |
| ae_time | DateTime | Actuary Stream End Time(配信終了時刻/プレミア公開終了時刻) ※配信アーカイブ/プレミア公開動画以外(通常のアップロード動画)はnullとなります |
| created_at | DateTime | 動画の作成時刻(UTC) |
| update_at | DateTime | 動画の更新時刻(UTC) |
HTTPステータスコード一覧
| HTTPステータスコード(HTTP Status Code) | 詳細(Details) |
|---|---|
| 200 | 正常に処理が終了 |
| 404 | not found |
| 422 | クエリパラメータエラー |
| 400~500 | API側でエラーが発生 |
OpenAPIドキュメント
FastAPIが自動生成したOpenAPIドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから
実際に試す
下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。
みこちのYoutubeチャンネル内の動画/配信アーカイブのコメントデータ複数取得
みこちのYouTubeチャンネル内の動画/アーカイブの情報を動画IDを指定して単体で取得することができます。
https://api.nyahello.jp/v2/youtube/videos/{video_id}/comments/?<QueryParms>パラメータ詳細
パラメータの詳細は以下の通りです。
| パラメータ名称 | データ型 | 必須/任意 | デフォルト | 意味 | 詳細 |
|---|---|---|---|---|---|
| video_id | String | 必要 | N/A | 動画ID | YouTube 動画ID |
| order | String | 任意 | created_at | コメント取得順序 | コメント取得の順序や絞り込みが行えます。created_at(作成順), like_count(高評価数順) |
| skip | Integer | 任意 | 0 | 取得開始位置 | コメント取得の開始位置を設定します。 |
| limit | Integer | 任意 | 20 | 取得終了位置 | コメント取得の終了位置を設定します。動画情報は１回のリクエストで70件まで取得できます。それ以上の値を指定しても自動で取得数が70件に制限されます。 |
レスポンス詳細
レスポンス例は以下の通りです。リスト型でレスポンスが返ってきます。
[
{
"id": "Ugw16kGJrcCaYT1iI454AaABAg",
"video_id": "TXD4qJHN4ac",
"author_id": "UCp-5t9SrOQwXMU7iIjQfARg",
"name": "Mio Channel 大神ミオ",
"icon": "https://yt3.ggpht.com/Z78RNXxUqpOGYKFt-VrJV7nlehOHzl7Ta-l1cgPx5Ewucmr5kY64i...",
"display_text": "すこ😍",
"original_text": "すこ😍",
"like_count": 1816,
"can_reply": true,
"reply_count": 41,
"is_public": true,
"created_at": "2022-03-09T11:32:37",
"updated_at": "2022-03-09T11:32:37"
}
]レスポンス内容の詳細はこちら
| レスポンスキー名称 | データ型 | 詳細 |
|---|---|---|
| id | String | YouTube コメントID |
| video_id | String | コメントが存在する 動画ID |
| author_id | String | コメントを書き込んだ人のYouTubeチャンネルID |
| name | String | コメントを書き込んだ人のYouTubeチャンネル名 |
| icon | String | コメントを書き込んだ人のYouTubeチャンネルアイコンURL |
| display_text | String | 表示テキスト |
| original_text | String | HTMLテキスト |
| like_count | Integer | 高評価数 |
| can_reply | Boolean | コメントに返信が可能かどうか |
| reply_count | Integer | 返信数 |
| is_public | Boolean | コメントが表示されるかどうか |
| created_at | DateTime | コメントの作成時刻(UTC) |
| update_at | DateTime | コメントの更新時刻(UTC) |
HTTPステータスコード一覧
| HTTPステータスコード(HTTP Status Code) | 詳細(Details) |
|---|---|
| 200 | 正常に処理が終了 |
| 400 | orderクエリエラー |
| 422 | クエリパラメータエラー |
| 400~500 | API側でエラーが発生 |
OpenAPIドキュメント
FastAPIが自動生成したOpenAPIドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから
実際に試す
下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。
みこちのYoutubeチャンネル内の動画/配信アーカイブのコメントデータ単体取得
みこちのYouTubeチャンネル内の動画/アーカイブの情報を動画IDを指定して単体で取得することができます。
https://api.nyahello.jp/v2/youtube/comments/{comment_id}パラメータ詳細
パラメータの詳細は以下の通りです。
| パラメータ名称 | データ型 | 必須/任意 | デフォルト | 意味 | 詳細 |
|---|---|---|---|---|---|
| comment_id | String | 必要 | N/A | コメントID | YouTube コメントID |
レスポンス詳細
レスポンス例は以下の通りです。
{
"id": "Ugw16kGJrcCaYT1iI454AaABAg",
"video_id": "TXD4qJHN4ac",
"author_id": "UCp-5t9SrOQwXMU7iIjQfARg",
"name": "Mio Channel 大神ミオ",
"icon": "https://yt3.ggpht.com/Z78RNXxUqpOGYKFt-VrJV7nlehOHzl7Ta-l1cgPx5Ewucmr5kY64iGxm...",
"display_text": "すこ😍",
"original_text": "すこ😍",
"like_count": 1816,
"can_reply": true,
"reply_count": 41,
"is_public": true,
"created_at": "2022-03-09T11:32:37",
"updated_at": "2022-03-09T11:32:37"
}レスポンス内容の詳細はこちら
| レスポンスキー名称 | データ型 | 詳細 |
|---|---|---|
| id | String | YouTube コメントID |
| video_id | String | コメントが存在する 動画ID |
| author_id | String | コメントを書き込んだ人のYouTubeチャンネルID |
| name | String | コメントを書き込んだ人のYouTubeチャンネル名 |
| icon | String | コメントを書き込んだ人のYouTubeチャンネルアイコンURL |
| display_text | String | 表示テキスト |
| original_text | String | HTMLテキスト |
| like_count | Integer | 高評価数 |
| can_reply | Boolean | コメントに返信が可能かどうか |
| reply_count | Integer | 返信数 |
| is_public | Boolean | コメントが表示されるかどうか |
| created_at | DateTime | コメントの作成時刻(UTC) |
| update_at | DateTime | コメントの更新時刻(UTC) |
HTTPステータスコード一覧
| HTTPステータスコード(HTTP Status Code) | 詳細(Details) |
|---|---|
| 200 | 正常に処理が終了 |
| 404 | not found |
| 422 | クエリパラメータエラー |
| 400~500 | API側でエラーが発生 |
OpenAPIドキュメント
FastAPIが自動生成したOpenAPIドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから
実際に試す
下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。
みこちのYoutubeチャンネル内の配信アーカイブのライブチャットデータ複数取得
みこちのYouTubeチャンネル内の動画/アーカイブの情報を動画IDを指定して単体で取得することができます。
https://api.nyahello.jp/v2/youtube/videos/{video_id}/live_comments/?<QueryParms>パラメータ詳細
パラメータの詳細は以下の通りです。
| パラメータ名称 | データ型 | 必須/任意 | デフォルト | 意味 | 詳細 |
|---|---|---|---|---|---|
| video_id | String | 必要 | N/A | 動画ID | YouTube 動画ID |
| order | String | 任意 | chat_no | コメント取得順序 | コメント取得の順序や絞り込みが行えます。chat_no(チャット順), normalchat(通常チャット), superchat(スーパーチャット), member_none(メンバーシップ未加入), member_0(新規メンバーシップ), member_1(メンバーシップ1ヶ月目), member_6(メンバーシップ6ヶ月目), member_12(メンバーシップ1年目), member_24(メンバーシップ2年目), moderator(モデレーター及び確認済み(スパナ)) |
| skip | Integer | 任意 | 0 | 取得開始位置 | コメント取得の開始位置を設定します。 |
| limit | Integer | 任意 | 50 | 取得終了位置 | コメント取得の終了位置を設定します。動画情報は１回のリクエストで135件まで取得できます。それ以上の値を指定しても自動で取得数が135件に制限されます。 |
レスポンス詳細
レスポンス例は以下の通りです。リスト型でレスポンスが返ってきます。
[
{
"id": "CjoKGkNKcmRzcHZjc2ZZQ0ZiSUxyUVlkZ3kwTkx3EhxDTFRmN1lfY3NmWUNGYnRZRHdJZDJYMEw2US0w",
"video_id": "IuBnNA3GOwc",
"author_id": "UC5CwaMl1eIgY8h02uZw7u8A",
"name": "Suisei Channel",
"icon": "https://yt4.ggpht.com/ytc/AKedOLT7D-JlLZGTq6Y95nLxeXG2B-7WMGpFXZ7Qa4iY5w=s64-c-...",
"author_badge": "確認済み",
"text": "みこちうしろ、、、",
"type": "NORMALCHAT",
"purchase_amount": null,
"time": "1:41:00",
"timestamp_usec": "1646577775906597",
"video_offset_time_msec": "6060275",
"chat_no": 29049,
"updated_at": "2022-03-10T06:33:34"
}
]レスポンス内容の詳細はこちら
| レスポンスキー名称 | データ型 | 詳細 |
|---|---|---|
| id | String | YouTube ライブチャットID |
| video_id | String | チャットが存在する 配信アーカイブID |
| author_id | String | チャットを書き込んだ人のYouTubeチャンネルID |
| name | String | コメントを書き込んだ人のYouTubeチャンネル名 |
| icon | String | コメントを書き込んだ人のYouTubeチャンネルアイコンURL |
| author_badge | String | コメントを書き込んだ人の情報(メンバー何ヶ月目or確認済みorメンバー未加入ならnullではなく”) |
| text | String | 表示テキスト |
| type | String | チャットタイプ NORMALCHAT(通常チャット), SUPERCHAT(スーパーチャット) |
| purchase_amount | String | スーパーチャット金額(通貨によって¥や$が後ろにつくため、IntegerでなくString) ※typeがNORMALCHATの時はnull |
| time | String | チャットされた時間(配信アーカイブ時間) |
| timestamp_usec | String | チャットされた時間(タイムスタンプusec) |
| video_offset_time_msec | String | チャットされた時間(配信アーカイブ offset time msec) |
| chat_no | Integer | チャット番号(1から順にカウントを開始) |
| update_at | DateTime | ライブチャットの更新時刻(UTC) |
HTTPステータスコード一覧
| HTTPステータスコード(HTTP Status Code) | 詳細(Details) |
|---|---|
| 200 | 正常に処理が終了 |
| 400 | orderクエリエラー |
| 422 | クエリパラメータエラー |
| 400~500 | API側でエラーが発生 |
OpenAPIドキュメント
FastAPIが自動生成したOpenAPIドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから
実際に試す
下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。
みこちのYoutubeチャンネル内の配信アーカイブのライブチャットデータ単体取得
みこちのYouTubeチャンネル内の動画/アーカイブの情報を動画IDを指定して単体で取得することができます。
https://api.nyahello.jp/v2/youtube/live_comments/{live_comment_id}パラメータ詳細
パラメータの詳細は以下の通りです。
| パラメータ名称 | データ型 | 必須/任意 | デフォルト | 意味 | 詳細 |
|---|---|---|---|---|---|
| live_comment_id | String | 必要 | N/A | ライブチャットID | YouTube ライブチャットID |
レスポンス詳細
レスポンス例は以下の通りです。
{
"id": "CjoKGkNKcmRzcHZjc2ZZQ0ZiSUxyUVlkZ3kwTkx3EhxDTFRmN1lfY3NmWUNGYnRZRHdJZDJYMEw2US0w",
"video_id": "IuBnNA3GOwc",
"author_id": "UC5CwaMl1eIgY8h02uZw7u8A",
"name": "Suisei Channel",
"icon": "https://yt4.ggpht.com/ytc/AKedOLT7D-JlLZGTq6Y95nLxeXG2B-7WMGpFXZ7Qa4iY5w...",
"author_badge": "確認済み",
"text": "みこちうしろ、、、",
"type": "NORMALCHAT",
"purchase_amount": null,
"time": "1:41:00",
"timestamp_usec": "1646577775906597",
"video_offset_time_msec": "6060275",
"chat_no": 29049,
"updated_at": "2022-03-10T06:33:34"
}レスポンス内容の詳細はこちら
| レスポンスキー名称 | データ型 | 詳細 |
|---|---|---|
| id | String | YouTube ライブチャットID |
| video_id | String | チャットが存在する 配信アーカイブID |
| author_id | String | チャットを書き込んだ人のYouTubeチャンネルID |
| name | String | コメントを書き込んだ人のYouTubeチャンネル名 |
| icon | String | コメントを書き込んだ人のYouTubeチャンネルアイコンURL |
| author_badge | String | コメントを書き込んだ人の情報(メンバー何ヶ月目かor確認済みかorメンバー未加入ならnullではなく”) |
| text | String | 表示テキスト |
| type | String | チャットタイプ NORMALCHAT(通常チャット), SUPERCHAT(スーパーチャット) |
| purchase_amount | String | スーパーチャット金額(通貨によって¥や$が後ろにつくため、IntegerでなくString) ※typeがNORMALCHATの時はnull |
| time | String | チャットされた時間(配信アーカイブ時間) |
| timestamp_usec | String | チャットされた時間(タイムスタンプusec) |
| video_offset_time_msec | String | チャットされた時間(配信アーカイブ offset time msec) |
| chat_no | Integer | チャット番号(1から順にカウントを開始) |
| update_at | DateTime | ライブチャットの更新時刻(UTC) |
HTTPステータスコード一覧
| HTTPステータスコード(HTTP Status Code) | 詳細(Details) |
|---|---|
| 200 | 正常に処理が終了 |
| 404 | not found |
| 400~500 | API側でエラーが発生 |
OpenAPIドキュメント
FastAPIが自動生成したOpenAPIドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから
実際に試す
下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。
YouTubeアカウント情報の単体取得
YouTubeチャンネル(アカウント)IDを指定してアカウント情報(アカウントID,アカウント名,アカウントアイコンURL,コメント,ライブチャット)を取得できます。
https://api.nyahello.jp/v2/youtube/users/{user_id}パラメータ詳細
パラメータの詳細は以下の通りです。
| パラメータ名称 | データ型 | 必須/任意 | デフォルト | 意味 | 詳細 |
|---|---|---|---|---|---|
| user_id | String | 必要 | N/A | YouTubeチャンネル(ユーザー)ID | YouTubeチャンネル(ユーザー)ID |
| comment | Boolean | 任意 | false | コメント取得の有無 | このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のコメントデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。 |
| comment_skip | Integer | 任意 | 0 | 取得開始位置 | commentがtrueの時のみに有効なパラメータです。コメント取得の開始位置を設定します。 |
| comment_limit | Integer | 任意 | 20 | 取得終了位置 | commentがtrueの時のみに有効なパラメータです。コメント取得の終了位置を設定します。動画情報は１回のリクエストで70件まで取得できます。それ以上の値を指定しても自動で取得数が70件に制限されます。 |
| live_comment | Boolean | 任意 | false | ライブチャット取得の有無 | このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のライブチャットデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずchat_noが最新のものから順に取得されます。 |
| live_comment_skip | Integer | 任意 | 0 | 取得開始位置 | live_commentがtrueの時のみに有効なパラメータです。ライブチャット取得の開始位置を設定します。 |
| live_comment_limit | Integer | 任意 | 50 | 取得終了位置 | live_commentがtrueの時のみに有効なパラメータです。ライブチャット取得の終了位置を設定します。動画情報は１回のリクエストで135件まで取得できます。それ以上の値を指定しても自動で取得数が135件に制限されます。 |
レスポンス詳細
レスポンス例は以下の通りです。
{
"id": "UCjVDCVv6G1S8zy795niSTDQ",
"name": "のふれむ35P",
"icon": "https://yt3.ggpht.com/ytc/AKedOLRWqY3grPcp5hhMgrIZf4dZrangQFEPHz2yEIqnm...",
"description": "",
"subsc_count": 0,
"play_count": 0,
"video_count": 0,
"status": "none",
"videos": [],
"comments": [],
"live_comments": [],
"updated_at": "2022-02-26T00:01:12"
}レスポンス内容の詳細はこちら
| レスポンスキー名称 | データ型 | 詳細 |
|---|---|---|
| id | String | YouTubeチャンネル(ユーザー)ID |
| name | String | YouTubeチャンネル(ユーザー)名 |
| icon | String | YouTubeチャンネル(ユーザー)アイコンURL |
| description | String | N/A ※”しか返しません |
| subsc_count | Integer | N/A ※0しか返しません |
| play_count | Integer | N/A ※0しか返しません |
| video_count | Integer | N/A ※0しか返しません |
| status | String | N/A ※noneしか返しません |
| videos | Dict | N/A ※[]しか返しません |
| comments | Dict | YouTubeチャンネル内のコメントデータ 詳細はこちら ※このアカウントの所有者が書き込んだコメントが順序を問わず取得されます |
| live_comments | Dict | YouTubeチャンネル内のライブチャットデータ 詳細はこちら ※アーカイブのチャットリプレイが無効化されている場合には[]となります |
| update_at | DateTime | YouTubeチャンネル情報の更新時刻(UTC) |
HTTPステータスコード一覧
| HTTPステータスコード(HTTP Status Code) | 詳細(Details) |
|---|---|
| 200 | 正常に処理が終了 |
| 422 | クエリパラメータエラー |
| 400~500 | API側でエラーが発生 |
OpenAPIドキュメント
FastAPIが自動生成したドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから
実際に試す
下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。
Twitchデータの取得 #
Twitch関連のデータを取得できます。
取得できるデータは以下のリストの通りです。
みこちのTwitchチャンネルの取得
みこちのTwitchチャンネルの情報を取得することができます。
https://api.nyahello.jp/v2/twitch/?<QueryParms>クエリパラメータ詳細
クエリパラメータの詳細は以下の通りです。
| パラメータ名称 | データ型 | 必須/任意 | デフォルト | 意味 | 詳細 |
|---|---|---|---|---|---|
| stream | Boolean | 任意 | false | 動画取得の有無 | このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内の動画データを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。 |
| stream_skip | Integer | 任意 | 0 | 取得開始位置 | streamがtrueの時のみに有効なパラメータです。動画取得の開始位置を設定します。 |
| stream_limit | Integer | 任意 | 10 | 取得終了位置 | streamがtrueの時のみに有効なパラメータです。動画取得の終了位置を設定します。動画情報は１回のリクエストで35件まで取得できます。それ以上の値を指定しても自動で取得数が35件に制限されます。 |
レスポンス詳細
レスポンス例は以下の通りです。
{
"id": "557359020",
"display_id": "sakuramiko_hololive",
"name": "さくらみこ",
"icon": "https://static-cdn.jtvnw.net/jtv_user_pictures/bde8f8f1-1615-4df0-8745-dd5719e9ea92-profil...",
"offline_img": "https://static-cdn.jtvnw.net/jtv_user_pictures/b7cef80f-4b0a-44e2-bd58-9b5262b9b1c9-ch...",
"description": "Nyahello~! This is Elite Miko, I am super Elite！",
"subsc_count": 232626,
"play_count": 2015948,
"status": "none",
"streams": [],
"updated_at": "2022-03-12T06:40:34"
}レスポンス内容の詳細はこちら
| レスポンスキー名称 | データ型 | 詳細 |
|---|---|---|
| id | String | TwitchチャンネルID |
| display_id | String | Twitchチャンネル表示ID |
| name | String | Twitchチャンネル名 |
| icon | String | TwitchチャンネルアイコンURL |
| offline_img | String | Twitchチャンネルオフライン画像URL |
| description | String | Twitchチャンネル概要 |
| subsc_count | Integer | Twitchフォロワー数 |
| play_count | Integer | Twitchチャンネル総再生聴回数 |
| status | String | Twitchチャンネルステータス live(配信中),none(配信中でない)の2種類です |
| streams | Dict | Twitchチャンネル内の配信/動画データ 詳細はこちら |
| update_at | DateTime | Twitchチャンネル情報の更新時刻(UTC) |
HTTPステータスコード一覧
| HTTPステータスコード(HTTP Status Code) | 詳細(Details) |
|---|---|
| 200 | 正常に処理が終了 |
| 422 | クエリパラメータエラー |
| 400~500 | API側でエラーが発生 |
OpenAPIドキュメント
FastAPIが自動生成したドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから
実際に試す
下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。
みこちのTwitchチャンネル内の配信/アーカイブデータの複数取得
みこちのYouTubeチャンネル内の動画/アーカイブの情報を複数取得することができます。
https://api.nyahello.jp/v2/twitch/streams/?<QueryParms>クエリパラメータ詳細
クエリパラメータの詳細は以下の通りです
| パラメータ名称 | データ型 | 必須/任意 | デフォルト | 意味 | 詳細 |
|---|---|---|---|---|---|
| order | String | 任意 | created_at | 配信/アーカイブ取得オプション | 配信/アーカイブ取得の順序や絞り込みが行えます。使用可能オプション created_at(作成順),live(配信),none(配信外) |
| skip | Integer | 任意 | 0 | 取得開始位置 | 配信/アーカイブ取得の開始位置を設定します。 |
| limit | Integer | 任意 | 20 | 取得終了位置 | 配信/アーカイブ取得の終了位置を設定します。配信/アーカイブ情報は１回のリクエストで35件まで取得できます。それ以上の値を指定しても自動で取得数が35件に制限されます。 |
レスポンス詳細
レスポンス例は以下の通りです。リスト型でレスポンスが返ってきます。
[
{
"id": "1411982343",
"stream_id": "45699594541",
"title": "同時視聴🎥アイアンマン",
"thumbnail": "https://static-cdn.jtvnw.net/cf_vods/d1m7jfoe9zdc1j/d5066ca6cec33715e81c_sakuramiko...",
"description": "",
"url": "https://www.twitch.tv/videos/1411982343",
"type": "archive",
"game_id": "",
"game_name": "",
"status": "none",
"current_viewers": null,
"view_count": 68417,
"as_time": "2022-03-01T13:11:24",
"ae_time": "2022-03-01T15:34:38",
"created_at": "2022-03-01T13:11:29",
"updated_at": "2022-03-12T10:37:22"
}
]レスポンス内容の詳細はこちら
| レスポンスキー名称 | データ型 | 詳細 |
|---|---|---|
| id | String | アーカイブ(動画)ID |
| stream_id | String | 配信ID ※今のところ使い道がないIDです |
| title | String | 配信/アーカイブ/動画タイトル |
| thumbnail | String | 配信/アーカイブ/動画サムネイルURL |
| description | String | 配信/アーカイブ/動画概要 |
| url | String | 配信/アーカイブ/動画URL ※配信中とアーカイブではURLが異なります |
| type | String | 配信/アーカイブ/動画のタイプ archive(配信アーカイブ), upload(アップロード動画) |
| game_id | String | 配信ゲームID ※配信者側が設定していない場合には”になります |
| game_name | String | 配信ゲーム名 ※配信者側が設定していない場合には”になります |
| status | String | 配信/アーカイブ/動画テータス live(配信中), none(配信アーカイブor動画)の2種類です |
| current_viewers | Integer | 配信中の同時接続数(同時視聴者数) ※配信中以外はnullとなります |
| as_time | DateTime | Actuary Stream Start Time(配信開始時刻) ※配信アーカイブ以外(通常のアップロード動画)はnullとなります |
| ae_time | DateTime | Actuary Stream End Time(配信終了時刻) ※配信アーカイブ以外(通常のアップロード動画)はnullとなります |
| created_at | DateTime | 配信/アーカイブ/動画の作成時刻(UTC) |
| update_at | DateTime | 配信/アーカイブ/動画の更新時刻(UTC) |
HTTPステータスコード一覧
| HTTPステータスコード(HTTP Status Code) | 詳細(Details) |
|---|---|
| 200 | 正常に処理が終了 |
| 400 | orderクエリエラー |
| 422 | クエリパラメータエラー |
| 400~500 | API側でエラーが発生 |
OpenAPIドキュメント
FastAPIが自動生成したOpenAPIドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから
実際に試す
下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。
みこちのTwitchチャンネル内の配信/アーカイブデータの単体取得
みこちのYouTubeチャンネル内の動画/アーカイブの情報を動画IDを指定して単体で取得することができます。
hhttps://api.nyahello.jp/v2/twitch/streams/{video_id}/パラメータ詳細
パラメータの詳細は以下の通りです。
| パラメータ名称 | データ型 | 必須/任意 | デフォルト | 意味 | 詳細 |
|---|---|---|---|---|---|
| video_id | String | 必要 | N/A | アーカイブ(動画)ID | Twitchアーカイブ(動画)ID |
レスポンス詳細
レスポンス例は以下の通りです。
{
"id": "1411982343",
"stream_id": "45699594541",
"title": "同時視聴🎥アイアンマン",
"thumbnail": "https://static-cdn.jtvnw.net/cf_vods/d1m7jfoe9zdc1j/d5066ca6cec33715e81c_sakuramiko...",
"description": "",
"url": "https://www.twitch.tv/videos/1411982343",
"type": "archive",
"game_id": "",
"game_name": "",
"status": "none",
"current_viewers": null,
"view_count": 68417,
"as_time": "2022-03-01T13:11:24",
"ae_time": "2022-03-01T15:34:38",
"created_at": "2022-03-01T13:11:29",
"updated_at": "2022-03-12T10:37:22"
}レスポンス内容の詳細はこちら
| レスポンスキー名称 | データ型 | 詳細 |
|---|---|---|
| id | String | アーカイブ(動画)ID |
| stream_id | String | 配信ID ※今のところ使い道がないIDです |
| title | String | 配信/アーカイブ/動画タイトル |
| thumbnail | String | 配信/アーカイブ/動画サムネイルURL |
| description | String | 配信/アーカイブ/動画概要 |
| url | String | 配信/アーカイブ/動画URL ※配信中とアーカイブではURLが異なります |
| type | String | 配信/アーカイブ/動画のタイプ archive(配信アーカイブ), upload(アップロード動画) |
| game_id | String | 配信ゲームID ※配信者側が設定していない場合には”になります |
| game_name | String | 配信ゲーム名 ※配信者側が設定していない場合には”になります |
| status | String | 配信/アーカイブ/動画テータス live(配信中), none(配信アーカイブor動画)の2種類です |
| current_viewers | Integer | 配信中の同時接続数(同時視聴者数) ※配信中以外はnullとなります |
| as_time | DateTime | Actuary Stream Start Time(配信開始時刻) ※配信アーカイブ以外(通常のアップロード動画)はnullとなります |
| ae_time | DateTime | Actuary Stream End Time(配信終了時刻) ※配信アーカイブ以外(通常のアップロード動画)はnullとなります |
| created_at | DateTime | 配信/アーカイブ/動画の作成時刻(UTC) |
| update_at | DateTime | 配信/アーカイブ/動画の更新時刻(UTC) |
HTTPステータスコード一覧
| HTTPステータスコード(HTTP Status Code) | 詳細(Details) |
|---|---|
| 200 | 正常に処理が終了 |
| 404 | not found |
| 422 | クエリパラメータエラー |
| 400~500 | API側でエラーが発生 |
OpenAPIドキュメント
FastAPIが自動生成したOpenAPIドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから
実際に試す
下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。
Twitterデータの取得 #
Twitch関連のデータを取得できます。
取得できるデータは以下のリストの通りです。
- みこちのTwitterアカウントの取得
- みこちのTwitterアカウント内のスペースデータの複数取得
- みこちのTwitterアカウント内のスペースデータの単体取得
- 35Pが投稿したツイートの複数取得
- 35Pが投稿したツイートの単体取得
- 35PのTwitterアカウントの取得(TwitterユーザーID)
- 35PのTwitterアカウントの取得(Twitter表示ID)
- 35Pが投稿したツイートの複数取得(ユーザー指定)
みこちのTwitterアカウントの取得
みこちのTwitterアカウントの情報を取得することができます。
https://api.nyahello.jp/v2/twitter/?<QueryParms>クエリパラメータ詳細
クエリパラメータの詳細は以下の通りです。
| パラメータ名称 | データ型 | 必須/任意 | デフォルト | 意味 | 詳細 |
|---|---|---|---|---|---|
| tweet | Boolean | 任意 | false | ツイート取得の有無 | このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでアカウント内のツイートデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。 |
| tweet_skip | Integer | 任意 | 0 | 取得開始位置 | tweetがtrueの時のみに有効なパラメータです。ツイート取得の開始位置を設定します。 |
| tweet_limit | Integer | 任意 | 50 | 取得終了位置 | tweetがtrueの時のみに有効なパラメータです。ツイート取得の終了位置を設定します。ツイート情報は1回のリクエストで135件まで取得できます。それ以上の値を指定しても自動で取得数が135件に制限されます。 |
| space | Boolean | 任意 | false | スペース取得の有無 | このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のコメントデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。 |
| space_skip | Integer | 任意 | 0 | 取得開始位置 | spaceがtrueの時のみに有効なパラメータです。スペース取得の開始位置を設定します。 |
| space_limit | Integer | 任意 | 10 | 取得終了位置 | spaceがtrueの時のみに有効なパラメータです。スペース取得の終了位置を設定します。スペース情報は1回のリクエストで35件まで取得できます。それ以上の値を指定しても自動で取得数が35件に制限されます。 |
レスポンス詳細
レスポンス例は以下の通りです。
{
"id": "979891380616019968",
"display_id": "sakuramiko35",
"name": "さくらみこ🌸ダーリンダンス歌ったよ💘",
"icon": "https://pbs.twimg.com/profile_images/1500271887565594624/CehCgWP...",
"description": "にゃっはろ〜！ホロライブプロダクション所属 エリート巫女さくらみこだにぇ🐱...",
"followers_count": 969563,
"following_count": 1389,
"tweet_count": 36075,
"status": "none",
"space": [],
"tweet": [],
"updated_at": "2022-03-12T13:03:06"
}レスポンス内容の詳細はこちら
| レスポンスキー名称 | データ型 | 詳細 |
|---|---|---|
| id | String | TwitterアカウントID |
| display_id | String | Twitter表示ID(ユーザーによる変更が可能なID) |
| name | String | Twitterアカウント名 |
| icon | String | TwitterアイコンURL |
| description | String | Twitterプロフィール |
| followers_count | Integer | アカウントフォロワー数 |
| following_count | Integer | アカウントフォロー数 |
| tweet_count | Integer | 総ツイート数 |
| status | String | アカウントステータス live(スペース配信中),scheduled(スペース予定あり),none(スペース予定なし)の3種類です |
| space | Dict | アカウント内のスペースデータ 詳細はこちら |
| tweet | Dict | アカウント内のツイートデータ 詳細はこちら |
| update_at | DateTime | アカウント情報の更新時刻(UTC) |
HTTPステータスコード一覧
| HTTPステータスコード(HTTP Status Code) | 詳細(Details) |
|---|---|
| 200 | 正常に処理が終了 |
| 422 | クエリパラメータエラー |
| 400~500 | API側でエラーが発生 |
OpenAPIドキュメント
FastAPIが自動生成したドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから
実際に試す
下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。
みこちのTwitterアカウント内のスペースデータの複数取得
みこちのYouTubeチャンネル内の動画/アーカイブの情報を複数取得することができます。
https://api.nyahello.jp/v2/twitter/space/?<QueryParms>クエリパラメータ詳細
クエリパラメータの詳細は以下の通りです
| パラメータ名称 | データ型 | 必須/任意 | デフォルト | 意味 | 詳細 |
|---|---|---|---|---|---|
| order | String | 任意 | created_at | スペース取得オプション | スペース取得の順序や絞り込みが行えます。使用可能オプション created_at(作成順), live(スペース中), scheduled(予定あり), none(終了済み) |
| skip | Integer | 任意 | 0 | 取得開始位置 | スペース取得の開始位置を設定します。 |
| limit | Integer | 任意 | 10 | 取得終了位置 | スペース取得の終了位置を設定します。スペース情報は１回のリクエストで35件まで取得できます。それ以上の値を指定しても自動で取得数が35件に制限されます。 |
レスポンス詳細
レスポンス例は以下の通りです。リスト型でレスポンスが返ってきます。
[
{
"id": "1zqKVBpgWkPKB",
"title": "テスト",
"url": "https://twitter.com/i/spaces/1zqKVBpgWkPKB",
"status": "none",
"audience_count": null,
"ss_time": "2019-08-24T14:15:22",
"as_time": "2019-08-24T14:15:22",
"ae_time": "2019-08-24T14:15:22",
"created_at": "2022-03-07T08:28:56.20",
"updated_at": "2022-03-07T08:28:56.20"
}
]レスポンス内容の詳細はこちら
| レスポンスキー名称 | データ型 | 詳細 |
|---|---|---|
| id | String | TwitterスペースID |
| title | String | スペースタイトル |
| url | String | スペースURL |
| status | String | スペーステータス live(スペース中), scheduled(予定あり), none(終了済み)の3種類です |
| audience_count | Integer | 配信中の同時接続数(同時視聴者数) ※スペース中以外はnullとなります |
| ss_time | DateTime | Scheduled Space Start Time(スペース開始予定時刻) ※予定無くスペースが開始された場合はnullとなります |
| as_time | DateTime | Actuary Space Start Time(スペース開始時刻) |
| ae_time | DateTime | Actuary Space End Time(スペース時刻) |
| created_at | DateTime | 配信/アーカイブ/動画の作成時刻(UTC) |
| update_at | DateTime | 配信/アーカイブ/動画の更新時刻(UTC) |
HTTPステータスコード一覧
| HTTPステータスコード(HTTP Status Code) | 詳細(Details) |
|---|---|
| 200 | 正常に処理が終了 |
| 400 | orderクエリエラー |
| 422 | クエリパラメータエラー |
| 400~500 | API側でエラーが発生 |
OpenAPIドキュメント
FastAPIが自動生成したOpenAPIドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから
実際に試す
下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。
みこちのTwitterアカウント内のスペースの単体取得
みこちのYouTubeチャンネル内の動画/アーカイブの情報を動画IDを指定して単体で取得することができます。
https://api.nyahello.jp/v2/twitter/space/{space_id}パラメータ詳細
パラメータの詳細は以下の通りです。
| パラメータ名称 | データ型 | 必須/任意 | デフォルト | 意味 | 詳細 |
|---|---|---|---|---|---|
| space_id | String | 必要 | N/A | スペースID | TwitterスペースID |
レスポンス詳細
レスポンス例は以下の通りです。
{
"id": "1zqKVBpgWkPKB",
"title": "テスト",
"url": "https://twitter.com/i/spaces/1zqKVBpgWkPKB",
"status": "none",
"audience_count": null,
"ss_time": "2019-08-24T14:15:22",
"as_time": "2019-08-24T14:15:22",
"ae_time": "2019-08-24T14:15:22",
"created_at": "2022-03-07T08:28:56.20",
"updated_at": "2022-03-07T08:28:56.20"
}レスポンス内容の詳細はこちら
| レスポンスキー名称 | データ型 | 詳細 |
|---|---|---|
| id | String | TwitterスペースID |
| title | String | スペースタイトル |
| url | String | スペースURL |
| status | String | スペーステータス live(スペース中), scheduled(予定あり), none(終了済み)の3種類です |
| audience_count | Integer | 配信中の同時接続数(同時視聴者数) ※スペース中以外はnullとなります |
| ss_time | DateTime | Scheduled Space Start Time(スペース開始予定時刻) ※予定無くスペースが開始された場合はnullとなります |
| as_time | DateTime | Actuary Space Start Time(スペース開始時刻) |
| ae_time | DateTime | Actuary Space End Time(スペース時刻) |
| created_at | DateTime | 配信/アーカイブ/動画の作成時刻(UTC) |
| update_at | DateTime | 配信/アーカイブ/動画の更新時刻(UTC) |
HTTPステータスコード一覧
| HTTPステータスコード(HTTP Status Code) | 詳細(Details) |
|---|---|
| 200 | 正常に処理が終了 |
| 404 | not found |
| 422 | クエリパラメータエラー |
| 400~500 | API側でエラーが発生 |
OpenAPIドキュメント
FastAPIが自動生成したOpenAPIドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから
実際に試す
下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。
35Pが投稿したツイートの複数取得
35Pが投稿したみこちに関するツイートをリストで取得することができます。
https://api.nyahello.jp/v2/twitter/tweets/?<QueryParms>クエリパラメータ詳細
クエリパラメータの詳細は以下の通りです
| パラメータ名称 | データ型 | 必須/任意 | デフォルト | 意味 | 詳細 |
|---|---|---|---|---|---|
| order | String | 任意 | created_at | ツイート取得オプション | ツイート取得の順序や絞り込みが行えます。使用可能オプション created_at(作成順) ※今後のアップデートで利用可能オプションを追加予定 |
| skip | Integer | 任意 | 0 | 取得開始位置 | ツイート取得の開始位置を設定します。 |
| limit | Integer | 任意 | 50 | 取得終了位置 | ツイート取得の終了位置を設定します。ツイート情報は１回のリクエストで135件まで取得できます。それ以上の値を指定しても自動で取得数が135件に制限されます。 |
レスポンス詳細
レスポンス例は以下の通りです。リスト型でレスポンスが返ってきます。
[
{
"id": "1500489743536365570",
"text": "みこちの悲鳴を聞きながらMikoAPI v2が完成しました\n#さくらみこ #さくら組技術部 #Python #Docker",
"hashtags": [
"さくらみこ",
"さくら組技術部",
"Python",
"Docker"
],
"lang": "ja",
"possibly_sensitive": false,
"url": "https://twitter.com/i/status/1500489743536365570",
"matching_rules": [
"35P-Tweet1"
],
"user_id": "1343041713376350210",
"display_id": "35p_discord",
"name": "のふれむ@えりーと35Pサーバー🌸",
"icon": "https://pbs.twimg.com/profile_images/1425106157031591942/EShZMoZA_normal.jpg",
"created_at": "2022-03-06T15:13:27"
}
]レスポンス内容の詳細はこちら
| レスポンスキー名称 | データ型 | 詳細 |
|---|---|---|
| id | String | TwitterツイートID |
| text | String | ツイート本文 |
| hashtags | List | ツイートに含まれるハッシュタグリスト ツイート内に含まれるツイートがすべて表示されます |
| lang | String | ツイート言語 |
| possibly_sensitive | Boolean | センシティブな内容が含まれる可能性のあるツイートかどうか |
| url | String | ツイートURL |
| matching_rules | List | マッチングルール マッチングしたルール名がすべて表示されます 詳細はこちら |
| user_id | String | ツイートを投稿したユーザーのID |
| name | String | ツイートを投稿したユーザーの名前 |
| icon | String | ツイートを投稿したユーザーのアイコンURL |
| created_at | DateTime | ツイートの作成時刻(UTC) |
HTTPステータスコード一覧
| HTTPステータスコード(HTTP Status Code) | 詳細(Details) |
|---|---|
| 200 | 正常に処理が終了 |
| 400 | orderクエリエラー |
| 422 | クエリパラメータエラー |
| 400~500 | API側でエラーが発生 |
OpenAPIドキュメント
FastAPIが自動生成したOpenAPIドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから
実際に試す
下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。
35Pが投稿したツイートの単体取得
35Pが投稿したみこちに関するツイートをツイートIDを指定して取得できます。
https://api.nyahello.jp/v2/twitter/tweets/{tweet_id}パラメータ詳細
パラメータの詳細は以下の通りです。
| パラメータ名称 | データ型 | 必須/任意 | デフォルト | 意味 | 詳細 |
|---|---|---|---|---|---|
| tweet_id | String | 必要 | N/A | ツイートID | TwitterツイートID |
レスポンス詳細
レスポンス例は以下の通りです。
{
"id": "1500489743536365570",
"text": "みこちの悲鳴を聞きながらMikoAPI v2が完成しました\n#さくらみこ #さくら組技術部 #Python #Docker",
"hashtags": [
"さくらみこ",
"さくら組技術部",
"Python",
"Docker"
],
"lang": "ja",
"possibly_sensitive": false,
"url": "https://twitter.com/i/status/1500489743536365570",
"matching_rules": [
"35P-Tweet1"
],
"user_id": "1343041713376350210",
"display_id": "35p_discord",
"name": "のふれむ@えりーと35Pサーバー🌸",
"icon": "https://pbs.twimg.com/profile_images/1425106157031591942/EShZMoZA_normal.jpg",
"created_at": "2022-03-06T15:13:27"
}レスポンス内容の詳細はこちら
| レスポンスキー名称 | データ型 | 詳細 |
|---|---|---|
| id | String | TwitterツイートID |
| text | String | ツイート本文 |
| hashtags | List | ツイートに含まれるハッシュタグリスト ツイート内に含まれるツイートがすべて表示されます |
| lang | String | ツイート言語 |
| possibly_sensitive | Boolean | センシティブな内容が含まれる可能性のあるツイートかどうか |
| url | String | ツイートURL |
| matching_rules | List | マッチングルール マッチングしたルール名がすべて表示されます 詳細はこちら |
| user_id | String | ツイートを投稿したユーザーのID |
| name | String | ツイートを投稿したユーザーの名前 |
| icon | String | ツイートを投稿したユーザーのアイコンURL |
| created_at | DateTime | ツイートの作成時刻(UTC) |
マッチングルール詳細
| ルールID | ルール名 | ツイート取得ルール |
|---|---|---|
| 1504374887418597378 | 35P-Tweet1 | (さくらみこ OR #みこなま OR みこらじお OR みこクラ OR #みこきいたぞ OR #さくらみこ新3Dお披露目 OR #さくら色Dreamer OR #みこ市長 OR #みこんま OR #エリート自由工作 OR #MikoFreeCraft OR #みこなつ OR #みこぺーす OR SakuraMiko) (-is:retweet) |
| 1504374887418597380 | 35P-Tweet2 | (みこち OR みこち撮ったにぇ OR 35P鯖 OR さくら組料理部 OR #35P OR みこぴー OR mこち OR 35PProject OR 35PLAT OR みこቻ OR Mikochi) (-is:retweet) |
| 1504374887418597377 | 35P-Art | (#miko_Art OR #ミコミコ動画 OR #さくらみこMMD) (has:media -is:retweet -is:quote) |
| 1504374887418597379 | collaboration | (みっこよ OR みっころね OR ぺこみこ OR わたみこ OR みこフレ OR miComet OR バブライブ OR みこマリ OR そらみこ OR ノエみこ OR #mikofla OR #ホロライブGTA OR #ホロAmongUs OR #ホロピンクブルー OR ホロのえかきうた OR 0期生マイクラ OR #みこここ OR うさ建夏祭り OR うさ建築夏祭り後夜祭 OR ホロの告知ポスター王 OR ほろべいびー OR 不知火建設 OR #ElitePAD OR ホロライブ大運動会 OR holoSportsfestival OR ホロARK) (-is:retweet) |
| 1504374887418597376 | Miko | from:sakuramiko35 |
HTTPステータスコード一覧
| HTTPステータスコード(HTTP Status Code) | 詳細(Details) |
|---|---|
| 200 | 正常に処理が終了 |
| 404 | not found |
| 422 | クエリパラメータエラー |
| 400~500 | API側でエラーが発生 |
OpenAPIドキュメント
FastAPIが自動生成したOpenAPIドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから
実際に試す
下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。
35PのTwitterアカウントの取得(TwitterユーザーID)
35PのTwitterアカウントの情報を取得することができます。※MikoAPI v2が起動している間にみこちに関するツイートを行ったTwitterアカウント情報が登録されています。
https://api.nyahello.jp/v2/twitter/users/{user_id}/?<QueryParms>パラメータ詳細
パラメータの詳細は以下の通りです。
| パラメータ名称 | データ型 | 必須/任意 | デフォルト | 意味 | 詳細 |
|---|---|---|---|---|---|
| user_id | String | 必要 | N/A | ユーザーID | TwitterユーザーID |
| tweet | Boolean | 任意 | false | ツイート取得の有無 | このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでアカウント内のツイートデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。 |
| tweet_skip | Integer | 任意 | 0 | 取得開始位置 | tweetがtrueの時のみに有効なパラメータです。ツイート取得の開始位置を設定します。 |
| tweet_limit | Integer | 任意 | 50 | 取得終了位置 | tweetがtrueの時のみに有効なパラメータです。ツイート取得の終了位置を設定します。ツイート情報は1回のリクエストで135件まで取得できます。それ以上の値を指定しても自動で取得数が135件に制限されます。 |
| space | Boolean | 任意 | false | スペース取得の有無 | このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のコメントデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。 ※現在は、みこちのアカウントのみスペース情報を取得できます。 |
| space_skip | Integer | 任意 | 0 | 取得開始位置 | spaceがtrueの時のみに有効なパラメータです。スペース取得の開始位置を設定します。 |
| space_limit | Integer | 任意 | 10 | 取得終了位置 | spaceがtrueの時のみに有効なパラメータです。スペース取得の終了位置を設定します。スペース情報は1回のリクエストで35件まで取得できます。それ以上の値を指定しても自動で取得数が35件に制限されます。 |
レスポンス詳細
レスポンス例は以下の通りです。
{
"id": "1343041713376350210",
"display_id": "35p_discord",
"name": "のふれむ@えりーと35Pサーバー🌸",
"icon": "https://pbs.twimg.com/profile_images/1425106157031591942/EShZMoZA_normal.jpg",
"description": "#さくらみこ さんのファンである #35P による えりーと な35PのためのDiscordファンサーバーやってるにぇ！",
"followers_count": 1400,
"following_count": 1771,
"tweet_count": 14977,
"status": "none",
"space": [],
"tweet": [],
"updated_at": "2022-03-12T12:44:29"
}レスポンス内容の詳細はこちら
| レスポンスキー名称 | データ型 | 詳細 |
|---|---|---|
| id | String | TwitterアカウントID |
| display_id | String | Twitter表示ID(ユーザーによる変更が可能なID) |
| name | String | Twitterアカウント名 |
| icon | String | TwitterアイコンURL |
| description | String | Twitterプロフィール |
| followers_count | Integer | アカウントフォロワー数 |
| following_count | Integer | アカウントフォロー数 |
| tweet_count | Integer | 総ツイート数 |
| status | String | アカウントステータス live(スペース配信中),scheduled(スペース予定あり),none(スペース予定なし)の3種類です |
| space | Dict | アカウント内のスペースデータ 詳細はこちら |
| tweet | Dict | アカウント内のツイートデータ 詳細はこちら |
| update_at | DateTime | アカウント情報の更新時刻(UTC) ※みこちのアカウントは5秒毎に更新していますがその他のアカウントはツイートがある毎に更新されます |
HTTPステータスコード一覧
| HTTPステータスコード(HTTP Status Code) | 詳細(Details) |
|---|---|
| 200 | 正常に処理が終了 |
| 404 | not found |
| 422 | クエリパラメータエラー |
| 400~500 | API側でエラーが発生 |
OpenAPIドキュメント
FastAPIが自動生成したドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから
実際に試す
下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。
35PのTwitterアカウントの取得(Twitter表示ID)
35PのTwitterアカウントの情報を取得することができます。※MikoAPI v2が起動している間にみこちに関するツイートを行ったTwitterアカウント情報が登録されています。
https://api.nyahello.jp/v2/twitter/users/display_id/{display_id}/?<QueryParms>パラメータ詳細
パラメータの詳細は以下の通りです。
| パラメータ名称 | データ型 | 必須/任意 | デフォルト | 意味 | 詳細 |
|---|---|---|---|---|---|
| display_id | String | 必要 | N/A | 表示ID | Twitter表示ID(ユーザーによる変更が可能なID) |
| tweet | Boolean | 任意 | false | ツイート取得の有無 | このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでアカウント内のツイートデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。 |
| tweet_skip | Integer | 任意 | 0 | 取得開始位置 | tweetがtrueの時のみに有効なパラメータです。ツイート取得の開始位置を設定します。 |
| tweet_limit | Integer | 任意 | 50 | 取得終了位置 | tweetがtrueの時のみに有効なパラメータです。ツイート取得の終了位置を設定します。ツイート情報は1回のリクエストで135件まで取得できます。それ以上の値を指定しても自動で取得数が135件に制限されます。 |
| space | Boolean | 任意 | false | スペース取得の有無 | このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のコメントデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。 ※現在は、みこちのアカウントのみスペース情報を取得できます。 |
| space_skip | Integer | 任意 | 0 | 取得開始位置 | spaceがtrueの時のみに有効なパラメータです。スペース取得の開始位置を設定します。 |
| space_limit | Integer | 任意 | 10 | 取得終了位置 | spaceがtrueの時のみに有効なパラメータです。スペース取得の終了位置を設定します。スペース情報は1回のリクエストで35件まで取得できます。それ以上の値を指定しても自動で取得数が35件に制限されます。 |
レスポンス詳細
レスポンス例は以下の通りです。
{
"id": "1343041713376350210",
"display_id": "35p_discord",
"name": "のふれむ@えりーと35Pサーバー🌸",
"icon": "https://pbs.twimg.com/profile_images/1425106157031591942/EShZMoZA_normal.jpg",
"description": "#さくらみこ さんのファンである #35P による えりーと な35PのためのDiscordファンサーバーやってるにぇ！",
"followers_count": 1400,
"following_count": 1771,
"tweet_count": 14977,
"status": "none",
"space": [],
"tweet": [],
"updated_at": "2022-03-12T12:44:29"
}レスポンス内容の詳細はこちら
| レスポンスキー名称 | データ型 | 詳細 |
|---|---|---|
| id | String | TwitterアカウントID |
| display_id | String | Twitter表示ID(ユーザーによる変更が可能なID) |
| name | String | Twitterアカウント名 |
| icon | String | TwitterアイコンURL |
| description | String | Twitterプロフィール |
| followers_count | Integer | アカウントフォロワー数 |
| following_count | Integer | アカウントフォロー数 |
| tweet_count | Integer | 総ツイート数 |
| status | String | アカウントステータス live(スペース配信中),scheduled(スペース予定あり),none(スペース予定なし)の3種類です |
| space | Dict | アカウント内のスペースデータ 詳細はこちら |
| tweet | Dict | アカウント内のツイートデータ 詳細はこちら |
| update_at | DateTime | アカウント情報の更新時刻(UTC) ※みこちのアカウントは5秒毎に更新していますがその他のアカウントはツイートがある毎に更新されます |
HTTPステータスコード一覧
| HTTPステータスコード(HTTP Status Code) | 詳細(Details) |
|---|---|
| 200 | 正常に処理が終了 |
| 404 | not found |
| 422 | クエリパラメータエラー |
| 400~500 | API側でエラーが発生 |
OpenAPIドキュメント
FastAPIが自動生成したドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから
実際に試す
下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。
35Pが投稿したツイートの複数取得(ユーザー指定)
35Pが投稿したみこちに関するツイートをユーザーIDを指定してリストで取得することができます。
https://api.nyahello.jp/v2/twitter/users/{user_id}/tweets/?<QueryParms>パラメータ詳細
パラメータの詳細は以下の通りです
| パラメータ名称 | データ型 | 必須/任意 | デフォルト | 意味 | 詳細 |
|---|---|---|---|---|---|
| user_id | String | 必要 | N/A | ユーザーID | TwitterユーザーID |
| skip | Integer | 任意 | 0 | 取得開始位置 | ツイート取得の開始位置を設定します。 |
| limit | Integer | 任意 | 50 | 取得終了位置 | ツイート取得の終了位置を設定します。ツイート情報は１回のリクエストで135件まで取得できます。それ以上の値を指定しても自動で取得数が135件に制限されます。 |
レスポンス詳細
レスポンス例は以下の通りです。リスト型でレスポンスが返ってきます。
[
{
"id": "1500489743536365570",
"text": "みこちの悲鳴を聞きながらMikoAPI v2が完成しました\n#さくらみこ #さくら組技術部 #Python #Docker",
"hashtags": [
"さくらみこ",
"さくら組技術部",
"Python",
"Docker"
],
"lang": "ja",
"possibly_sensitive": false,
"url": "https://twitter.com/i/status/1500489743536365570",
"matching_rules": [
"35P-Tweet1"
],
"user_id": "1343041713376350210",
"display_id": "35p_discord",
"name": "のふれむ@えりーと35Pサーバー🌸",
"icon": "https://pbs.twimg.com/profile_images/1425106157031591942/EShZMoZA_normal.jpg",
"created_at": "2022-03-06T15:13:27"
}
]レスポンス内容の詳細はこちら
| レスポンスキー名称 | データ型 | 詳細 |
|---|---|---|
| id | String | TwitterツイートID |
| text | String | ツイート本文 |
| hashtags | List | ツイートに含まれるハッシュタグリスト ツイート内に含まれるツイートがすべて表示されます |
| lang | String | ツイート言語 |
| possibly_sensitive | Boolean | センシティブな内容が含まれる可能性のあるツイートかどうか |
| url | String | ツイートURL |
| matching_rules | List | マッチングルール マッチングしたルール名がすべて表示されます 詳細はこちら |
| user_id | String | ツイートを投稿したユーザーのID |
| name | String | ツイートを投稿したユーザーの名前 |
| icon | String | ツイートを投稿したユーザーのアイコンURL |
| created_at | DateTime | ツイートの作成時刻(UTC) |
HTTPステータスコード一覧
| HTTPステータスコード(HTTP Status Code) | 詳細(Details) |
|---|---|
| 200 | 正常に処理が終了 |
| 404 | not found |
| 422 | クエリパラメータエラー |
| 400~500 | API側でエラーが発生 |
OpenAPIドキュメント
FastAPIが自動生成したOpenAPIドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから
実際に試す
下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。
