MikoAPI v2 Docs

初めに #

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イメージをコマンド1つで構築から起動ができます。

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"
}

レスポンス内容の詳細はこちら

レスポンスキー名称データ型詳細
MessageStringにゃっはろ〜!
DocsStringFastAPIによる自動生成のOpenAPIドキュメントリンク1
RedocStringFastAPIによる自動生成のOpenAPIドキュメントリンク2
SourceStringMikoAPI v2のソースコードリンク(GitHub) ※現在はプライベートリポジトリ
OrganizationString開発組織名: えりーと35P サーバー/Elite35P Server
HPStringホームページリンク
TwitterString開発組織のTwitterリンク
ContactStringこのAPIに関してのお問合せ用E-mailアドレス
HTTPステータスコード一覧
HTTPステータスコード詳細
200正常に処理が終了
400~500API側でエラーが発生
OpenAPIドキュメント

FastAPIが自動生成したOpenAPIドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから

実際に試す

下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。

トークン認証 #

※現在トークン認証はご利用いただけません。

MikoAPI v2の全ての機能が認証なしでご利用いただけます。
今後APIのアクセスが増加しサーバー負荷が高くなった場合トークン認証やレート制限を設定する可能性があります。

YouTubeデータの取得 #

YouTube関連のデータを取得できます。
取得できるデータは以下のリストの通りです。

みこちのYouTubeチャンネルの取得

みこちのYouTubeチャンネルの情報を取得することができます。

https://api.nyahello.jp/v2/youtube/?<QueryParms>
クエリパラメータ詳細

クエリパラメータの詳細は以下の通りです。

パラメータ名称データ型必須/任意デフォルト意味詳細
videoBoolean任意false動画取得の有無このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内の動画データを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。
video_skipInteger任意0取得開始位置videoがtrueの時のみに有効なパラメータです。動画取得の開始位置を設定します。
video_limitInteger任意10取得終了位置videoがtrueの時のみに有効なパラメータです。動画取得の終了位置を設定します。動画情報は1回のリクエストで35件まで取得できます。それ以上の値を指定しても自動で取得数が35件に制限されます。
commentBoolean任意falseコメント取得の有無このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のコメントデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。
comment_skipInteger任意0取得開始位置commentがtrueの時のみに有効なパラメータです。コメント取得の開始位置を設定します。
comment_limitInteger任意20取得終了位置commentがtrueの時のみに有効なパラメータです。コメント取得の終了位置を設定します。動画情報は1回のリクエストで70件まで取得できます。それ以上の値を指定しても自動で取得数が70件に制限されます。
live_commentBoolean任意falseライブチャット取得の有無このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のライブチャットデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずchat_noが最新のものから順に取得されます。
live_comment_skipInteger任意0取得開始位置live_commentがtrueの時のみに有効なパラメータです。ライブチャット取得の開始位置を設定します。
live_comment_limitInteger任意50取得終了位置live_commentがtrueの時のみに有効なパラメータです。ライブチャット取得の終了位置を設定します。動画情報は1回のリクエストで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"
}

レスポンス内容の詳細はこちら

レスポンスキー名称データ型詳細
idStringYouTubeチャンネルID
nameStringYouTubeチャンネル名
iconStringYouTubeチャンネルアイコンURL
descriptionStringYouTubeチャンネル概要
subsc_countIntegerYouTubeチャンネル登録者数
play_countIntegerYouTubeチャンネル総再生聴回数
video_countIntegerYouTubeチャンネル総動画本数
statusStringYouTubeチャンネルステータス live(配信中),upcoming(待機枠あり),none(配信及び待機枠なし)の3種類です
videosDictYouTubeチャンネル内の動画データ 詳細はこちら
commentsDictYouTubeチャンネル内のコメントデータ 詳細はこちら ※コメントが無効化されている場合には[]となります
live_commentsDictYouTubeチャンネル内のライブチャットデータ 詳細はこちら ※アーカイブのチャットリプレイが無効化されている場合には[]となります
update_atDateTimeYouTubeチャンネル情報の更新時刻(UTC)
HTTPステータスコード一覧
HTTPステータスコード(HTTP Status Code)詳細(Details)
200正常に処理が終了
422クエリパラメータエラー
400~500API側でエラーが発生
OpenAPIドキュメント

FastAPIが自動生成したドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから

実際に試す

下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。

みこちのYouTubeチャンネル内の動画/配信アーカイブデータの複数取得

みこちのYouTubeチャンネル内の動画/アーカイブの情報を複数取得することができます。

https://api.nyahello.jp/v2/youtube/videos/?<QueryParms>
クエリパラメータ詳細

クエリパラメータの詳細は以下の通りです

