API reference

The documents contain short summaries of the objects and members they define. Summaries have links to the documented object. If there is no link, the member is inherited from a parent class.

xbrl_filings_api.query	Define query functions for the API.
xbrl_filings_api.Filing	XBRL filing in the database based on a report package file.
xbrl_filings_api.Entity	Entity in the database which has filed filings.
xbrl_filings_api.ValidationMessage	Message for a filing in the database from a validator software.
xbrl_filings_api.APIError	Error returned by the underlying API.
xbrl_filings_api.FilingSet	Mutable set for Filing objects.
xbrl_filings_api.ResourceCollection	Collection of subresources of a FilingSet object.
xbrl_filings_api.FilingsPage	Response page containing filings as primary resource.
xbrl_filings_api.APIPage	Base class for JSON:API response page or document.
xbrl_filings_api.DownloadInfo	Dataclass for attribute DownloadSpecs.info.
xbrl_filings_api.DownloadItem	Dataclass defining download item for download functions.
xbrl_filings_api.APIObject	Base class for JSON:API objects.
xbrl_filings_api.APIResource	Base class for JSON:API resources, i.e., data objects.
xbrl_filings_api.SQLiteView	Dataclass for storing SQLite view creation instructions.
xbrl_filings_api.constants	Common constants for the library.
xbrl_filings_api.ScopeFlag	Flags for API resource retrieval scope.
xbrl_filings_api.default_views	Define default SQLite views for created/updated database file.
xbrl_filings_api.exceptions	The exceptions for the library.
xbrl_filings_api.options	General options for the library.
xbrl_filings_api.stats	Module for API stats counters.
xbrl_filings_api.debug	Define debugging functions.
xbrl_filings_api.downloader	Download manager for asynchronic parallel downloading.
xbrl_filings_api.downloader.stats	Module for download stats counters.