Cinderella API [ @imcgborder REST API ]

まだまだあるはずよ、いっしょにできること!Orange Sapphire

デレマスボーダーbotの情報を利用したい開発者のための API を提供しています。

※現在、この API は β 版です。どの I/F も予告なく変更される可能性があります。

共通仕様

  1. JSON 形式のみ対応しています。デフォルトで整形された JSON を提供します。特に必要でない限り整形状態での取得を推奨します。非整形の状態で要求する場合は pretty=false をクエリーとして付与してください。
  2. 成否の判断は常に HTTP ステータスコードで返却されます。 200 以外の返却はすべてエラーです。
  3. 利用時は必ずステータスコードを参照して適切なエラーハンドリングを実装してください。 4xx または 5xx を返却したにもかかわらず継続してアクセスした場合、すべての要求が拒否されるようになることがあります。
  4. パラメータの型に ? が付与されているものは任意値を表します。レスポンスにおける ? はその型が nullable であることを表します。ただし、string は常に nullable です。
  5. パラメータの型に [] が付与されているものは配列(複数値指定)を表します。パラメータでは半角カンマ (,) 区切りで付与してください。
  6. DateTime 型は ISO8601 拡張形式 (2019-05-26T18:25:07) で記載してください。タイムゾーン +09:00 は付与しないでください。時間は原則として JST で認識されます。
  7. Request の Header に Origin が付与されている場合、Response に Access-Control-Allow-Origin: * が付加されます。
  8. パラメータに破壊的変更が入った場合は URL のバージョンを変更する予定です(保証はしません)。送受信いずれのパラメータも、項目追加は破壊的変更に含みません。

イベントIDの考え方

デレマスボーダーbotは、総合ランキングと中間ランキングを表現するため、独自の ID 体系(内部ID)を持っています。

モバゲーイベントID
(MobageEventId)
イベント名 イベント基本ID
(EventInfoId)
イベント明細ID
(EventDetailId)
種別
1224 目指せオトナのバレンタイン
アイドルチャレンジ
203 262 総合
263 中間

IDは「イベント情報」で取得してください。パラメータ指定時は、イベント基本IDまたはイベント明細IDでの問い合わせが必要な場合があります。

利用規定 (留意事項)

  1. Cinderella API を利用して公開サービスを作成・運用する場合は、その取得元がデレマスボーダーbot(@imcgborder)であることを明記してください。
  2. API の動作状況や送信内容にかかわらず、API を利用したサービスの利用者からの問い合わせがデレマスボーダーbotに直接送られることがないよう明示的に記載しなければなりません。問い合わせは必ず API を利用されるサービス側で集約し、必要に応じて Twitter:@imcgborder へ連絡をお願いします。
  3. 特定のプロデューサーの晒し上げや、特定アイドルを担当している方が不快になる可能性のある用途において、データを利用することはご遠慮ください。
  4. 上記に記載のない内容は、デレマスボーダーbotの利用規定に準じます。(無保証です)

イベント情報 [GET] /api/v1/events/[mobageEventId?]

ex.
https://imcg.pink-check.school/api/v1/events/
https://imcg.pink-check.school/api/v1/events/1224

パスパラメータ

  • int? mobageEventId モバゲーイベントID

クエリパラメータ

  • int eventInfoId イベント基本情報ID(mobageEventIdと同時指定不可)
  • string search イベント名(部分一致)
  • int eventTypeId イベント種別ID※
  • DateTime time 指定された時間に開催中のイベントを取得(EventDetailId単位で絞り込みが行われます)

