Client
Bases: HTTPClient
Asynchronous client for interacting with api.iapetus.me
Usage Example
achievement(achievement_text) async ¶
Generate an image for a Minecraft achievement.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
achievement_text | str | The name of the achievement to display (must be 1 to 30 characters). | required |
Returns:
| Name | Type | Description |
|---|---|---|
BytesIO | BytesIO | A byte-stream object containing the achievement image. |
Raises:
| Type | Description |
|---|---|
BadTextFormation | If the achievement text is not within the 1-30 character limit. |
Usage Example
Achievement Image Example

Source code in minecraftstatus/client.py
get_server(ip_address) async ¶
Retrieve the status of a Minecraft server.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
ip_address | str | The IP address or hostname of the Minecraft server. | required |
Returns:
| Name | Type | Description |
|---|---|---|
ServerStatus | ServerStatus | An instance containing the server's status details. |
Raises:
| Type | Description |
|---|---|
ServerNotFound | If the server is not found or is offline. |
Usage Example
Source code in minecraftstatus/client.py
get_server_card(ip_address, custom_server_name=None) async ¶
Generate a server card image for a Minecraft server.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
ip_address | str | The IP address or hostname of the Minecraft server. | required |
custom_server_name | str | Custom name to be displayed on the server card. Defaults to the provided IP address if not specified. | None |
Returns:
| Name | Type | Description |
|---|---|---|
BytesIO | BytesIO | A byte-stream object containing the server card image. |
Raises:
| Type | Description |
|---|---|
BadTextFormation | If the provided text is not between 1 and 30 characters. |
Usage Example
Server Card Example

Source code in minecraftstatus/client.py
splash_text(text) async ¶
Generate a splash text image for Minecraft.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
text | str | The text to display (must be between 1 and 30 characters). | required |
Returns:
| Name | Type | Description |
|---|---|---|
BytesIO | BytesIO | A byte-stream object containing the splash text image. |
Raises:
| Type | Description |
|---|---|
BadTextFormation | If the text does not meet the required length. |
Usage Example
Splash Text Example
