Entity

class xbrl_filings_api.Entity

Bases: APIResource

Entity in the database which has filed filings.

In most cases, the entity is the parent company of the group.

Methods

get_data_attributes([flags, filings])	Return data attributes for an APIResource.
__hash__()	Return hash of ('APIResource', cls.TYPE, self.api_id).
__repr__()	Return repr with api_id and name.
__str__()	Return "<name> (<identifier>)", or either alone.

Attributes

identifier	The identifier for entity.
name	Name of the entity.
filings	Set of filings reported by this entity.
api_entity_filings_url	URL to the page with full list of filings by this entity.
api_id	JSON-API resource id of APIResource.
query_time	Time when the query function was called for an APIObject.
request_url	HTTP request URL for an APIObject.

TYPE: str = 'entity'

JSON-API resource type of APIResource subclass.

identifier: str | None

The identifier for entity.

For ESEF filers, this should be the LEI code.

name: str | None

Name of the entity.

filings: set[Filing]

Set of filings reported by this entity.

api_entity_filings_url: str | None

URL to the page with full list of filings by this entity.

__repr__()

Return repr with api_id and name.

Return type:

str

__str__()

Return “<name> (<identifier>)”, or either alone.

If both are defined, full string is returned but if only one is defined, it is returned. If neither is defined, return empty string.

Return type:

str