APIPage

class xbrl_filings_api.APIPage

Bases: APIObject

Base class for JSON:API response page or document.

Methods

__hash__()	Return hash(self).
__repr__()	Return repr(self).
__str__()	Return str(self).

Attributes

api_self_url	URL to this APIPage.
api_prev_page_url	URL to previous APIPage in the query.
api_next_page_url	URL to next APIPage in the query.
api_first_page_url	URL to first APIPage in the query.
api_last_page_url	URL to last APIPage in the query.
jsonapi_version	Version of the JSON-API protocol used on this APIPage.
query_time	Time when the query function was called for an APIObject.
request_url	HTTP request URL for an APIObject.

api_self_url: str | None

URL to this APIPage.

api_prev_page_url: str | None

URL to previous APIPage in the query.

api_next_page_url: str | None

URL to next APIPage in the query.

api_first_page_url: str | None

URL to first APIPage in the query.

api_last_page_url: str | None

URL to last APIPage in the query.

jsonapi_version: str | None

Version of the JSON-API protocol used on this APIPage.