Princess — Public REST API

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

プリンセス・アラモード

Public RESTful Application Programming Interface Series.

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

共通

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

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

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

クエリパラメータのうち Boolean のものは true を指定した場合にのみ有効になります。配列のものはカンマ区切りで複数指定可能です。

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

注意事項

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

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

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

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

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

バージョン関連 API(version)

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

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

レスポンス

  • Objectappアプリバージョンの情報
    • Stringversionバージョン名
    • DateTimeupdateTime強制アップデートされた日時
    • Integerrevisionアプリのリビジョン番号
  • Objectresアセットバージョンの情報
    • Integerversionバージョン番号
    • DateTimeupdateTime配信日時
    • StringindexName
GET /version/apps/[version] 過去のアプリバージョン情報の取得

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

パスパラメータ

  • String?version取得するバージョン名

レスポンス(パスパラメータ省略時のみ配列)

  • Stringversionバージョン名
  • DateTimeupdateTime強制アップデートされた日時
  • Integerrevisionアプリのリビジョン番号

パスパラメータを省略した場合には、全アプリバージョンの情報が返ります。

GET /version/assets/[version] 過去のアセットバージョン情報の取得

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

パスパラメータ

  • Integer?version取得するバージョン番号

レスポンス(パスパラメータ省略時のみ配列)

  • Integerversionバージョン番号
  • DateTimeupdateTime配信日時
  • StringindexName

パスパラメータを省略した場合には、全アセットバージョンの情報が返ります。

カード(エピソード)関連 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

