Uma Musume REST API (Fork)

Note: This is a fork of the original UmaMusumeAPI by SimpleSandman. The original project has been retired as of October 29th. This fork includes custom endpoints and modifications for personal use.

This is a community REST API based on Uma Musume: Pretty Derby's meta and master.mdb files that is read from a MariaDB database. This is based on the Swagger UI/OpenAPI specification. I'm using MariaDB instead of MySQL for the sake of keeping as much of this as open-source as possible.

The original loader app allows you to load the meta and master.mdb's data from the DMM version of this game into a MySQL/MariaDB database.

Custom Endpoints Added in This Fork

TerumiSimpleSkillData

A simplified skill data endpoint that provides parsed and human-readable skill information, including effect breakdowns and activation conditions.

Endpoints:

• GET /api/TerumiSimpleSkillData - Returns all skills
• GET /api/TerumiSimpleSkillData/{skillId} - Returns a specific skill by ID

Example Response:

{
  "skillId": 200162,
  "rarity": 1,
  "gradeValue": 50,
  "skillCategory": "Passive",
  "tagId": "601",
  "activationCondition": "ground_type==1",
  "precondition": "",
  "effects": [
    {
      "type": "Power Stat",
      "value": 40,
      "displayText": "Power +40"
    }
  ],
  "effectSummary": "Power +40",
  "iconId": 200162,
  "skillName": "Wet Conditions ○",
  "skillDesc": "Slightly increase power when on a muddy track.",
  "needSkillPoint": 50
}

How to Use:

# Get all skills
curl -X GET "http://localhost:5000/api/TerumiSimpleSkillData" -H "accept: application/json"

# Get specific skill by ID
curl -X GET "http://localhost:5000/api/TerumiSimpleSkillData/200162" -H "accept: application/json"

Fields Explained:

• skillCategory: Human-readable category (Passive, Active, Debuff, Recovery, Unique, Acceleration)
• effects: Array of parsed effects with type, numeric value, and display text
• effectSummary: Concatenated string of all effects (e.g., "Power +40 | Speed +20")
• needSkillPoint: Skill points required to learn (from single_mode_skill_need_point table)

Initial Setup

Under UmaMusumeAPI/Properties/launchSettings.json, set the MARIA_CONNECTION_STRING environment variable to your MariaDB database for "development" and on the hosting site's config variables section for "release".

Simplified launchSettings.json Example:

"profiles": {
  "IIS Express": {
    "environmentVariables": {
      "ASPNETCORE_ENVIRONMENT": "Development",
      "MARIA_CONNECTION_STRING": "user id=;password=;host=;database=;character set=utf8mb4"
    }
  }
}

Database Setup

Use the scripts in UmaMusumeAPI/SqlScripts to generate everything you need for the database. As mentioned before, if you want to load all of the data from the DMM version of this game, use my loader app and point the connection string to your new database.

Make sure the MariaDB database and all of its objects have the character set of utf8mb4 and collation of utf8mb4_general_ci as that is the official UTF-8 specification. There are not only so many articles on this topic, but the devs from the Pomelo.EntityFrameworkCore.MySql project recommends this personally and in this issue. I'm using their EF Core library to help scaffold the models and controllers since it's far more active and stable than the Oracle equivalent.

Scaffold Commands

In case if you need to scaffold anything, here are some commands that may be useful

Models and DbContext

This is a single-line command using the "Package Manager Console" in Visual Studio that allows you to generate ALL of the models and the DbContext class.

Scaffold-DbContext 'User Id=;Password=;Host=;Database=;Character Set=utf8mb4' Pomelo.EntityFrameworkCore.MySql -OutputDir Models -ContextDir Context

If you only need the model and context of a SINGLE table, here's the single-line command for that.

Scaffold-DbContext 'User Id=;Password=;Host=;Database=;Character Set=utf8mb4' Pomelo.EntityFrameworkCore.MySql -OutputDir Models -ContextDir Context -T <TABLE_NAME_HERE>