レスポンスデータ

  • object[] Key(int) モバゲーイベントID
    • int eventInfoId イベント基本情報ID
    • string name イベント名
    • string mobageEventId モバゲーイベントID
    • int eventTypeId イベント種別ID
    • string eventTypeName イベント種別名
    • object details イベント明細 (key: イベント明細ID、value: イベント明細情報)
      • int eventDetailId イベント明細ID
      • int sequence シーケンス
      • string eventDetailTypeId イベント明細種別ID (総合ランキング: 1、中間ランキング: 2、独立中間ランキング※: 3)
      • int explanation 明細説明
      • DateTime beginDateTime イベント開始日時
      • DateTime endDateTime イベント終了日時
      • DateTime finalRankingDateTime ランキング公開日時
      • string cardHash 上位報酬カードハッシュ
      • string cardName 上位報酬カード名
      • int? take2CardRank 2枚取りの最低順位
      • int? take1CardRank 1枚取りの最低順位
      • int? orgRewardRankingTypeId 団体上位報酬の入賞種別(プロダクション: 2、ミニチーム: 3、なし: 0)
      • int? orgRewardBorderRank 団体入賞報酬がもらえる団体の順位
      • int? orgRewardMembers 団体の最大構成人数
      • string remark 備考

備考

  • 独立中間ランキングは、総合ランキングと開始時点が異なる中間イベント(代表的なものは3rdアニバーサリー以降の中間ランキング)を示します。
  • イベント種別IDは以下のとおりです。
    ツアー(旧方式): 1、アイプロ: 2、ドリフェス: 3、アイバラ: 4、ぷちコレ: 5、フェス: 6、アイチャレ: 7、アイロワ: 8、TBS: 9、フェスS: 10、アニバアイプロ: 11、ツアーカーニバル: 12、TBSオールスターSP: 13

イベント順位情報 [GET] /api/v1/eventdetails/[eventDetailId]/rankings

ex. https://imcg.pink-check.school/api/v1/eventdetails/262/rankings

パスパラメータ

  • int eventDetailId イベント明細ID

クエリパラメータ

  • int[] ranks 取得対象順位(100件まで指定可能。all/targetId と同時指定不可)
  • bool all 全順位取得(未指定または false 指定時は100位、200位、2000位などの基準順位のみ。ranks/targetId と同時指定不可)
  • int[] targetId 取得対象のモバゲーIDまたはプロダクションID(100件まで指定可能。ranks/all と同時指定不可)
  • int rankingTypeId イベント順位種別ID(プロデューサー: 1、プロダクション: 2、ミニチーム: 3。ranks/targetId 指定時は必須)
  • DateTime time 対象観測日時(10分毎に指定可、ranks/all/targetId 指定時は毎時0分のみ指定可)

レスポンスデータ

  • object[] Key(DateTime) 観測日時
    • int rank 順位
    • int rankingTypeId イベント順位種別ID
    • long? point イベントpt
    • string name ユーザ・プロダクション名
    • string leaderCardHash リーダーカードハッシュ

備考

  • all 指定時に time を指定していない場合、直近の0分の情報が取得されます。
  • 更新されるタイミングは、基準順位は10分毎の更新後1分以内、それ以外の順位は6分以内が目処です。通常よりモバゲー側が応答に時間を要しているなどの場合、基準順位以外の更新をしない(取得をやめる)ことがあります。
  • TBSなどの受取ptがあるイベントの場合、ラウンド最終時刻は取得を20分遅延させます。
  • 中間・最終ランキングの種別にかかわらず、イベント終了時刻のスコア取得は最終ランキング公開日時に実行されます。また、プロデューサーおよびプロダクションの全順位はイベント終了後36時間後に取得されます。

プロデューサー検索 [GET] /api/v1/producers

ex. https://imcg.pink-check.school/api/v1/producers?search=C

クエリパラメータ(省略時は全量取得となります)

  • string search ユーザ名(前方一致検索)またはモバゲーID(完全一致)/productionIdとの同時指定不可
  • int productionId プロダクションID/searchとの同時指定不可

レスポンスデータ

  • object[] Key(int) モバゲーID
    • int mobageId モバゲーID
    • int? productionId 所属プロダクションID
    • string productionName 所属プロダクション名
    • string unitName ユニット名
    • int? katagakiId 肩書ID
    • string producerName プロデューサー名
    • int producerRank プロデューサーランク(S10ランク: 16 ~ Fランク: 1)
    • long fans ファン数
    • string leaderHash リーダーアイドルハッシュ
    • int level レベル
    • string classification 属性(Cute/Cool/Passion)
    • int battle LIVEバトル回数
    • int victory LIVEバトル勝利数
    • int album アルバム写真数
    • int shinaiMax 親愛度MAX人数
    • string favorite1Hash ホシイモノ1
    • string favorite2Hash ホシイモノ2
    • string favorite3Hash ホシイモノ3

