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/beatmapdetails

Input parameters

Parameter In Type Default Nullable Description
beatmapId query string No

Response 200 OK 

{
    "artist": "string",
    "title": "string",
    "difficultyName": "string",
    "author": "string",
    "maxCombo": 219,
    "length": 10.12,
    "minBPM": 293,
    "maxBPM": 253,
    "commonBPM": 134,
    "baseVelocity": 10.12,
    "tickRate": 10.12,
    "circleCount": 173,
    "sliderCount": 287,
    "spinnerCount": 16,
    "sliderTickCount": 117,
    "circleSize": 10.12,
    "approachRate": 10.12,
    "accuracy": 10.12,
    "drainRate": 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": {
        "artist": {
            "type": "string",
            "nullable": true
        },
        "title": {
            "type": "string",
            "nullable": true
        },
        "difficultyName": {
            "type": "string",
            "nullable": true
        },
        "author": {
            "type": "string",
            "nullable": true
        },
        "maxCombo": {
            "type": "integer",
            "format": "int32"
        },
        "length": {
            "type": "number",
            "format": "double"
        },
        "minBPM": {
            "type": "integer",
            "format": "int32"
        },
        "maxBPM": {
            "type": "integer",
            "format": "int32"
        },
        "commonBPM": {
            "type": "integer",
            "format": "int32"
        },
        "baseVelocity": {
            "type": "number",
            "format": "double"
        },
        "tickRate": {
            "type": "number",
            "format": "double"
        },
        "circleCount": {
            "type": "integer",
            "format": "int32"
        },
        "sliderCount": {
            "type": "integer",
            "format": "int32"
        },
        "spinnerCount": {
            "type": "integer",
            "format": "int32"
        },
        "sliderTickCount": {
            "type": "integer",
            "format": "int32"
        },
        "circleSize": {
            "type": "number",
            "format": "double"
        },
        "approachRate": {
            "type": "number",
            "format": "double"
        },
        "accuracy": {
            "type": "number",
            "format": "double"
        },
        "drainRate": {
            "type": "number",
            "format": "double"
        }
    },
    "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 array No
Oks query integer No
SliderTails query integer No
SliderTicks 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": [
            {
                "acronym": "string",
                "settings": {}
            }
        ],
        "combo": 166,
        "misses": 44,
        "mehs": 105,
        "oks": 162,
        "sliderTails": 148,
        "sliderTicks": 48
    }
]
⚠️ 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

Mod

Name Type
acronym string
settings

OsuBeatmapDetails

Name Type
accuracy number(double)
approachRate number(double)
artist string| null
author string| null
baseVelocity number(double)
circleCount integer(int32)
circleSize number(double)
commonBPM integer(int32)
difficultyName string| null
drainRate number(double)
length number(double)
maxBPM integer(int32)
maxCombo integer(int32)
minBPM integer(int32)
sliderCount integer(int32)
sliderTickCount integer(int32)
spinnerCount integer(int32)
tickRate number(double)
title 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 Array<Mod>
oks integer(int32)
sliderTails integer(int32)| null
sliderTicks integer(int32)| null

Generated from difficalcy-osu OpenAPI schema