Errors

In case of an error reponse from the Hyperliquid REST API the following errors may be raised.

hl.errors

Classes:

Name	Description
ApiError	Base class for API errors.
HttpError	HTTP-level failures (network issues, 4xx, 5xx responses).
NotFoundError	Expected data was not found.
StatusError	Status field has unexpected value.
UnexpectedSchemaError	The API returned an unexpected schema.

Attributes:

Name	Type	Description
__all__

__all__ module-attribute

__all__ = [
    "ApiError",
    "HttpError",
    "NotFoundError",
    "UnexpectedSchemaError",
    "StatusError",
]

ApiError

ApiError(message: str, body: Any = None)

Bases: Exception

Base class for API errors.

Parameters:

Name	Type	Description	Default
message	str	The error message.	required
body	Any	The response body, if available.	None

HttpError

HttpError(
    *,
    message: str,
    status_code: int,
    headers: dict[str, str] | None = None,
    body: Any = None,
    error_code: str | None = None,
    error_message: str | None = None,
    error_data: Any | None = None,
)

Bases: ApiError

HTTP-level failures (network issues, 4xx, 5xx responses).

Attributes:

Name	Type	Description
message	str	Error message
status_code	int	HTTP status code
headers	dict[str, str]	HTTP headers
body	Any | None	Error response body, if available
error_code	str | None	Error code from the response, if available
error_message	str | None	Error message from the response, if available
error_data	Any | None	Error data from the response, if available

Parameters:

Name	Type	Description	Default
message	str	Error message	required
status_code	int	HTTP status code	required
headers	dict[str, str] | None	HTTP headers	None
body	Any	Error response body, if available	None
error_code	str | None	Error code from the response, if available	None
error_message	str | None	Error message from the response, if available	None
error_data	Any | None	Error data from the response, if available	None

NotFoundError

NotFoundError(*, message: str)

Bases: ApiError

Expected data was not found.

Parameters:

Name	Type	Description	Default
message	str	The error message.	required

StatusError

StatusError(
    *,
    message: str,
    expected: str,
    actual: str,
    body: Any = None,
)

Bases: ApiError

Status field has unexpected value.

For example, "err" instead of "ok" or "unknownOid" instead of "order".

Attributes:

Name	Type	Description
message	str	Error message
expected	str	The expected status value
actual	str	The actual status value received
body	Any | None	The response body

Parameters:

Name	Type	Description	Default
message	str	The error message.	required
expected	str	The expected status value.	required
actual	str	The actual status value received.	required
body	Any	The response body.	None

UnexpectedSchemaError

UnexpectedSchemaError(*, message: str, body: Any)

Bases: ApiError

The API returned an unexpected schema.

For example, the body may contain a list when a dict was expected.

Parameters:

Name	Type	Description	Default
message	str	The error message.	required
body	Any	The body of the response.	required