Princess — Public REST API

夢の世界へご招待なのです

プリンセス・アラモード

Public RESTful Application Programming Interface Series.

開発者向けの API を提供しています。

共通

成功・失敗の判断には HTTP のステータスコードを利用してください。成功した場合には必ず 200 が返ります。

レスポンスは整形された JSON です。クエリに prettyPrint=false を指定すると整形されない状態で取得できます(高速になります)。

パスパラメータのうち ? のついているものは任意であることを、クエリパラメータのうち ! のついているものは必須であることを表します。

クエリパラメータのうち Boolean のものは true を指定した場合にのみ有効になります。

パラメータのうち配列のものはカンマ区切りで複数指定可能です。Integer[] 型のパラメータは 1-10,100,1000 のようにカンマ区切りに加えて範囲指定も可能です。列挙型の String[] 型のパラメータは対応する整数でも指定可能です。

DateTime 型は ISO8601 形式(2018-02-04T12:30:00+09:00 など)で指定すると確実です。タイムゾーンを省略すると JST で解釈します。

注意事項

本 API はあくまで善意による利用を想定しております。特定のアイドルを担当するプロデューサーさんや特定のラウンジに所属するプロデューサーさんが快く思わないようなデータの利用はご遠慮ください。

This service shall be used for Good, not Evil. Do not use these APIs for a purpose that is offensive or derogatory to any other producers.

本 API を利用した Web サービス(Twitter などの bot を含む)などを運営する場合には、情報源が matsurihi.me であることの明記をお願いします。

Please refer to matsurihi.me whenever you host any public web services, Twitter bots, and so on.

短時間に多数のリクエストを行うと 429 Too Many Requests を返します。

目次

最近の更新点

シアターデイズ エンドポイント一覧

ベースの URL は https://api.matsurihi.me/mltd/v1/ です。

が付された API は海外版に対応しています。韓国語版、繁体字版のベース URL はそれぞれ /mltd/v1/ko/ および /mltd/v1/zh/ です。日本語版は同様に /mltd/v1/ja/ からも利用できます。

バージョン関連 API(version)

GET/version/latest最新のアプリ・アセットバージョンの取得

https://api.matsurihi.me/mltd/v1/version/latest

レスポンス
  • Object app アプリバージョンの情報
    • String version バージョン名
    • DateTime updateTime 強制アップデートされた日時
    • Integer revision アプリのリビジョン番号
  • Object res アセットバージョンの情報
    • Integer version バージョン番号
    • DateTime updateTime 配信日時
    • String indexName
GET/version/apps/[version]過去のアプリバージョン情報の取得

https://api.matsurihi.me/mltd/v1/version/apps/2.1.390

パスパラメータ
  • String? version 取得するバージョン名
レスポンス(パスパラメータ省略時のみ配列)
  • String version バージョン名
  • DateTime updateTime 強制アップデートされた日時
  • Integer revision アプリのリビジョン番号
GET/version/assets/[version]過去のアセットバージョン情報の取得

https://api.matsurihi.me/mltd/v1/version/assets/1

パスパラメータ
  • Integer? version 取得するバージョン番号
レスポンス(パスパラメータ省略時のみ配列)
  • Integer version バージョン番号
  • DateTime updateTime 配信日時
  • String indexName

カード(エピソード)関連 API(cards)

BRAND★NEW★PERFORM@NCE!!! などカードの ID は重複することがあります

スキルは複数とる可能性があるため配列で処理されます。

GET/cards/[id]カード情報の取得

https://api.matsurihi.me/mltd/v1/cards?idolId=21

https://api.matsurihi.me/mltd/v1/cards/250

パスパラメータ
  • Integer[]? id 取得するカードの ID