パラメータ名称データ型必須/任意デフォルト意味詳細
orderString任意created_at動画取得オプション動画取得の順序や絞り込みが行えます。使用可能オプション created_at(作成順),ss_time(開始予定時刻順),like_count(高評価数順),play_count(再生回数順),comment_count(コメント数順),live(配信orプレミア公開中の動画),upcoming(配信待機枠),none(statusがlive、upcomingの動画)
skipInteger任意0取得開始位置動画取得の開始位置を設定します。
limitInteger任意10取得終了位置動画取得の終了位置を設定します。動画情報は1回のリクエストで35件まで取得できます。それ以上の値を指定しても自動で取得数が35件に制限されます。
commentBoolean任意falseコメント取得の有無このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のコメントデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。
comment_skipInteger任意0取得開始位置commentがtrueの時のみに有効なパラメータです。コメント取得の開始位置を設定します。
comment_limitInteger任意20取得終了位置commentがtrueの時のみに有効なパラメータです。コメント取得の終了位置を設定します。動画情報は1回のリクエストで70件まで取得できます。それ以上の値を指定しても自動で取得数が70件に制限されます。
live_commentBoolean任意falseライブチャット取得の有無このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のライブチャットデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずchat_noが最新のものから順に取得されます。
live_comment_skipInteger任意0取得開始位置live_commentがtrueの時のみに有効なパラメータです。ライブチャット取得の開始位置を設定します。
live_comment_limitInteger任意50取得終了位置live_commentがtrueの時のみに有効なパラメータです。ライブチャット取得の終了位置を設定します。動画情報は1回のリクエストで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"
  }
]

レスポンス内容の詳細はこちら

レスポンスキー名称データ型詳細
idStringYouTube 動画ID
titleString動画タイトル
thumbnailsDict動画サムネイルURL 解像度別に複数辞書型で5種類の画像URLが取得できます
descriptionString動画概要
urlString動画リンク
play_countInteger動画再生回数
like_countInteger高評価数
comment_countIntegerコメント数
commentsDict動画内のコメントデータ 詳細はこちら ※コメントが無効化されている場合には[]となります
live_commentsDict動画内のライブチャットデータ 詳細はこちら ※アーカイブのチャットリプレイが無効化されている場合には[]となります
statusString動画テータス live(配信中),upcoming(待機状態),none(アーカイブor動画)の3種類です
current_viewersInteger配信中の同時接続数(同時視聴者数) ※配信中以外はnullとなります
ss_timeDateTimeScheduled Stream Start Time(配信開始予定時刻/プレミア公開予定時刻) ※配信アーカイブ/プレミア公開動画以外(通常のアップロード動画)やゲリラ配信時(配信待機枠を作成せず配信を開始した場合)はnullとなります
as_timeDateTimeActuary Stream Start Time(配信開始時刻/プレミア公開時刻) ※配信アーカイブ/プレミア公開動画以外(通常のアップロード動画)はnullとなります
ae_timeDateTimeActuary Stream End Time(配信終了時刻/プレミア公開終了時刻) ※配信アーカイブ/プレミア公開動画以外(通常のアップロード動画)はnullとなります
created_atDateTime動画の作成時刻(UTC)
update_atDateTime動画の更新時刻(UTC)
HTTPステータスコード一覧
HTTPステータスコード(HTTP Status Code)詳細(Details)
200正常に処理が終了
400orderクエリエラー
422クエリパラメータエラー
400~500API側でエラーが発生
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_idString必要N/A動画IDYouTube 動画ID
commentBoolean任意falseコメント取得の有無このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のコメントデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。
comment_skipInteger任意0取得開始位置commentがtrueの時のみに有効なパラメータです。コメント取得の開始位置を設定します。
comment_limitInteger任意20取得終了位置commentがtrueの時のみに有効なパラメータです。コメント取得の終了位置を設定します。動画情報は1回のリクエストで70件まで取得できます。それ以上の値を指定しても自動で取得数が70件に制限されます。
live_commentBoolean任意falseライブチャット取得の有無このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のライブチャットデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずchat_noが最新のものから順に取得されます。
live_comment_skipInteger任意0取得開始位置live_commentがtrueの時のみに有効なパラメータです。ライブチャット取得の開始位置を設定します。
live_comment_limitInteger任意50取得終了位置live_commentがtrueの時のみに有効なパラメータです。ライブチャット取得の終了位置を設定します。動画情報は1回のリクエストで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"
}

レスポンス内容の詳細はこちら

