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 Recommended Content

/openmlbb/academy/recommended

Open Only This

API Path: /api/academy/recommended

List recommended content for players. Supports query parameters for pagination, sorting, and localization.

Query parameters:

  • size: Number of items per page (minimum: 1).
  • index: Page index (starting from 1).
  • order: Sort order for results. Allowed values: asc, desc.
  • lang: Language code for localized content (default: en).

The response includes recommended content data:

  • records: Array of recommended entries, each containing:
      • createdAt: Creation timestamp.
      • updatedAt: Last update timestamp.
      • data:
          • channels: Content channels (e.g., 'UGC', 'recommend').
          • type: Content type (e.g., 'ugc_hero').
          • state: Content state (e.g., 'release').
          • data:
              • hero: Hero metadata including:
                  • hero_id: Hero ID.
                  • hero_lane: Lane assignment.
                  • hero_overview: Overview description.
                  • hero_strength: Strengths.
                  • hero_weakness: Weaknesses.
                  • hero_tags: Array of tag IDs.
              • equips: Recommended equipment builds.
              • emblems: Recommended emblem sets.
              • spell: Recommended battle spell.
              • cooperates: Cooperative hero synergies.
              • counters: Counter heroes.
              • dominants: Dominant strategies or tips.
              • recommend: General recommendation notes.
              • snapshot: Snapshot image URL.
              • game_version: Version reference.
              • language: Content language.
              • pages: Content sections (e.g., 'hero', 'spell', 'equip').
              • title: Guide or build title.
          • user: Author metadata including:
              • name: Author name.
              • avatar: Author avatar URL.
              • level: Author level.
              • roleId: Role ID.
              • zoneId: Zone ID.
          • dynamic: Engagement metrics:
              • views: Total views.
              • votes: Total votes.
              • hot: Hotness score.
              • views_by_4h_total_24h: Views in last 24h.
          • vote_all: Voting metadata:
              • average: Average rating.
              • count: Vote count.
              • total: Total votes.
              • user_count: Number of users voted.
              • vote: Vote ID reference.

This endpoint is useful for:

  • Surfacing community guides and builds.
  • Providing personalized hero strategies.
  • Highlighting cooperative and counter hero recommendations.
  • Guiding players with contextual tips and strategic insights.

Python Example

from OpenMLBB import OpenMLBB

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

Path and Query Parameters

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