The MSBT API runs on FastAPI and its URL is always https://msbt.lukiuwu.xyz/api.

Any third-party links are not MSBT APIs and we are not responsible for them.

Usage Guidelines

All interactions with the MSBT API should be conducted over HTTPS to ensure secure communication. When utilizing the API, it's critical to authenticate requests appropriately if required. Ensure to check for rate limits and handle any errors gracefully in your application.

Sample Request

Here is an example of how to make a request to the MSBT API:

import requests

url = 'https://msbt.lukiuwu.xyz/api/example'
response = requests.get(url)
data = response.json()
print(data)

Error Handling

When working with the MSBT API, you may encounter several types of errors. It's important to implement robust error handling mechanisms:

• 4xx Errors: Client-side issues, such as authentication problems or invalid parameters.

• 5xx Errors: Server-side issues that may require retry logic or support contact.

Additional Considerations

• Always refer to the latest API documentation to stay updated with any changes.

• Avoid hardcoding values; consider using environment variables for sensitive information.

This documentation contains all the API points that MSBT uses.

This is done in order to show the user that the application does not access third-party APIs and everything is used exclusively on MSBT servers.

Request

To access the blacklist of non-game programs, perform a GET request to the following endpoint:

GET https://msbt.lukiuwu.xyz/api/blacklist

Response

In this context, a GET request is used to retrieve data from a specific URL endpoint. When accessing the specified endpoint, you will receive a JSON array in response. Each element within this JSON array is another array containing the name of a program that has been blacklisted. Typically, these programs are non-game related and have been blocked from use for specific reasons. The example illustrates how program names are structured within the response.

Example

The response to the request will look like this:

[
    [
        "ExampleProgram1" - game name
    ],
    [
        "ExampleProgram2"
    ]
]

Request

To access the gamesdetect list, make a GET request to the following endpoint:

GET https://msbt.lukiuwu.xyz/api/gamesdetect

Response

Explanation

The response from the GET request to the endpoint /api/gamesdetect returns a JSON array containing information about various software applications. Each object in the array provides details about a specific program, such as its executables, icon hash, and unique identifier (id). Additional attributes include whether the application supports in-game overlays (overlay), its associated themes, and whether it requires a hook for special handling. This API is used to identify programs that should not be categorized as games despite their executable names.

This is just a mirror of the Discord API https://discord.com/api/applications/detectable. It is not used yet.

Example

The response to the request will look like this:

[
  {
    "aliases": [],
    "executables": [
      {
        "is_launcher": false,
        "name": "speedrunners.exe",
        "os": "win32"
      }
    ],
    "hook": true,
    "icon_hash": "cb48279ea90e86fb4f71c709d3236395",
    "id": "259392830932254721",
    "name": "SpeedRunners",
    "overlay": false,
    "overlay_compatibility_hook": false,
    "overlay_methods": null,
    "overlay_warn": false,
    "themes": [
      "Action",
      "Party"
    ]
  }
]

Request

To access the whitelist of game, perform a GET request to the following endpoint:

GET https://msbt.lukiuwu.xyz/api/whitelist

Response

The response from the API provides a list of whitelisted game programs and details for each one. Below are the key components explained:

• Games Name: The identifier or title of the game covered in the whitelist.

• Save Path: This is the file system location where the game's save data is located, using environment variables for flexibility on different systems.

• Mod Path: Specifies where user-created modifications for the game are stored, indicating customization areas.

• Add Path: Designates storage for additional files that are not native game mods but are relevant, such as game boosters or extensions.

• Special Backup Mark: A binary indicator (0 or 1) showing whether special actions are needed for backing up game data, helping manage data safety efficiently.

Example

The response to the request will look like this:

[
  [
    "ExampleProgram1", - game name
    "%userprofile%\\Documents\\My Games\\ExampleProgram1\\", - save path
    "%userprofile%\\Documents\\My Mods\\ExampleProgram1\\", - mod path
    "%userprofile%\\Documents\\My Add\\ExampleProgram1\\", - add path
    0 - specialbackup mark],
  [
    "ExampleProgram2",
    "%userprofile%\\Documents\\My Games\\ExampleProgram2\\",
    "%userprofile%\\Documents\\My Mods\\ExampleProgram2\\",
    "%userprofile%\\Documents\\My Add\\ExampleProgram2\\",
    0]
]