レスポンスキー名称データ型詳細
idStringYouTube 動画ID
titleString動画タイトル
thumbnailsDict動画サムネイルURL 解像度別に複数辞書型で5種類の画像URLが取得できます
descriptionString動画概要
urlString動画リンク
play_countInteger動画再生回数
like_countInteger高評価数
comment_countIntegerコメント数
commentsDict動画内のコメントデータ 詳細はこちら ※コメントが無効化されている場合には[]となります
live_commentsDict動画内のライブチャットデータ 詳細はこちら ※アーカイブのチャットリプレイが無効化されている場合には[]となります
statusString動画テータス live(配信中),upcoming(待機状態),none(アーカイブor動画)の3種類です
current_viewersInteger配信中の同時接続数(同時視聴者数) ※配信中以外はnullとなります
ss_timeDateTimeScheduled Stream Start Time(配信開始予定時刻/プレミア公開予定時刻) ※配信アーカイブ/プレミア公開動画以外(通常のアップロード動画)やゲリラ配信時(配信待機枠を作成せず配信を開始した場合)はnullとなります
as_timeDateTimeActuary Stream Start Time(配信開始時刻/プレミア公開時刻) ※配信アーカイブ/プレミア公開動画以外(通常のアップロード動画)はnullとなります
ae_timeDateTimeActuary Stream End Time(配信終了時刻/プレミア公開終了時刻) ※配信アーカイブ/プレミア公開動画以外(通常のアップロード動画)はnullとなります
created_atDateTime動画の作成時刻(UTC)
update_atDateTime動画の更新時刻(UTC)
HTTPステータスコード一覧
HTTPステータスコード(HTTP Status Code)詳細(Details)
200正常に処理が終了
404not found
422クエリパラメータエラー
400~500API側でエラーが発生
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_idString必要N/A動画IDYouTube 動画ID
orderString任意created_atコメント取得順序コメント取得の順序や絞り込みが行えます。created_at(作成順), like_count(高評価数順)
skipInteger任意0取得開始位置コメント取得の開始位置を設定します。
limitInteger任意20取得終了位置コメント取得の終了位置を設定します。動画情報は1回のリクエストで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"
  }
]

レスポンス内容の詳細はこちら

レスポンスキー名称データ型詳細
idStringYouTube コメントID
video_idStringコメントが存在する 動画ID
author_idStringコメントを書き込んだ人のYouTubeチャンネルID
nameStringコメントを書き込んだ人のYouTubeチャンネル名
iconStringコメントを書き込んだ人のYouTubeチャンネルアイコンURL
display_textString表示テキスト
original_textStringHTMLテキスト
like_countInteger高評価数
can_replyBooleanコメントに返信が可能かどうか
reply_countInteger返信数
is_publicBooleanコメントが表示されるかどうか
created_atDateTimeコメントの作成時刻(UTC)
update_atDateTimeコメントの更新時刻(UTC)
HTTPステータスコード一覧
HTTPステータスコード(HTTP Status Code)詳細(Details)
200正常に処理が終了
400orderクエリエラー
422クエリパラメータエラー
400~500API側でエラーが発生
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_idString必要N/AコメントIDYouTube コメント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"
}

レスポンス内容の詳細はこちら

レスポンスキー名称データ型詳細
idStringYouTube コメントID
video_idStringコメントが存在する 動画ID
author_idStringコメントを書き込んだ人のYouTubeチャンネルID
nameStringコメントを書き込んだ人のYouTubeチャンネル名
iconStringコメントを書き込んだ人のYouTubeチャンネルアイコンURL
display_textString表示テキスト
original_textStringHTMLテキスト
like_countInteger高評価数
can_replyBooleanコメントに返信が可能かどうか
reply_countInteger返信数
is_publicBooleanコメントが表示されるかどうか
created_atDateTimeコメントの作成時刻(UTC)
update_atDateTimeコメントの更新時刻(UTC)
HTTPステータスコード一覧
HTTPステータスコード(HTTP Status Code)詳細(Details)
200正常に処理が終了
404not found
422クエリパラメータエラー
400~500API側でエラーが発生
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_idString必要N/A動画IDYouTube 動画ID
orderString任意chat_noコメント取得順序コメント取得の順序や絞り込みが行えます。chat_no(チャット順), normalchat(通常チャット), superchat(スーパーチャット), member_none(メンバーシップ未加入), member_0(新規メンバーシップ), member_1(メンバーシップ1ヶ月目), member_6(メンバーシップ6ヶ月目), member_12(メンバーシップ1年目), member_24(メンバーシップ2年目), moderator(モデレーター及び確認済み(スパナ))
skipInteger任意0取得開始位置コメント取得の開始位置を設定します。
limitInteger任意50取得終了位置コメント取得の終了位置を設定します。動画情報は1回のリクエストで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"
  }
]

レスポンス内容の詳細はこちら

レスポンスキー名称データ型詳細
idStringYouTube ライブチャットID
video_idStringチャットが存在する 配信アーカイブID
author_idStringチャットを書き込んだ人のYouTubeチャンネルID
nameStringコメントを書き込んだ人のYouTubeチャンネル名
iconStringコメントを書き込んだ人のYouTubeチャンネルアイコンURL
author_badgeStringコメントを書き込んだ人の情報(メンバー何ヶ月目or確認済みorメンバー未加入ならnullではなく”)
textString表示テキスト
typeStringチャットタイプ NORMALCHAT(通常チャット), SUPERCHAT(スーパーチャット)
purchase_amountStringスーパーチャット金額(通貨によって¥や$が後ろにつくため、IntegerでなくString) ※typeがNORMALCHATの時はnull
timeStringチャットされた時間(配信アーカイブ時間)
timestamp_usecStringチャットされた時間(タイムスタンプusec)
video_offset_time_msecStringチャットされた時間(配信アーカイブ offset time msec)
chat_noIntegerチャット番号(1から順にカウントを開始)
update_atDateTimeライブチャットの更新時刻(UTC)
HTTPステータスコード一覧
HTTPステータスコード(HTTP Status Code)詳細(Details)
200正常に処理が終了
400orderクエリエラー
422クエリパラメータエラー
400~500API側でエラーが発生
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_idString必要N/AライブチャットIDYouTube ライブチャット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"
}

