FilingsPage¶

class xbrl_filings_api.FilingsPage¶

Bases: APIPage

Response page containing filings as primary resource.

Methods

`__hash__`()	Return hash(self).
`__repr__`()	Return repr with request_url, query_time, and len(filing_list).
`__str__`()	Return str(self).

Attributes

`query_filing_count`	Total count of filings of the query including the ones not on this page.
`filing_list`	List of `Filing` objects on this page.
`entity_list`	List of `Entity` objects on this page.
`validation_message_list`	List of `ValidationMessage` objects on this page.
`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`.

query_filing_count¶: Total count of filings of the query including the ones not on this page.

entity_list: list[Entity] | None¶

List of Entity objects on this page.

Is None if flags parameter did not include GET_ENTITY.

validation_message_list: list[ValidationMessage] | None¶

List of ValidationMessage objects on this page.

Is None if flags parameter did not include GET_VALIDATION_MESSAGES.

__repr__()¶

Return repr with request_url, query_time, and len(filing_list).

Attribute request_url is shown as repr, query_time as unprefixed datetime() constructor, and len(filing_list) as integer.