クエリパラメータ
  • Integer[] idolId 取得するアイドル
  • String[] rarity 取得するカードのレアリティ(n | r | sr | ssr
  • String[] extraType 取得するカードの種類(none | pst | pstr | pstp | fes | aniv | 1staniv | 2ndaniv | extra
レスポンス(配列)
  • Integer id カード ID
  • String name カード名
  • Integer sortId ゲーム内でのソート用番号
  • Integer idolId アイドル ID
  • Integer idolType アイドルの属性
    • 1 : Princess
    • 2 : Fairy
    • 3 : Angel
    • 5 : Ex
  • String resourceId リソース用 ID
  • Integer rarity レアリティ
    • 1 : N
    • 2 : R
    • 3 : SR
    • 4 : SSR
  • Integer? eventId イベント ID
  • String category カードの入手方法カテゴリ
    • normal : 初期ノーマル
    • gasha0 : 恒常ガシャ
    • gasha1 : 限定ガシャ
    • gasha2 : フェス限定
    • gasha4 : プレミアムピックアップ SR ガシャ限定
    • gasha5 : セカンドヘアスタイルガシャ限定
    • event0 : ミリコレ(SR)
    • event1 : シアター
    • event2 : ツアー
    • event3 : 周年イベント
    • event4 : 投票イベント追加 SR(超ビーチバレー ロコなど)
    • event5 : ミリコレ(R)
    • other : その他
  • Integer extraType カードの種類
    • 0 : なし
    • 2 : PST ランキング報酬
    • 3 : PST ポイント報酬
    • 4 : フェス
    • 5 : 1 周年イベント報酬
    • 6 : Extra カード
    • 7 : 2 周年イベント報酬
    • 8 : Extra PST ランキング報酬
    • 9 : Extra PST ポイント報酬
    • 10 : 3 周年イベント報酬
    • 11 : Extra PST ランキング報酬
    • 12 : Extra PST ポイント報酬
    • 13 : 4 周年イベント報酬
    • 14 : セカンドヘアスタイル
  • Object? costume 衣装情報
    • Integer id 衣装 ID
    • String name 衣装の名前
    • String description 衣装の説明
    • String resourceId リソース用 ID
    • String modelId 3D モデル用 ID
    • Integer sortId ゲーム内でのソート用番号
  • Object? bonusCostume 衣装情報(☆4 獲得時・costume と同様)
  • Object? rank5Costume 衣装情報(☆5 獲得時・costume と同様)
  • String flavorText 覚醒前フレーバーテキスト
  • String flavorTextAwakened 覚醒後フレーバーテキスト
  • Integer levelMax 覚醒前最大 Lv
  • Integer levelMaxAwakened 覚醒後最大 Lv
  • Integer vocalMin 覚醒前・Lv.1 でのボーカル値
  • Integer vocalMax 覚醒前・Lv.Max でのボーカル値
  • Integer vocalMinAwakened 覚醒後・Lv.1 でのボーカル値
  • Integer vocalMaxAwakened 覚醒後・Lv.Max でのボーカル値
  • Integer vocalMasterBonus マスターランク 1 ごとに得られるボーカル値
  • Integer danceMin 覚醒前・Lv.1 でのダンス値
  • Integer danceMax 覚醒前・Lv.Max でのダンス値
  • Integer danceMinAwakened 覚醒後・Lv.1 でのダンス値
  • Integer danceMaxAwakened 覚醒後・Lv.Max でのダンス値
  • Integer danceMasterBonus マスターランク 1 ごとに得られるダンス値
  • Integer visualMin 覚醒前・Lv.1 でのビジュアル値
  • Integer visualMax 覚醒前・Lv.Max でのビジュアル値
  • Integer visualMinAwakened 覚醒後・Lv.1 でのビジュアル値
  • Integer visualMaxAwakened 覚醒後・Lv.Max でのビジュアル値
  • Integer visualMasterBonus マスターランク 1 ごとに得られるビジュアル値
  • Integer life ライフ
  • Integer masterRankMax 最大マスターランク
  • Object? centerEffect センター効果情報
    • Integer id センター効果 ID
    • String description センター効果の説明文
    • Integer idolType 対象となるアイドルの属性
      • 1 : Princess
      • 2 : Fairy
      • 3 : Angel
      • 4 : 全タイプ
    • Integer? specificIdolType 全アイドルが満たすべき属性
      • 1 : Princess
      • 2 : Fairy
      • 3 : Angel
      • 4 : 全タイプ(トリコロール)
    • Integer attribute 対象となる値
      • 1 : ボーカル値
      • 2 : ダンス値
      • 3 : ビジュアル値
      • 4 : 全アピール値
      • 5 : ライフ
      • 6 : スキル発動率
    • Integer value 効果量
    • Integer? songType 対象となる楽曲の属性
      • 1 : Princess
      • 2 : Fairy
      • 3 : Angel
      • 4 : 全タイプ
    • Integer? attribute2 対象となる値(2 つめの効果)
    • Integer? value2 効果量(2 つめの効果)
  • String centerEffectName センター効果の名前
  • Object[]? skill スキル情報
    • Integer id スキル ID
    • String description スキルの説明文
    • Integer effectId 効果対象 ID
      • 1 : スコアアップ
      • 2 : コンボボーナス
      • 3 : ライフ回復
      • 4 : ダメージガード
      • 5 : コンボ継続
      • 6 : 判定強化
      • 7 : ダブルブースト
      • 8 : マルチアップ
      • 10 : オーバークロック
      • 11 : オーバーロンド
      • 12 : ダブルエフェクト
    • Integer evaluation 対象となるノーツの種類
      • 0 : すべて
      • 1 : Perfect
      • 2 : Perfect/Great
      • 3 : Great
      • 4 : Great/Good/Fast/Slow
      • 5 : Perfect/Great/Good
      • 6 : Perfect/Great/Good/Fast/Slow
      • 7 : Great/Good
    • Integer evaluation2 対象となるノーツの種類(2 つめの効果)
    • Integer duration 発動継続時間
    • Integer interval 発動間隔
    • Integer probability 発動確率(スキル Lv.0 を仮定したとき)
    • Integer[] value 効果量
    • String skillName スキルの名前
  • DateTime? addDate 実装日時

クエリパラメータはパスパラメータを省略した場合にのみ有効です。

カード情報取得における技術的な制約により、? で明示されていなくてもフィールドが存在しないまま返却される場合があります。

以前は☆5 解放時の最大スキル Lv 上昇は反映されず Lv.10 のまま返りましたが、2020/07/13 以降は反映されるようになりました。

イベント関連 API(events)

GET/events/[id]イベント情報の取得

https://api.matsurihi.me/mltd/v1/events/70

パスパラメータ
  • Integer? id 取得するイベントの ID
クエリパラメータ
  • DateTime at 指定した時刻に開催されている/いたイベントで絞り込み
  • String[] type イベントの種類で絞り込み(showtime | millicolle | theater | tour | anniversary | twinstage | tune | tale | pst
  • String orderBy 戻り値の順序(beginTime | id
レスポンス(パスパラメータ省略時のみ配列)
  • Integer id イベント ID
  • Integer type イベントの種類を表す番号
    • 1 : THEATER SHOW TIME☆
    • 2 : ミリコレ!
    • 3 : プラチナスターシアター
    • 4 : プラチナスターツアー
    • 5 : 周年記念イベント
    • 6 : MILLION LIVE WORKING☆
    • 7 : エイプリルフール
    • 9 : ミリコレ!(ボックスガシャ)
    • 10 : ツインステージ
    • 11 : プラチナスターチューン
    • 12 : ツインステージ 2
    • 13 : プラチナスターテール
    • 14 : THEATER TALK PARTY☆
  • Integer? appealType アピールボーナスがかかる属性値
    • 1 : ボーカル
    • 2 : ダンス
    • 3 : ビジュアル
  • Object schedule スケジュール情報
    • DateTime beginDate イベント開始日時
    • DateTime endDate イベント終了日時
    • DateTime pageBeginDate イベントページ表示開始日時
    • DateTime pageEndDate イベントページ表示終了日時
    • DateTime? boostBeginDate イベント後半戦開始日時
    • DateTime? boostEndDate イベント後半戦終了日時
  • String? name イベント名

クエリパラメータはパスパラメータを省略した場合にのみ有効です。

イベントランキング関連 API(events/[id]/rankings)

matsurihi.me 側での取得が漏れているデータについては取得できません。

GET/events/[id]/rankings/bordersイベントのボーダー情報の取得

https://api.matsurihi.me/mltd/v1/events/70/rankings/borders

パスパラメータ
  • Integer id 取得するイベントの ID
レスポンス
  • Integer[]? eventPoint ポイントランキング報酬のボーダーの一覧
  • Integer[]? highScore ハイスコアランキング報酬のボーダーの一覧
  • Integer[]? highScore2 ハイスコア(2曲目)ランキング報酬のボーダーの一覧(ツインステージ)
  • Integer[]? highScoreTotal 総合ハイスコアランキング報酬のボーダーの一覧(チューン)
  • Integer[]? loungePoint ラウンジランキング報酬のボーダーの一覧
  • Object[]? idolPoint アイドル別ランキング報酬のボーダーの一覧
    • Integer idolId アイドル ID
    • Integer borders 対象アイドルのボーダーの一覧
GET/events/[id]/rankings/borderPoints現在のイベントのボーダースコアの取得

https://api.matsurihi.me/mltd/v1/events/70/rankings/borderPoints

パスパラメータ
  • Integer id 取得するイベントの ID
レスポンス
  • Object? eventPoint ポイントランキング報酬のボーダースコアの情報
    • Object[] scores ボーダーの一覧
      • Integer rank 順位
      • Float score スコア
    • DateTime summaryTime 集計日時
    • Integer count 集計対象数
  • Object? highScore ハイスコアランキング報酬のボーダースコアの情報(eventPoint と同様)
  • Object? highScore2 ハイスコア(2 曲目)ランキング報酬のボーダースコアの情報(eventPoint と同様)
  • Object? highScoreTotal 総合ハイスコアランキング報酬のボーダースコアの情報(eventPoint と同様)
  • Object? loungePoint ラウンジランキング報酬のボーダースコアの情報(eventPoint と同様)

ボーダーに加えて、常に 1〜3 位のデータを含めて返します。

アイドル別ランキングのボーダースコアは取得できません。

GET/events/[id]/rankings/summaries/[type]イベントランキングの集計情報の取得

https://api.matsurihi.me/mltd/v1/events/70/rankings/summaries/eventPoint

パスパラメータ
  • Integer id 取得するイベントの ID
  • String type 取得するランキングデータの種類(eventPoint | highScore | highScore2 | highScoreTotal | loungePoint
レスポンス(配列)
  • DateTime summaryTime 集計日時
  • DateTime? updateTime 配信日時
  • Integer count 集計対象数
GET/events/[id]/rankings/summaries/idolPoint/[idolId]イベントランキングの集計情報の取得(アイドル別)

https://api.matsurihi.me/mltd/v1/events/92/rankings/summaries/idolPoint/21

パスパラメータ
  • Integer id 取得するイベントの ID
  • Integer idolId 取得するアイドルの ID(1–52)
レスポンス(配列)
  • DateTime summaryTime 集計日時
  • DateTime? updateTime 配信日時
GET/events/[id]/rankings/logs/[type]/[ranks]イベントランキングのログの取得

https://api.matsurihi.me/mltd/v1/events/70/rankings/logs/eventPoint/1,2,3

パスパラメータ
  • Integer id 取得するイベントの ID
  • String type 取得するランキングデータの種類(eventPoint | highScore | highScore2 | highScoreTotal | loungePoint
  • Integer[] rank 取得する順位
クエリパラメータ
  • DateTime timeMin 指定した日時以降のデータのみ取得(指定日時を含む)
レスポンス(配列)
  • Integer rank 順位
  • Object[] data
    • Float score スコア
    • DateTime summaryTime 集計日時
GET/events/[id]/rankings/logs/idolPoint/[idolId]/[ranks]イベントランキングのログの取得(アイドル別)

https://api.matsurihi.me/mltd/v1/events/92/rankings/logs/idolPoint/21/1,2,3

パスパラメータ
  • Integer id 取得するイベントの ID
  • Integer idolId 取得するアイドルの ID(1–52)
  • Integer[] rank 取得する順位
クエリパラメータ
  • DateTime timeMin 指定した日時以降のデータのみ取得(指定日時を含む)

レスポンスは通常ランキングの API(/events/[id]/rankings/logs/[type]/[ranks])と共通です。

イベントや期間によらず、30 分ごとのデータのみ利用できます。

ラウンジ関連 API(lounges)

データベース内のキャッシュを利用しているため、最新の情報でない場合があります。

GET/lounges/[id]ラウンジ情報の取得
パスパラメータ
  • String id ラウンジ ID(実 ID と表示 ID のどちらでも可)
レスポンス
  • String id 実 ID
  • String viewerId 検索用の表示 ID
  • String name ラウンジ名
  • String comment ラウンジコメント
  • Integer userCount 所属ユーザー数
  • Integer userCountLimit 最大所属ユーザー数
  • Integer fan ラウンジファン数
  • String masterName ラウンジマスター名
  • DateTime createTime ラウンジ開設日時
  • DateTime updateTime 情報更新日時
GET/lounges/[id]/eventHistory過去のラウンジランキング成績の取得
パスパラメータ
  • String id ラウンジ ID(実 ID と表示 ID のどちらでも可)
レスポンス
  • Integer eventId イベント ID
  • String eventName イベント名
  • DateTime summaryTime 集計日時
  • Integer rank 最終順位
  • Float score 最終累計スコア

最終結果の集計が終了しているイベントのみ取得できます。開催中・集計中のイベントについては返却されません。

GET/lounges/searchラウンジ検索

https://api.matsurihi.me/mltd/v1/lounges/search?name=徳川まつり

パスパラメータ
  • String! name ラウンジ名(中間一致・ケースインセンシティブ・3 文字以上)
  • Boolean includeDeleted 削除されたラウンジを含める
レスポンス(配列)
  • String id 実 ID
  • String viewerId 検索用の表示 ID
  • String name ラウンジ名
  • DateTime updateTime 情報更新日時

スターライトステージ エンドポイント一覧

ベースの URL は https://api.matsurihi.me/cgss/v1/ です。

バージョン関連 API(version)

GET/version/latest最新のアプリ・リソースバージョンの取得

https://api.matsurihi.me/cgss/v1/version/latest

レスポンス
  • Object app アプリバージョンの情報
    • String version バージョン名
    • DateTime updateTime 強制アップデートされた日時
  • Object res リソースバージョンの情報
    • Integer version バージョン番号
    • DateTime updateTime 配信日時

デレぽ関連 API(derepo)

GET/derepo/statuses/[id]デレぽ投稿の取得

https://api.matsurihi.me/cgss/v1/derepo/statuses/292

パスパラメータ
  • Integer? id 取得する投稿の ID
クエリパラメータ
  • Integer idolId アイドルで絞り込み
  • Integer groupId グループで絞り込み
  • Integer hashtagId ハッシュタグで絞り込み
  • DateTime timeMax 指定した日時より前の投稿のみ取得(指定日時を含まない)
  • DateTime timeMin 指定した日時以降の投稿のみ取得(指定日時を含む)
  • Integer maxResults 取得件数(1〜100、デフォルトは 10)
  • String orderBy 戻り値の順序(逆順)(postTime | id
レスポンス(パスパラメータ省略時のみ配列)
  • Integer id 投稿の ID
  • Integer groupId 投稿のグループ ID
  • Integer groupOrder 投稿グループ内での順序
  • Integer idolId 投稿したアイドルの ID
  • String name 投稿時の名前
  • String message 投稿内容
  • String iconPath
  • String? imagePath
  • DateTime postTime 投稿日時
  • Object[] hashtags ハッシュタグ情報
    • Integer id ハッシュタグの ID
    • String word ハッシュタグ

HTML として表示するデータをそのまま返すため、投稿内容には <br> などのマークアップ文字列がそのまま入ります。

スタンプのみの投稿(id: 5659 など)は messagestamp_only:スタンプ ID の形式の特殊な文字列が入ります。

GET/derepo/hashtagsハッシュタグの一覧の取得

https://api.matsurihi.me/cgss/v1/derepo/hashtags

レスポンス(配列)
  • Integer id ハッシュタグの ID
  • String word ハッシュタグ
GET/derepo/stampsスタンプの一覧の取得

https://api.matsurihi.me/cgss/v1/derepo/stamps

レスポンス(配列)
  • String id スタンプの ID
  • String name スタンプの表示名

スタンプの表示名はデレぽ bot で用いている表示名で、matsurihi.me 側で手作業で決定した非公式の名称を含みます。

シャイニーカラーズ エンドポイント一覧

ベースの URL は https://api.matsurihi.me/sc/v1/ です。

シャニマス関連 API のみ、プロデュース・サポートアイドルとの混同を避けるためアイドルを character と表記します。

バージョン関連 API(version)

GET/version/latest最新のアプリ・リソースバージョンの取得

https://api.matsurihi.me/sc/v1/version/latest

レスポンス
  • Object script スクリプトバージョンの情報
    • String version バージョン名
    • DateTime updateTime 配信日時
  • Object asset リソースバージョンの情報
    • Integer version バージョン番号
    • DateTime updateTime 配信日時

ファンランキングイベント(プロデューサーズカップ)関連 API(events/fanRanking)

2.5 周年以降のイベントのみ取得できます。

GET/events/fanRankingイベント一覧の取得

https://api.matsurihi.me/sc/v1/events/fanRanking

レスポンス(配列)
  • Integer id イベント ID
  • String name イベント名
  • DateTime beginTime イベント開始日時
  • DateTime endTime イベント終了日時
GET/events/fanRanking/[id]/rankings/logs/[characterId]/[ranks]イベントランキングのログの取得

https://api.matsurihi.me/sc/v1/events/fanRanking/40005/rankings/logs/1/1,2,3

レスポンス(配列)
  • Integer rank 順位
  • Object[] data
    • Integer score スコア
    • DateTime summaryTime データ取得日時