レスポンス内容の詳細はこちら

レスポンスキー名称データ型詳細
idStringYouTube ライブチャットID
video_idStringチャットが存在する 配信アーカイブID
author_idStringチャットを書き込んだ人のYouTubeチャンネルID
nameStringコメントを書き込んだ人のYouTubeチャンネル名
iconStringコメントを書き込んだ人のYouTubeチャンネルアイコンURL
author_badgeStringコメントを書き込んだ人の情報(メンバー何ヶ月目かor確認済みかorメンバー未加入ならnullではなく”)
textString表示テキスト
typeStringチャットタイプ NORMALCHAT(通常チャット), SUPERCHAT(スーパーチャット)
purchase_amountStringスーパーチャット金額(通貨によって¥や$が後ろにつくため、IntegerでなくString) ※typeがNORMALCHATの時はnull
timeStringチャットされた時間(配信アーカイブ時間)
timestamp_usecStringチャットされた時間(タイムスタンプusec)
video_offset_time_msecStringチャットされた時間(配信アーカイブ offset time msec)
chat_noIntegerチャット番号(1から順にカウントを開始)
update_atDateTimeライブチャットの更新時刻(UTC)
HTTPステータスコード一覧
HTTPステータスコード(HTTP Status Code)詳細(Details)
200正常に処理が終了
404not found
400~500API側でエラーが発生
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_idString必要N/AYouTubeチャンネル(ユーザー)IDYouTubeチャンネル(ユーザー)ID
commentBoolean任意falseコメント取得の有無このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のコメントデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。
comment_skipInteger任意0取得開始位置commentがtrueの時のみに有効なパラメータです。コメント取得の開始位置を設定します。
comment_limitInteger任意20取得終了位置commentがtrueの時のみに有効なパラメータです。コメント取得の終了位置を設定します。動画情報は1回のリクエストで70件まで取得できます。それ以上の値を指定しても自動で取得数が70件に制限されます。
live_commentBoolean任意falseライブチャット取得の有無このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のライブチャットデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずchat_noが最新のものから順に取得されます。
live_comment_skipInteger任意0取得開始位置live_commentがtrueの時のみに有効なパラメータです。ライブチャット取得の開始位置を設定します。
live_comment_limitInteger任意50取得終了位置live_commentがtrueの時のみに有効なパラメータです。ライブチャット取得の終了位置を設定します。動画情報は1回のリクエストで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"
}

レスポンス内容の詳細はこちら

レスポンスキー名称データ型詳細
idStringYouTubeチャンネル(ユーザー)ID
nameStringYouTubeチャンネル(ユーザー)名
iconStringYouTubeチャンネル(ユーザー)アイコンURL
descriptionStringN/A ※”しか返しません
subsc_countIntegerN/A ※0しか返しません
play_countIntegerN/A ※0しか返しません
video_countIntegerN/A ※0しか返しません
statusStringN/A ※noneしか返しません
videosDictN/A ※[]しか返しません
commentsDictYouTubeチャンネル内のコメントデータ 詳細はこちら ※このアカウントの所有者が書き込んだコメントが順序を問わず取得されます
live_commentsDictYouTubeチャンネル内のライブチャットデータ 詳細はこちら ※アーカイブのチャットリプレイが無効化されている場合には[]となります
update_atDateTimeYouTubeチャンネル情報の更新時刻(UTC)
HTTPステータスコード一覧
HTTPステータスコード(HTTP Status Code)詳細(Details)
200正常に処理が終了
422クエリパラメータエラー
400~500API側でエラーが発生
OpenAPIドキュメント

FastAPIが自動生成したドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから

実際に試す

下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。

Twitchデータの取得 #

Twitch関連のデータを取得できます。
取得できるデータは以下のリストの通りです。

みこちのTwitchチャンネルの取得

みこちのTwitchチャンネルの情報を取得することができます。

https://api.nyahello.jp/v2/twitch/?<QueryParms>
クエリパラメータ詳細

クエリパラメータの詳細は以下の通りです。

パラメータ名称データ型必須/任意デフォルト意味詳細
streamBoolean任意false動画取得の有無このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内の動画データを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。
stream_skipInteger任意0取得開始位置streamがtrueの時のみに有効なパラメータです。動画取得の開始位置を設定します。
stream_limitInteger任意10取得終了位置streamがtrueの時のみに有効なパラメータです。動画取得の終了位置を設定します。動画情報は1回のリクエストで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"
}

