アンテナAPI - kmycode/mastodon GitHub Wiki

対応可否の判定方法

下記のエンドポイントで取得できるJSONについて

/api/v1/instance
/api/v2/instance

下記の配列に値があるかで判定してください

{
  "fedibird_capabilities": [
    "kmyblue_antenna"
  ]
}

追加されたオブジェクト

antennaが追加されました。これは以下のパラメータを持つオブジェクトです。

{
  "id": "（文字列）アンテナのID",
  "title": "（文字列）アンテナの名前",
  "stl": "（論理値）trueならSTLモードとして動作",
  "insert_feeds": "（論理値）trueならホームまたはリストに投稿を流す",
  "with_media_only": "（論理値）trueならメディアを含む投稿のみを検出",
  "ignore_reblog": "（論理値）trueならブーストを除外",
  "accounts_count": "（数値）アンテナに登録されたアカウント数",
  "domains_count": "（数値）アンテナに登録されたドメイン数",
  "tags_count": "（数値）アンテナに登録されたタグ数",
  "keywords_count": "（数値）アンテナに登録されたキーワード数",
  "list": "（オブジェクトまたはNULL）アンテナに登録されたリスト。id、titleの２プロパティのみを持つ"
}

既存のオブジェクトに追加されたプロパティ

listオブジェクトに以下のプロパティが追加されています。

{
  "antennas": "（オブジェクト配列）リストに関連付けられたアンテナの一覧。id、title、stlのプロパティのみを持つ"
}

追加されたストリーミング

GET /api/v1/streaming/antenna?antenna=:antenna_id

パラメータ名	例	説明
antenna	24	対象アンテナのID

アンテナのストリーミングに接続します。アンテナによって検出された投稿が、このストリーミングを通してリアルタイムに配信されます。

追加されたタイムライン

GET /api/v1/timelines/antenna/:antenna_id

パラメータ名	例	説明
antenna_id	24	対象アンテナのID

アンテナのタイムラインを取得します。アンテナによって検出された投稿が返されます。タイムラインのページネーション方法は、他のAPI（/api/v1/timelines/list/:list_idなど）に準じます。

アンテナの一覧を取得

GET /api/v1/antennas

戻り値：アカウントが所有するantennaの配列

指定されたアンテナの情報を取得

GET /api/v1/antennas/:antenna_id

パラメータ名	例	説明
antenna_id	24	対象アンテナのID

戻り値：指定されたIDのアンテナのantennaオブジェクト

その他の追加されたAPI

（この項目は執筆中です）