API

独自機能として追加されたAPIについて解説します。

• favourite_tags
• trend_tags

/api/v1/favourite_tags

api経由でお気に入りタグを操作できます。

一覧取得

• GET https://imastodon.net/api/v1/favourite_tags?access_token=???

お気に入りタグ登録

• POST https://imastodon.net/api/v1/favourite_tags?tag=tagname&visibility=unlisted&access_token=???

お気に入りタグ登録解除

• DELETE https://imastodon.net/api/v1/favourite_tags/tagname?access_token=???

POST/DELETEの動作の詳細は以下の通りです。各セル1行目が動作、2行目がJSONの戻り値、3行目がHTTPステータスコードです。

--	未登録のタグ	登録済みのタグ
POST	登録する 登録したタグを返す 200 OK	何もしない Conflictしたタグ(登録されているもの)を返す 409 Conflict
DELETE	何もしない {"succeeded": false} 404 NotFound	削除する {"succeeded": true} 200 OK

タグを返すときの形式は以下の例のようになります。 { "id": 5, "name": "imas", "visibility": "unlisted" }

/api/v1/trend_tags

api経由で直近のトレンドタグの集計結果を取得できます。

• GET https://imastodon.net/api/v1/trend_tags

以下の形式のJSONを返します。

{
  "updated_at": "2017-12-18T05:25:00Z",        #集計時間
  "score": {
    "tagname_hoge": 2.0,        #タグ名とスコア
    "tagname_fuga": 14.2
  }
}

また、オプションとして history_mode パラメータにtruthyな値(falseや0以外のtrueとしてみなされる値; true, 1, "hoge"など)を渡すと、過去2時間分の集計履歴を取得できます。history_modeがオンの時は現在のトレンドスコアは返しません。

• GET https://imastodon.net/api/v1/trend_tags?history_mode=true

以下の形式のJSONの配列を返します。各要素は集計時刻の降順で並んでいます。

[
{
  "updated_at": "2017-12-18T05:15:00Z",        #集計時間
  "score": {
    "tagname_hoge": 4.0,        #タグ名とスコア
    "tagname_fuga": 10.7
  }
},
{
  "updated_at": "2017-12-18T05:05:00Z",        #集計時間
  "score": {
    "tagname_hoge": 8.0,        #タグ名とスコア
    "tagname_fuga": 16.1,
    "tagname_piyo": 0.65
  }
},
...
]

更新は、毎時10n+5分(n=0,1,…,5)に行われます。