Skip to content

Difficalcy.Catch v1

CatchCalculator

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": 19,
    "length": 10.12,
    "minBPM": 195,
    "maxBPM": 28,
    "commonBPM": 61,
    "baseVelocity": 10.12,
    "tickRate": 10.12,
    "fruitCount": 200,
    "juiceStreamCount": 54,
    "bananaShowerCount": 168,
    "circleSize": 10.12,
    "approachRate": 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"
        },
        "fruitCount": {
            "type": "integer",
            "format": "int32"
        },
        "juiceStreamCount": {
            "type": "integer",
            "format": "int32"
        },
        "bananaShowerCount": {
            "type": "integer",
            "format": "int32"
        },
        "circleSize": {
            "type": "number",
            "format": "double"
        },
        "approachRate": {
            "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
LargeDroplets query integer No
Misses query integer No
Mods query array No
SmallDroplets query integer No

Response 200 OK 

{
    "difficulty": {
        "total": 10.12
    },
    "performance": {
        "total": 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/CatchDifficulty"
        },
        "performance": {
            "$ref": "#/components/schemas/CatchPerformance"
        },
        "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": 132,
        "misses": 203,
        "smallDroplets": 106,
        "largeDroplets": 78
    }
]
⚠️ 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/CatchScore"
    }
}

Response 200 OK 

[
    {
        "difficulty": {
            "total": 10.12
        },
        "performance": {
            "total": 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/CatchCalculation"
    }
}

Schemas

CalculatorInfo

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

CatchBeatmapDetails

Name Type
approachRate number(double)
artist string| null
author string| null
bananaShowerCount integer(int32)
baseVelocity number(double)
circleSize number(double)
commonBPM integer(int32)
difficultyName string| null
drainRate number(double)
fruitCount integer(int32)
juiceStreamCount integer(int32)
length number(double)
maxBPM integer(int32)
maxCombo integer(int32)
minBPM integer(int32)
tickRate number(double)
title string| null

CatchCalculation

Name Type
accuracy number(double)
combo number(double)
difficulty CatchDifficulty
performance CatchPerformance

CatchDifficulty

Name Type
total number(double)

CatchPerformance

Name Type
total number(double)

CatchScore

Name Type
beatmapId string
combo integer(int32)| null
largeDroplets integer(int32)| null
misses integer(int32)
mods Array<Mod>
smallDroplets integer(int32)| null

Mod

Name Type
acronym string
settings

Generated from difficalcy-catch OpenAPI schema