OpenMLBB SDK Docs

OpenMLBB Endpoint

SDK call mapping, request requirements, and Python example.

Every card documents the SDK call from OpenMLBB and mirrors API path/query/body requirements.

GET Hero Catalog

/openmlbb/academy/heroes/catalog

Open Only This

API Path: /api/academy/heroes/catalog

Supports query parameters for pagination and localization.

Query parameters:

  • size: Number of items per page (minimum: 1).
  • index: Page index (starting from 1).
  • lang: Language code for localized content (default: en).

The response includes hero catalog data:

  • records: Array of hero entries, each containing:
      • data:
          • head: Hero portrait image URL.
          • head_big: Larger hero portrait image URL.
          • painting: Hero splash art image URL.
          • hero:
              • data:
                  • name: Hero name.
                  • roadsort: Lane assignment metadata:
                      • _id: Unique identifier.
                      • caption: Lane caption (localized).
                      • configId: Configuration ID.
                      • createdAt: Creation timestamp.
                      • createdUser: Creator username.
                      • data:
                          • road_sort_icon: Lane icon URL.
                          • road_sort_id: Lane ID.
                          • road_sort_title: Lane title (e.g., Roam).
                      • updatedAt: Last update timestamp.
                      • updatedUser: Last updater username.
          • hero_id: Unique hero identifier.

This endpoint is useful for:

  • Displaying hero collections.
  • Browsing available heroes.
  • Analyzing basic hero attributes.

Python Example

from OpenMLBB import OpenMLBB

client = OpenMLBB()
response = client.academy.heroes_catalog(size=20, index=1, lang="en")
print(response)

Path and Query Parameters

Name In Type Required Default
size query integer no 20
index query integer no 1
lang query string no en