※ホシイモノ1~3は、設定されているものがアイドルの場合のみ表示されます。スタドリなどのアイテムの場合は空白となります。

プロデューサー明細情報 [GET] /api/v1/producers/[mobageId]

ex. https://imcg.pink-check.school/api/v1/producers/62160821

パスパラメータ

  • int mobageId モバゲーID

レスポンスデータ

  • object[] Key(int) イベント明細ID
    • int eventDetailId イベント明細ID
    • string eventName イベント名
    • DateTime eventEndDateTime イベント終了日時
    • int? eventRank イベント最終順位
    • long? eventPoint イベント最終pt
    • int? mobageId モバゲーID
    • int? productionId 所属プロダクションID
    • string productionName 所属プロダクション名
    • string unitName ユニット名
    • int? katagakiId 肩書ID
    • string producerName プロデューサー名
    • int? producerRank プロデューサーランク(S10ランク: 16 ~ Fランク: 1)
    • long? fans ファン数
    • string leaderHash リーダーアイドルハッシュ
    • int? level レベル
    • string classification 属性(Cute/Cool/Passion)
    • int? battle LIVEバトル回数
    • int? victory LIVEバトル勝利数
    • int? album アルバム写真数
    • int? shinaiMax 親愛度MAX人数
    • string favorite1Hash ホシイモノ1カードハッシュ
    • string favorite1Name ホシイモノ1カード名
    • string favorite2Hash ホシイモノ2カードハッシュ
    • string favorite2Name ホシイモノ2カード名
    • string favorite3Hash ホシイモノ3カードハッシュ
    • string favorite3Name ホシイモノ3カード名

※現在開催中の順位・スコアは表示されません。

※ホシイモノ1~3は、設定されているものがアイドルの場合のみ表示されます。スタドリなどのアイテムの場合は空白となります。

プロダクション検索 [GET] /api/v1/productions

ex. https://imcg.pink-check.school/api/v1/productions?search=A

クエリパラメータ(省略時は全量取得となります)

  • string search プロダクション名(前方一致検索)またはモバゲーID(完全一致)

レスポンスデータ

  • object[] Key(int) プロダクションID
    • int? productionId プロダクションID
    • string productionName プロダクション名
    • int productionRank プロダクションランク(S5ランク: 11 ~ Fランク: 1)
    • long fans ファン数
    • int level レベル
    • int development 発展度
    • long development 増資マニー
    • int representProducerId 代表プロデューサーID
    • string representProducerName 代表プロデューサー名
    • int members 社員数
    • bool esthe エステルーム
    • bool cafe カフェテラス
    • bool sauna サウナルーム
    • string comment コメント

プロダクション明細情報 [GET] /api/v1/productions/[productionId]

ex. https://imcg.pink-check.school/api/v1/productions/309761

パスパラメータ

  • int productionId プロダクションID

レスポンスデータ

  • object[] Key(int) イベント明細ID
    • int eventDetailId イベント明細ID
    • string eventName イベント名
    • DateTime eventEndDateTime イベント終了日時
    • int? eventRank イベント最終順位
    • long? eventPoint イベント最終pt
    • int? productionId プロダクションID
    • string productionName プロダクション名
    • int? productionRank プロダクションランク(S5ランク: 11 ~ Fランク: 1)
    • long? fans ファン数
    • int? level レベル
    • int? development 発展度
    • long? money 増資マニー
    • int? representProducerId 代表プロデューサーID
    • string representProducerName 代表プロデューサー名
    • int? members 社員数
    • bool? esthe エステルーム
    • bool? cafe カフェテラス
    • bool? sauna サウナルーム
    • string comment コメント

※ミニチームイベントの情報は出力されません。

アイドル [GET] /api/v1/idol

ex. https://imcg.pink-check.school/api/v1/idol?classification=Cute

