APIError

exception xbrl_filings_api.APIError

Bases: FilingsAPIError, APIObject

Error returned by the underlying API.

See also

xbrl_filings_api.exceptions

The module for all other exceptions.

title: str | None

Title of the error.

detail: str | None

Details of the error.

code: str | None

Code of the error.

api_status: str | None

HTTP status code according to the JSON document.

status: int

HTTP status code of the HTTP reponse.

status_text: str | None

HTTP status code description of the reponse.

__repr__()

Return repr with title, detail, and code.

Return type:

str

__str__()

Return “[<title> ][ | <detail>][ (<code>)]”.

If only code is defined, return “Code: <code>”. If none of the three is defined, return empty string.

Return type:

str