GET Equipment (Items)
/openmlbb/academy/equipment
API Path: /api/academy/equipment
List all equipment (items). 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 equipment data:
- records: Array of equipment entries, each containing:
- _id: Unique record identifier.
- _createdAt: Creation timestamp.
- _updatedAt: Last update timestamp.
- data:
- equipid: Equipment ID.
- equipname: Equipment name (e.g., 'Bud of Hope').
- equipicon: Equipment icon URL.
- id: Internal record ID.
- sourceId: Source reference ID.
This endpoint is useful for:
- Displaying the full equipment catalog.
- Browsing available items.
- Analyzing basic item attributes.
Python Example
from OpenMLBB import OpenMLBB
client = OpenMLBB()
response = client.academy.equipment(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 |