レスポンス内容の詳細はこちら

レスポンスキー名称データ型詳細
idStringTwitchチャンネルID
display_idStringTwitchチャンネル表示ID
nameStringTwitchチャンネル名
iconStringTwitchチャンネルアイコンURL
offline_imgStringTwitchチャンネルオフライン画像URL
descriptionStringTwitchチャンネル概要
subsc_countIntegerTwitchフォロワー数
play_countIntegerTwitchチャンネル総再生聴回数
statusStringTwitchチャンネルステータス live(配信中),none(配信中でない)の2種類です
streamsDictTwitchチャンネル内の配信/動画データ 詳細はこちら
update_atDateTimeTwitchチャンネル情報の更新時刻(UTC)
HTTPステータスコード一覧
HTTPステータスコード(HTTP Status Code)詳細(Details)
200正常に処理が終了
422クエリパラメータエラー
400~500API側でエラーが発生
OpenAPIドキュメント

FastAPIが自動生成したドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから

実際に試す

下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。

みこちのTwitchチャンネル内の配信/アーカイブデータの複数取得

みこちのYouTubeチャンネル内の動画/アーカイブの情報を複数取得することができます。

https://api.nyahello.jp/v2/twitch/streams/?<QueryParms>
クエリパラメータ詳細

クエリパラメータの詳細は以下の通りです

パラメータ名称データ型必須/任意デフォルト意味詳細
orderString任意created_at配信/アーカイブ取得オプション配信/アーカイブ取得の順序や絞り込みが行えます。使用可能オプション created_at(作成順),live(配信),none(配信外)
skipInteger任意0取得開始位置配信/アーカイブ取得の開始位置を設定します。
limitInteger任意20取得終了位置配信/アーカイブ取得の終了位置を設定します。配信/アーカイブ情報は1回のリクエストで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"
  }
]

レスポンス内容の詳細はこちら

レスポンスキー名称データ型詳細
idStringアーカイブ(動画)ID
stream_idString配信ID ※今のところ使い道がないIDです
titleString配信/アーカイブ/動画タイトル
thumbnailString配信/アーカイブ/動画サムネイルURL
descriptionString配信/アーカイブ/動画概要
urlString配信/アーカイブ/動画URL ※配信中とアーカイブではURLが異なります
typeString配信/アーカイブ/動画のタイプ archive(配信アーカイブ), upload(アップロード動画)
game_idString配信ゲームID ※配信者側が設定していない場合には”になります
game_nameString配信ゲーム名 ※配信者側が設定していない場合には”になります
statusString配信/アーカイブ/動画テータス live(配信中), none(配信アーカイブor動画)の2種類です
current_viewersInteger配信中の同時接続数(同時視聴者数) ※配信中以外はnullとなります
as_timeDateTimeActuary Stream Start Time(配信開始時刻) ※配信アーカイブ以外(通常のアップロード動画)はnullとなります
ae_timeDateTimeActuary Stream End Time(配信終了時刻) ※配信アーカイブ以外(通常のアップロード動画)はnullとなります
created_atDateTime配信/アーカイブ/動画の作成時刻(UTC)
update_atDateTime配信/アーカイブ/動画の更新時刻(UTC)
HTTPステータスコード一覧
HTTPステータスコード(HTTP Status Code)詳細(Details)
200正常に処理が終了
400orderクエリエラー
422クエリパラメータエラー
400~500API側でエラーが発生
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_idString必要N/Aアーカイブ(動画)IDTwitchアーカイブ(動画)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"
}

レスポンス内容の詳細はこちら

レスポンスキー名称データ型詳細
idStringアーカイブ(動画)ID
stream_idString配信ID ※今のところ使い道がないIDです
titleString配信/アーカイブ/動画タイトル
thumbnailString配信/アーカイブ/動画サムネイルURL
descriptionString配信/アーカイブ/動画概要
urlString配信/アーカイブ/動画URL ※配信中とアーカイブではURLが異なります
typeString配信/アーカイブ/動画のタイプ archive(配信アーカイブ), upload(アップロード動画)
game_idString配信ゲームID ※配信者側が設定していない場合には”になります
game_nameString配信ゲーム名 ※配信者側が設定していない場合には”になります
statusString配信/アーカイブ/動画テータス live(配信中), none(配信アーカイブor動画)の2種類です
current_viewersInteger配信中の同時接続数(同時視聴者数) ※配信中以外はnullとなります
as_timeDateTimeActuary Stream Start Time(配信開始時刻) ※配信アーカイブ以外(通常のアップロード動画)はnullとなります
ae_timeDateTimeActuary Stream End Time(配信終了時刻) ※配信アーカイブ以外(通常のアップロード動画)はnullとなります
created_atDateTime配信/アーカイブ/動画の作成時刻(UTC)
update_atDateTime配信/アーカイブ/動画の更新時刻(UTC)
HTTPステータスコード一覧
HTTPステータスコード(HTTP Status Code)詳細(Details)
200正常に処理が終了
404not found
422クエリパラメータエラー
400~500API側でエラーが発生
OpenAPIドキュメント

