Skip to content

Difficalcy.Osu v1

OsuCalculator

GET /api/info

Response 200 OK 

{
    "rulesetName": "string",
    "calculatorName": "string",
    "calculatorPackage": "string",
    "calculatorVersion": "string",
    "calculatorUrl": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "rulesetName": {
            "type": "string",
            "nullable": true
        },
        "calculatorName": {
            "type": "string",
            "nullable": true
        },
        "calculatorPackage": {
            "type": "string",
            "nullable": true
        },
        "calculatorVersion": {
            "type": "string",
            "nullable": true
        },
        "calculatorUrl": {
            "type": "string",
            "nullable": true
        }
    },
    "additionalProperties": false
}

GET /api/calculation

Input parameters

Parameter In Type Default Nullable Description
BeatmapId query string No
Combo query integer No
Mehs query integer No
Misses query integer No
Mods query integer No
Oks query integer No

Response 200 OK 

{
    "difficulty": {
        "total": 10.12,
        "aim": 10.12,
        "speed": 10.12,
        "flashlight": 10.12
    },
    "performance": {
        "total": 10.12,
        "aim": 10.12,
        "speed": 10.12,
        "accuracy": 10.12,
        "flashlight": 10.12
    },
    "accuracy": 10.12,
    "combo": 10.12
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "difficulty": {
            "$ref": "#/components/schemas/OsuDifficulty"
        },
        "performance": {
            "$ref": "#/components/schemas/OsuPerformance"
        },
        "accuracy": {
            "type": "number",
            "format": "double"
        },
        "combo": {
            "type": "number",
            "format": "double"
        }
    },
    "additionalProperties": false
}

POST /api/batch/calculation

Request body

[
    {
        "beatmapId": "string",
        "mods": 245,
        "combo": 167,
        "misses": 59,
        "mehs": 21,
        "oks": 292
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/OsuScore"
    }
}

Response 200 OK 

[
    {
        "difficulty": {
            "total": 10.12,
            "aim": 10.12,
            "speed": 10.12,
            "flashlight": 10.12
        },
        "performance": {
            "total": 10.12,
            "aim": 10.12,
            "speed": 10.12,
            "accuracy": 10.12,
            "flashlight": 10.12
        },
        "accuracy": 10.12,
        "combo": 10.12
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/OsuCalculation"
    }
}

Schemas

CalculatorInfo

Name Type
calculatorName string| null
calculatorPackage string| null
calculatorUrl string| null
calculatorVersion string| null
rulesetName string| null

OsuCalculation

Name Type
accuracy number(double)
combo number(double)
difficulty OsuDifficulty
performance OsuPerformance

OsuDifficulty

Name Type
aim number(double)
flashlight number(double)
speed number(double)
total number(double)

OsuPerformance

Name Type
accuracy number(double)
aim number(double)
flashlight number(double)
speed number(double)
total number(double)

OsuScore

Name Type
beatmapId string
combo integer(int32)| null
mehs integer(int32)
misses integer(int32)
mods integer(int32)
oks integer(int32)

Generated from difficalcy-osu OpenAPI schema