レスポンス(配列)

  • Integeridカード ID
  • Stringnameカード名
  • IntegersortIdゲーム内でのソート用番号
  • IntegeridolIdアイドル ID
  • IntegeridolTypeアイドルの属性
    • 1: Princess
    • 2: Fairy
    • 3: Angel
    • 5: Ex
  • StringresourceIdリソース用 ID
  • Integerrarityレアリティ
    • 1: N
    • 2: R
    • 3: SR
    • 4: SSR
  • Integer?eventIdイベント ID
  • IntegerextraTypeカードの種類
    • 0: なし
    • 2: PST ランキング報酬
    • 3: PST ポイント報酬
    • 4: フェス
    • 5: 1 周年イベント報酬
    • 6: Extra カード
    • 7: 2 周年イベント報酬
  • Object?costume衣装情報
    • Integerid衣装 ID
    • Stringname衣装の名前
    • Stringdescription衣装の説明
    • StringresourceIdリソース用 ID
    • StringmodelId3D モデル用 ID
    • IntegersortIdゲーム内でのソート用番号
  • Object?bonusCostume衣装情報(☆4 獲得時)
    • Integerid衣装 ID
    • Stringname衣装の名前
    • Stringdescription衣装の説明
    • StringresourceIdリソース用 ID
    • StringmodelId3D モデル用 ID
    • IntegersortIdゲーム内でのソート用番号
  • Object?rank5Costume衣装情報(☆5 獲得時)
    • Integerid衣装 ID
    • Stringname衣装の名前
    • Stringdescription衣装の説明
    • StringresourceIdリソース用 ID
    • StringmodelId3D モデル用 ID
    • IntegersortIdゲーム内でのソート用番号
  • StringflavorText覚醒前フレーバーテキスト
  • StringflavorTextAwakened覚醒後フレーバーテキスト
  • IntegerlevelMax覚醒前最大 Lv
  • IntegerlevelMaxAwakened覚醒後最大 Lv
  • IntegervocalMin覚醒前・Lv.1 でのボーカル値
  • IntegervocalMax覚醒前・Lv.Max でのボーカル値
  • IntegervocalMinAwakened覚醒後・Lv.1 でのボーカル値
  • IntegervocalMaxAwakened覚醒後・Lv.Max でのボーカル値
  • IntegervocalMasterBonusマスターランク 1 ごとに得られるボーカル値
  • IntegerdanceMin覚醒前・Lv.1 でのダンス値
  • IntegerdanceMax覚醒前・Lv.Max でのダンス値
  • IntegerdanceMinAwakened覚醒後・Lv.1 でのダンス値
  • IntegerdanceMaxAwakened覚醒後・Lv.Max でのダンス値
  • IntegerdanceMasterBonusマスターランク 1 ごとに得られるダンス値
  • IntegervisualMin覚醒前・Lv.1 でのビジュアル値
  • IntegervisualMax覚醒前・Lv.Max でのビジュアル値
  • IntegervisualMinAwakened覚醒後・Lv.1 でのビジュアル値
  • IntegervisualMaxAwakened覚醒後・Lv.Max でのビジュアル値
  • IntegervisualMasterBonusマスターランク 1 ごとに得られるビジュアル値
  • Integerlifeライフ
  • Object?centerEffectセンター効果情報
    • Integeridセンター効果 ID
    • Stringdescriptionセンター効果の説明文
    • IntegeridolType対象となるアイドルの属性
      • 1: Princess
      • 2: Fairy
      • 3: Angel
      • 4: 全タイプ
    • Integer?specificIdolType全アイドルが満たすべき属性
      • 1: Princess
      • 2: Fairy
      • 3: Angel
      • 4: 全タイプ(トリコロール)
    • Integerattribute対象となる値
      • 1: ボーカル値
      • 2: ダンス値
      • 3: ビジュアル値
      • 4: 全アピール値
      • 5: ライフ
      • 6: スキル発動率
    • Integervalue効果量
  • StringcenterEffectNameセンター効果の名前
  • Object[]?skillスキル情報
    • Integeridスキル ID
    • Stringdescriptionスキルの説明文
    • IntegereffectId効果対象 ID
      • 1: スコアアップ
      • 2: コンボボーナス
      • 3: ライフ回復
      • 4: ダメージガード
      • 5: コンボ継続
      • 6: 判定強化
      • 7: ダブルブースト
      • 8: マルチアップ
      • 10: オーバークロック
    • Integerevaluation対象となるノーツの種類
      • 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
    • Integerevaluation2対象となるノーツの種類(2 つめの効果・マルチアップのみ有効)
      • Integerduration発動継続時間
      • Integerinterval発動間隔
      • Integerprobability発動確率(スキル Lv.0 を仮定したとき)
      • Integer[]value効果量(ダブルブースト・マルチアップ・オーバークロックは要素数が 2 になります)
    • StringskillNameスキルの名前
    • DateTime?addDate実装日時

    パスパラメータを省略した場合には、複数のカードの情報が返ります。

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

    ☆5 解放時の最大スキル Lv 上昇は反映されません(Lv.10 のまま返ります)。

    イベント関連 API(events)

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

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

    パスパラメータ

    • Integer?id取得するイベントの ID

    クエリパラメータ

    • DateTimeat指定した時刻に開催されている/いたイベントで絞り込み
    • Stringtypeイベントの種類で絞り込み(showtime | millicolle | theater | tour | anniversary | pst
    • StringorderBy戻り値の順序(beginTime | id

    レスポンス(パスパラメータ省略時のみ配列)

    • Integeridイベント ID
    • Integertypeイベントの種類を表す番号
      • 1: THEATER SHOW TIME☆
      • 2: ミリコレ!
      • 3: プラチナスターシアター
      • 4: プラチナスターツアー
      • 5: 周年記念イベント
      • 6: MILLION LIVE WORKING☆
      • 7: エイプリルフール
    • Integer?appealTypeアピールボーナスがかかる属性値
      • 1: ボーカル
      • 2: ダンス
      • 3: ビジュアル
    • Objectscheduleスケジュール情報
      • DateTimebeginDateイベント開始日時
      • DateTimeendDateイベント終了日時
      • DateTimepageBeginDateイベントページ表示開始日時
      • DateTimepageEndDateイベントページ表示終了日時
      • DateTime?boostBeginDateイベント後半戦開始日時
      • DateTime?boostEndDateイベント後半戦終了日時
    • String?nameイベント名

    パスパラメータを省略した場合には、複数のイベントの情報が返ります。

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

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

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

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

    パスパラメータ

    • Integerid取得するイベントの ID

    レスポンス

    • Integer[]eventPointポイントランキング報酬のボーダーの一覧
    • Integer[]highScoreハイスコアランキング報酬のボーダーの一覧
    • Integer[]loungePointラウンジランキング報酬のボーダーの一覧
    • Object[]?idolPointアイドル別ランキング報酬のボーダーの一覧
      • IntegeridolIdアイドル ID
      • Integerborders対象アイドルのボーダーの一覧
    GET /events/[id]/rankings/summaries/[type] イベントランキングの集計情報の取得

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

    パスパラメータ

    • Integerid取得するイベントの ID
    • Stringtype取得するランキングデータの種類(eventPoint | highScore | loungePoint

    レスポンス(配列)

    • DateTimesummaryTime集計日時
    • DateTime?updateTime配信日時
    • Integercount集計対象数
    GET /events/[id]/rankings/logs/[type]/[rank] イベントランキングのログの取得

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

    パスパラメータ

    • Integerid取得するイベントの ID
    • Stringtype取得するランキングデータの種類(eventPoint | highScore | loungePoint
    • Integer[]rank取得する順位

    レスポンス(配列)

    • Integerrank順位
    • Object[]data
      • Floatscoreスコア
      • DateTimesummaryTime集計日時

    matsurihi.me 側で集計できていないデータについては(たとえ実際に存在していても)取得することができません。

    GET /events/[id]/rankings/logs/idolPoint/[idolId]/[rank] イベントランキングのログの取得(アイドル別)

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

    パスパラメータ

    • Integerid取得するイベントの ID
    • IntegeridolId取得するアイドルの ID(1–52)
    • Integer[]rank取得する順位

    レスポンス(配列)

    • Integerrank順位
    • Object[]data
      • Floatscoreスコア
      • DateTimesummaryTime集計日時

    matsurihi.me 側で集計できていないデータについては(たとえ実際に存在していても)取得することができません。

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

    ラウンジ関連 API(lounges)

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

    GET /lounges/[id] ラウンジ情報の取得

    https://api.matsurihi.me/mltd/v1/lounges/TLZJB76M

    パスパラメータ

    • Stringidラウンジ ID(実 ID と表示 ID のどちらでも可)

    レスポンス

    • Stringid実 ID
    • StringviewerId検索用の表示 ID
    • Stringnameラウンジ名
    • Stringcommentラウンジコメント
    • IntegeruserCount所属ユーザー数
    • IntegeruserCountLimit最大所属ユーザー数
    • Integerfanラウンジファン数
    • StringmasterNameラウンジマスター名
    • DateTimecreateTimeラウンジ開設日時
    • DateTimeupdateTime情報更新日時
    GET /lounges/[id]/eventHistory 過去のラウンジランキング成績の取得

    https://api.matsurihi.me/mltd/v1/lounges/TLZJB76M/eventHistory

    パスパラメータ

    • Stringidラウンジ ID(実 ID と表示 ID のどちらでも可)

    レスポンス(配列)

    • IntegereventIdイベント ID
    • StringeventNameイベント名
    • DateTimesummaryTime集計日時
    • Integerrank最終順位
    • Floatscore最終累計スコア

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

    GET /lounges/search ラウンジ検索

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

    クエリパラメータ

    • String!nameラウンジ名(中間一致・ケースインセンシティブ・3 文字以上)
    • BooleanincludeDeleted削除されたラウンジを含める

    レスポンス

    • Stringid実 ID
    • StringviewerId検索用の表示 ID
    • Stringnameラウンジ名
    • DateTimeupdateTime情報更新日時

    ユニット選抜投票イベント関連 API(election)

    GET /election 開催しているイベント情報の取得

    https://api.matsurihi.me/mltd/v1/election

    レスポンス

    • Integeridイベント ID
    • Stringnameイベント名
    • Objectscheduleスケジュール情報
      • DateTimebeginDateイベント開始日時
      • DateTimeendDateイベント終了日時
      • DateTimepageBeginDateイベントページ表示開始日時
      • DateTimepageEndDateイベントページ表示終了日時
      • DateTimeresultOpenDate結果発表日時
    • Object[]dramas投票対象の劇のリスト
      • Integerid劇 ID
      • Stringname劇名
      • Object[]roles投票対象の役のリスト
        • Integerid役 ID
        • Stringname役名

    イベント開催期間外には取得できません。

    GET /election/current 現在の投票状況の取得

    https://api.matsurihi.me/mltd/v1/election/current

    レスポンス(配列)

    • Integerid役 ID
    • Stringname役名
    • DateTimesummaryTime集計日時
    • Object[]dataランキングデータ
      • Integeridol_idアイドル ID
      • Stringidol_nameアイドル名
      • Integerscore得票数
      • Integerrank順位

    イベント開催期間外には取得できません。

    公開されていない順位のデータは取得できません。

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

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

    バージョン関連 API(version)

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

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

    レスポンス

    • Objectappアプリバージョンの情報
      • Stringversionバージョン名
      • DateTimeupdateTime強制アップデートされた日時
    • Objectresリソースバージョンの情報
      • Integerversionバージョン番号
      • DateTimeupdateTime配信日時

    デレぽ関連 API(derepo)

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

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

    パスパラメータ

    • Integer?id取得する投稿の ID

    クエリパラメータ

    • IntegeridolIdアイドルで絞り込み
    • IntegergroupIdグループで絞り込み
    • IntegerhashtagIdハッシュタグで絞り込み
    • DateTimetimeMax指定した日時より前の投稿のみ取得(指定日時を含まない)
    • DateTimetimeMin指定した日時以降の投稿のみ取得(指定日時を含む)
    • IntegermaxResults取得件数(1〜50、デフォルトは 10)
    • StringorderBy戻り値の順序(逆順)(postTime | id

    レスポンス(パスパラメータ省略時のみ配列)

    • Integerid投稿の ID
    • IntegergroupId投稿のグループ ID
    • IntegergroupOrder投稿グループ内での順序
    • IntegeridolId投稿したアイドルの ID
    • Stringname投稿時の名前
    • Stringmessage投稿内容
    • StringiconPath
    • String?imagePath
    • DateTimepostTime投稿日時
    • Object[]hashtagsハッシュタグ情報
      • Integeridハッシュタグの ID
      • Stringwordハッシュタグ

    パスパラメータを省略した場合には、複数の投稿の情報が返ります。

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

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

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

    レスポンス(配列)

    • Integeridハッシュタグの ID
    • Stringwordハッシュタグ