FastAPIが自動生成したOpenAPIドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから

実際に試す

下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。

Twitterデータの取得 #

Twitch関連のデータを取得できます。
取得できるデータは以下のリストの通りです。

みこちのTwitterアカウントの取得

みこちのTwitterアカウントの情報を取得することができます。

https://api.nyahello.jp/v2/twitter/?<QueryParms>
クエリパラメータ詳細

クエリパラメータの詳細は以下の通りです。

パラメータ名称データ型必須/任意デフォルト意味詳細
tweetBoolean任意falseツイート取得の有無このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでアカウント内のツイートデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。
tweet_skipInteger任意0取得開始位置tweetがtrueの時のみに有効なパラメータです。ツイート取得の開始位置を設定します。
tweet_limitInteger任意50取得終了位置tweetがtrueの時のみに有効なパラメータです。ツイート取得の終了位置を設定します。ツイート情報は1回のリクエストで135件まで取得できます。それ以上の値を指定しても自動で取得数が135件に制限されます。
spaceBoolean任意falseスペース取得の有無このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のコメントデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。
space_skipInteger任意0取得開始位置spaceがtrueの時のみに有効なパラメータです。スペース取得の開始位置を設定します。
space_limitInteger任意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"
}

レスポンス内容の詳細はこちら

レスポンスキー名称データ型詳細
idStringTwitterアカウントID
display_idStringTwitter表示ID(ユーザーによる変更が可能なID)
nameStringTwitterアカウント名
iconStringTwitterアイコンURL
descriptionStringTwitterプロフィール
followers_countIntegerアカウントフォロワー数
following_countIntegerアカウントフォロー数
tweet_countInteger総ツイート数
statusStringアカウントステータス live(スペース配信中),scheduled(スペース予定あり),none(スペース予定なし)の3種類です
spaceDictアカウント内のスペースデータ 詳細はこちら
tweetDictアカウント内のツイートデータ 詳細はこちら
update_atDateTimeアカウント情報の更新時刻(UTC)
HTTPステータスコード一覧
HTTPステータスコード(HTTP Status Code)詳細(Details)
200正常に処理が終了
422クエリパラメータエラー
400~500API側でエラーが発生
OpenAPIドキュメント

FastAPIが自動生成したドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから

実際に試す

下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。

みこちのTwitterアカウント内のスペースデータの複数取得

みこちのYouTubeチャンネル内の動画/アーカイブの情報を複数取得することができます。

https://api.nyahello.jp/v2/twitter/space/?<QueryParms>
クエリパラメータ詳細

クエリパラメータの詳細は以下の通りです

パラメータ名称データ型必須/任意デフォルト意味詳細
orderString任意created_atスペース取得オプションスペース取得の順序や絞り込みが行えます。使用可能オプション created_at(作成順), live(スペース中), scheduled(予定あり), none(終了済み)
skipInteger任意0取得開始位置スペース取得の開始位置を設定します。
limitInteger任意10取得終了位置スペース取得の終了位置を設定します。スペース情報は1回のリクエストで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"
  }
]

レスポンス内容の詳細はこちら

レスポンスキー名称データ型詳細
idStringTwitterスペースID
titleStringスペースタイトル
urlStringスペースURL
statusStringスペーステータス live(スペース中), scheduled(予定あり), none(終了済み)の3種類です
audience_countInteger配信中の同時接続数(同時視聴者数) ※スペース中以外はnullとなります
ss_timeDateTimeScheduled Space Start Time(スペース開始予定時刻) ※予定無くスペースが開始された場合はnullとなります
as_timeDateTimeActuary Space Start Time(スペース開始時刻)
ae_timeDateTimeActuary Space End Time(スペース時刻)
created_atDateTime配信/アーカイブ/動画の作成時刻(UTC)
update_atDateTime配信/アーカイブ/動画の更新時刻(UTC)
HTTPステータスコード一覧
HTTPステータスコード(HTTP Status Code)詳細(Details)
200正常に処理が終了
400orderクエリエラー
422クエリパラメータエラー
400~500API側でエラーが発生
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_idString必要N/AスペースIDTwitterスペース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"
}

レスポンス内容の詳細はこちら

レスポンスキー名称データ型詳細
idStringTwitterスペースID
titleStringスペースタイトル
urlStringスペースURL
statusStringスペーステータス live(スペース中), scheduled(予定あり), none(終了済み)の3種類です
audience_countInteger配信中の同時接続数(同時視聴者数) ※スペース中以外はnullとなります
ss_timeDateTimeScheduled Space Start Time(スペース開始予定時刻) ※予定無くスペースが開始された場合はnullとなります
as_timeDateTimeActuary Space Start Time(スペース開始時刻)
ae_timeDateTimeActuary Space End Time(スペース時刻)
created_atDateTime配信/アーカイブ/動画の作成時刻(UTC)
update_atDateTime配信/アーカイブ/動画の更新時刻(UTC)
HTTPステータスコード一覧
HTTPステータスコード(HTTP Status Code)詳細(Details)
200正常に処理が終了
404not found
422クエリパラメータエラー
400~500API側でエラーが発生
OpenAPIドキュメント

