API Reference

errors

Classes:

• AlgoScrewedUpMassivelyError –

  Raised when something goes wrong on the server side.

• AssetDownloadError –

  Raised when an asset fail to download.

• EnkaAPIError –

  Base exception class for Enka API.

• EnkaPyError –

  Base exception class for enka.py.

• GameMaintenanceError –

  Raised when the game is under maintenance.

• GeneralServerError –

  Raised when a general server error occurs.

• InvalidItemTypeError –

  Raised when the item type is invalid.

• PlayerDoesNotExistError –

  Raised when the player does not exist.

• RateLimitedError –

  Raised when the API rate limit is exceeded.

• WrongUIDFormatError –

  Raised when the UID format is incorrect.

Functions:

• raise_for_retcode –

  Raises an exception based on the retcode.

APIRequestTimeoutError

Raised when an API request times out.

AlgoScrewedUpMassivelyError

Raised when something goes wrong on the server side.

AssetDownloadError

Raised when an asset fail to download.

Attributes:

• status –
• url –

status instance-attribute

status = status

url instance-attribute

url = url

AssetKeyError

Raised when the asset key is not found.

Attributes:

• cls –
• key –

cls instance-attribute

cls = cls

key instance-attribute

key = key

EnkaAPIError

Base exception class for Enka API.

EnkaPyError

Base exception class for enka.py.

GameMaintenanceError

Raised when the game is under maintenance.

GatewayTimeoutError

Raised when a gateway timeout occurs.

GeneralServerError

Raised when a general server error occurs.

InvalidItemTypeError

Raised when the item type is invalid.

PlayerDoesNotExistError

Raised when the player does not exist.

RateLimitedError

Raised when the API rate limit is exceeded.

WrongUIDFormatError

Raised when the UID format is incorrect.

raise_for_retcode

raise_for_retcode(retcode: int) -> None

Raises an exception based on the retcode.