ScopeFlag¶

class xbrl_filings_api.ScopeFlag¶

Bases: Flag

Flags for API resource retrieval scope.

Use GET_ONLY_FILINGS alone, the rest alone or the rest combined (| operator). A shorthand GET_ALL (GET_ENTITY | GET_VALIDATION_MESSAGES) is available in the library root namespace.

Methods

`__repr__`()	Return repr(self).
`__str__`()	Return str(self).

Attributes

GET_ONLY_FILINGS = 1¶

Retrieve only filings and nothing else. Overrides other flags.

Accessible through the package root namespace.

__new__(value)¶

GET_ENTITY = 2¶

Retrieve entities of filings.

Accessible through the package root namespace.

GET_VALIDATION_MESSAGES = 4¶

Retrieve validation messages of filings.

Accessible through the package root namespace.