FastAPIが自動生成したOpenAPIドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから

実際に試す

下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。

35Pが投稿したツイートの複数取得

35Pが投稿したみこちに関するツイートをリストで取得することができます。

https://api.nyahello.jp/v2/twitter/tweets/?<QueryParms>
クエリパラメータ詳細

クエリパラメータの詳細は以下の通りです

パラメータ名称データ型必須/任意デフォルト意味詳細
orderString任意created_atツイート取得オプションツイート取得の順序や絞り込みが行えます。使用可能オプション created_at(作成順) ※今後のアップデートで利用可能オプションを追加予定
skipInteger任意0取得開始位置ツイート取得の開始位置を設定します。
limitInteger任意50取得終了位置ツイート取得の終了位置を設定します。ツイート情報は1回のリクエストで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"
  }
]

レスポンス内容の詳細はこちら

レスポンスキー名称データ型詳細
idStringTwitterツイートID
textStringツイート本文
hashtagsListツイートに含まれるハッシュタグリスト ツイート内に含まれるツイートがすべて表示されます
langStringツイート言語
possibly_sensitiveBooleanセンシティブな内容が含まれる可能性のあるツイートかどうか
urlStringツイートURL
matching_rulesListマッチングルール マッチングしたルール名がすべて表示されます 詳細はこちら
user_idStringツイートを投稿したユーザーのID
nameStringツイートを投稿したユーザーの名前
iconStringツイートを投稿したユーザーのアイコンURL
created_atDateTimeツイートの作成時刻(UTC)
HTTPステータスコード一覧
HTTPステータスコード(HTTP Status Code)詳細(Details)
200正常に処理が終了
400orderクエリエラー
422クエリパラメータエラー
400~500API側でエラーが発生
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_idString必要N/AツイートIDTwitterツイート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"
}

レスポンス内容の詳細はこちら