クエリパラメータ(省略時は全量取得となります)

  • string name アイドル名または「よみ」(部分一致検索)
  • string classification 属性(Cute/Cool/Passion)

レスポンスデータ

  • object[] - -
    • int idolId アイドルID (ボーダーbot内部ID)
    • string name アイドル名
    • string yomi 読み方(ひらがな)
    • string classification 属性(Cute/Cool/Passion)
    • int birthdayMonth 誕生日(月)
    • int birthdayDate 誕生日(日)
    • int age 年齢
    • string constellation 星座
    • string bloodGroup 血液型
    • string handedness 利き手
    • string originPlace 出生地
    • string hobby 趣味
    • string characterVoice 声優

カード [GET] /api/v1/card/[cardHash?]

ex.
https://imcg.pink-check.school/api/v1/card/abbe52ff16730a445dd85e701907925c
https://imcg.pink-check.school/api/v1/card?classification=Cute

パスパラメータ(クエリパラメータと併せ、省略時は全量取得となります)

  • string hash カードハッシュ (32桁)

クエリパラメータ(パスパラメータと併せ、省略時は全量取得となります)

  • string name カード名またはアイドルの「よみ」(部分一致検索)
  • string classification 属性(Cute/Cool/Passion)

レスポンスデータ

  • object[] - -
    • string hash カードハッシュ
    • int cardMobageId カードID (Mobage上でのカードID)
    • string cardName カード名
    • string rality レアリティ
    • bool isPlus 特訓後の場合 true
    • int idolId アイドルID (ボーダーbot内部ID)
    • string idolName アイドル名
    • string idolYomi アイドル名の読み方(ひらがな)
    • string classification 属性(Cute/Cool/Passion)
    • int cost コスト
    • string abilityName 特技名
    • string abilityEffect 特技効果
    • int birthdayMonth 誕生日(月)
    • int birthdayDate 誕生日(日)
    • int age 年齢
    • string constellation 星座
    • string bloodGroup 血液型
    • string handedness 利き手
    • string originPlace 出生地
    • string hobby 趣味
    • string characterVoice 声優
    • string height 身長
    • string weight 体重
    • string bustSize バストサイズ
    • string waistSize ウエストサイズ
    • string hipSize ヒップサイズ

※登録直後のカードは取得できないことがあります。

※現在開催中のイベントの上位報酬SRは取得できません。(配布後に登録されます)

道場 [GET] /api/v1/dojo

ex. https://imcg.pink-check.school/api/v1/dojo?minLevel=350

クエリパラメータ(省略時は全量取得となります)

  • int? minLevel 最低レベル(280~400)
  • int? maxLevel 最高レベル(280~400)
  • int? minRank 最低プロデューサーランク(S10ランク: 16 ~ Fランク: 1)
  • int? maxRank 最高プロデューサーランク(S10ランク: 16 ~ Fランク: 1)
  • bool? onlyActive 営業中と思われる道場のみを表示(省略時 true

レスポンスデータ

  • object[] - -
    • int mobageId モバゲーID
    • int dojoStatusId 道場ステータスID(営業中:10、休業:80、廃業:90
    • DateTime registDateTime 道場登録日時
    • DateTime lastUpdate 最終更新日時
    • int level レベル
    • int producerRank プロデューサーランク(S10ランク: 16 ~ Fランク: 1)
    • string producerName プロデューサー名
    • int productionId プロダクションモバゲーID
    • string productionName プロダクション名
    • string leaderCardHash リーダーアイドルハッシュ
    • string leaderCardName リーダーアイドル名
    • int? defaultDefence リーダーアイドル初期守
    • string unitName ユニット名
    • string comment コメント

※レベル280未満の道場はボーダーbotでは取り扱いません。

※道場のクロール間隔期待値は通常18時間毎です。ただし、イベントの終了後(通常23時)からイベント最終結果発表の36時間後までの間は、最終結果取得処理を優先するためクロールが行われません。

dojoStatusIdはユニット名またはコメントに「休業」「おやすみ」などの文言が含まれていると休業と判定されます。