レスポンスキー名称データ型詳細
idStringTwitterツイートID
textStringツイート本文
hashtagsListツイートに含まれるハッシュタグリスト ツイート内に含まれるツイートがすべて表示されます
langStringツイート言語
possibly_sensitiveBooleanセンシティブな内容が含まれる可能性のあるツイートかどうか
urlStringツイートURL
matching_rulesListマッチングルール マッチングしたルール名がすべて表示されます 詳細はこちら
user_idStringツイートを投稿したユーザーのID
nameStringツイートを投稿したユーザーの名前
iconStringツイートを投稿したユーザーのアイコンURL
created_atDateTimeツイートの作成時刻(UTC)
マッチングルール詳細
ルールIDルール名ツイート取得ルール
150437488741859737835P-Tweet1(さくらみこ OR #みこなま OR みこらじお OR みこクラ OR #みこきいたぞ OR #さくらみこ新3Dお披露目 OR #さくら色Dreamer OR #みこ市長 OR #みこんま OR #エリート自由工作 OR #MikoFreeCraft OR #みこなつ OR #みこぺーす OR SakuraMiko) (-is:retweet)
150437488741859738035P-Tweet2(みこち OR みこち撮ったにぇ OR 35P鯖 OR さくら組料理部 OR #35P OR みこぴー OR mこち OR 35PProject OR 35PLAT OR みこቻ OR Mikochi) (-is:retweet)
150437488741859737735P-Art(#miko_Art OR #ミコミコ動画 OR #さくらみこMMD) (has:media -is:retweet -is:quote)
1504374887418597379collaboration(みっこよ 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)
1504374887418597376Mikofrom:sakuramiko35
HTTPステータスコード一覧
HTTPステータスコード(HTTP Status Code)詳細(Details)
200正常に処理が終了
404not found
422クエリパラメータエラー
400~500API側でエラーが発生
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_idString必要N/AユーザーIDTwitterユーザーID
tweetBoolean任意falseツイート取得の有無このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでアカウント内のツイートデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。
tweet_skipInteger任意0取得開始位置tweetがtrueの時のみに有効なパラメータです。ツイート取得の開始位置を設定します。
tweet_limitInteger任意50取得終了位置tweetがtrueの時のみに有効なパラメータです。ツイート取得の終了位置を設定します。ツイート情報は1回のリクエストで135件まで取得できます。それ以上の値を指定しても自動で取得数が135件に制限されます。
spaceBoolean任意falseスペース取得の有無このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のコメントデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。 ※現在は、みこちのアカウントのみスペース情報を取得できます。
space_skipInteger任意0取得開始位置spaceがtrueの時のみに有効なパラメータです。スペース取得の開始位置を設定します。
space_limitInteger任意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"
}

レスポンス内容の詳細はこちら

レスポンスキー名称データ型詳細
idStringTwitterアカウントID
display_idStringTwitter表示ID(ユーザーによる変更が可能なID)
nameStringTwitterアカウント名
iconStringTwitterアイコンURL
descriptionStringTwitterプロフィール
followers_countIntegerアカウントフォロワー数
following_countIntegerアカウントフォロー数
tweet_countInteger総ツイート数
statusStringアカウントステータス live(スペース配信中),scheduled(スペース予定あり),none(スペース予定なし)の3種類です
spaceDictアカウント内のスペースデータ 詳細はこちら
tweetDictアカウント内のツイートデータ 詳細はこちら
update_atDateTimeアカウント情報の更新時刻(UTC) ※みこちのアカウントは5秒毎に更新していますがその他のアカウントはツイートがある毎に更新されます
HTTPステータスコード一覧
HTTPステータスコード(HTTP Status Code)詳細(Details)
200正常に処理が終了
404not found
422クエリパラメータエラー
400~500API側でエラーが発生
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_idString必要N/A表示IDTwitter表示ID(ユーザーによる変更が可能なID)
tweetBoolean任意falseツイート取得の有無このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでアカウント内のツイートデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。
tweet_skipInteger任意0取得開始位置tweetがtrueの時のみに有効なパラメータです。ツイート取得の開始位置を設定します。
tweet_limitInteger任意50取得終了位置tweetがtrueの時のみに有効なパラメータです。ツイート取得の終了位置を設定します。ツイート情報は1回のリクエストで135件まで取得できます。それ以上の値を指定しても自動で取得数が135件に制限されます。
spaceBoolean任意falseスペース取得の有無このパラメータはデフォルトでは無効ですがtrueにしてリクエストすることでチャンネル内のコメントデータを取得できます。あくまでもおまけ的な機能です。取得順序は措定できずcreated_atが最新のものから順に取得されます。 ※現在は、みこちのアカウントのみスペース情報を取得できます。
space_skipInteger任意0取得開始位置spaceがtrueの時のみに有効なパラメータです。スペース取得の開始位置を設定します。
space_limitInteger任意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"
}

レスポンス内容の詳細はこちら

レスポンスキー名称データ型詳細
idStringTwitterアカウントID
display_idStringTwitter表示ID(ユーザーによる変更が可能なID)
nameStringTwitterアカウント名
iconStringTwitterアイコンURL
descriptionStringTwitterプロフィール
followers_countIntegerアカウントフォロワー数
following_countIntegerアカウントフォロー数
tweet_countInteger総ツイート数
statusStringアカウントステータス live(スペース配信中),scheduled(スペース予定あり),none(スペース予定なし)の3種類です
spaceDictアカウント内のスペースデータ 詳細はこちら
tweetDictアカウント内のツイートデータ 詳細はこちら
update_atDateTimeアカウント情報の更新時刻(UTC) ※みこちのアカウントは5秒毎に更新していますがその他のアカウントはツイートがある毎に更新されます
HTTPステータスコード一覧
HTTPステータスコード(HTTP Status Code)詳細(Details)
200正常に処理が終了
404not found
422クエリパラメータエラー
400~500API側でエラーが発生
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_idString必要N/AユーザーIDTwitterユーザーID
skipInteger任意0取得開始位置ツイート取得の開始位置を設定します。
limitInteger任意50取得終了位置ツイート取得の終了位置を設定します。ツイート情報は1回のリクエストで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"
  }
]

レスポンス内容の詳細はこちら

レスポンスキー名称データ型詳細
idStringTwitterツイートID
textStringツイート本文
hashtagsListツイートに含まれるハッシュタグリスト ツイート内に含まれるツイートがすべて表示されます
langStringツイート言語
possibly_sensitiveBooleanセンシティブな内容が含まれる可能性のあるツイートかどうか
urlStringツイートURL
matching_rulesListマッチングルール マッチングしたルール名がすべて表示されます 詳細はこちら
user_idStringツイートを投稿したユーザーのID
nameStringツイートを投稿したユーザーの名前
iconStringツイートを投稿したユーザーのアイコンURL
created_atDateTimeツイートの作成時刻(UTC)
HTTPステータスコード一覧
HTTPステータスコード(HTTP Status Code)詳細(Details)
200正常に処理が終了
404not found
422クエリパラメータエラー
400~500API側でエラーが発生
OpenAPIドキュメント

FastAPIが自動生成したOpenAPIドキュメントをご覧いただけます。
ドキュメントはAPIが変更された際にリアルタイムで更新されるためより正確な情報を得る事ができます。
ドキュメントはこちらから

実際に試す

下のボタンを押すことでAPIの動作を試す事ができます。
ボタンを押すとFastAPIが自動生成するOpenAPIドキュメントに移動します。
移動先のページ右上にある”Try it out”をクリックし、”Execute”をクリックすると実際にAPIのレスポンスを見ることが出来ます。

Powered by BetterDocs

Leave a Reply

メールアドレスが公開されることはありません。