pygleif.v2.client.GleifClient¶
- class pygleif.v2.client.GleifClient(transport=None)[source]¶
High-level client for the GLEIF API v1.0.
New features land here; the frozen v1 API lives in
pygleif.v1.- Parameters:
transport (Transport | None)
- __init__(transport=None)[source]¶
Init the client, optionally with a custom transport.
- Parameters:
transport (Transport | None)
- Return type:
None
Methods
__aenter__()Enter the async context manager.
__aexit__(*exc_info)Close the client on context exit.
__delattr__(name, /)Implement delattr(self, name).
__dir__()Default dir() implementation.
__enter__()Enter the sync context manager.
__eq__(value, /)Return self==value.
__exit__(*exc_info)Close the client on context exit.
__format__(format_spec, /)Default object formatter.
__ge__(value, /)Return self>=value.
__getattribute__(name, /)Return getattr(self, name).
__getstate__()Helper for pickle.
__gt__(value, /)Return self>value.
__hash__()Return hash(self).
__init__([transport])Init the client, optionally with a custom transport.
__init_subclass__()This method is called when a class is subclassed.
__le__(value, /)Return self<=value.
__lt__(value, /)Return self<value.
__ne__(value, /)Return self!=value.
__new__(*args, **kwargs)__reduce__()Helper for pickle.
__reduce_ex__(protocol, /)Helper for pickle.
__repr__()Return repr(self).
__setattr__(name, value, /)Implement setattr(self, name, value).
__sizeof__()Size of object in memory, in bytes.
__str__()Return str(self).
__subclasshook__(object, /)Abstract classes can override this to customize issubclass().
_field_modification_params(*, ...)Build the params for the field-modifications endpoint.
_filter_params(filters, sort)Build
filter[...]andsortparams._lei_to_record(payload)Normalize a decoded
lei-recordspayload toRecordLike._page_params(page_number, page_size)Build the JSON:API pagination params.
_search_params(*, filters, sort, ...)Build the JSON:API query params shared by
search/asearch.aassociated_entity(lei)Return the associated entity LEI record (async).
aautocompletions(query, *[, field])Return suggested search terms similar to
query(async).aby_bic(bic, *[, page_number, page_size])Look up LEI records by BIC code (async).
aby_isin(isin, *[, page_number, page_size])Look up LEI records by ISIN code (async).
aclose()Close the underlying async transport connection pool.
acountries(*[, page_number, page_size])Return the ISO 3166 country codes (async).
adirect_child_relationships(lei, *[, ...])Return the direct child relationship records (async).
adirect_children(lei, *[, page_number, ...])Return the LEI records of the direct children (async).
adirect_parent(lei)Return the LEI record of the direct parent (async).
adirect_parent_relationship(lei)Return the direct parent relationship record (async).
adirect_parent_reporting_exception(lei)Return the direct parent reporting exception (async).
aentity_legal_forms(*[, page_number, page_size])Return the ISO 20275 entity legal form codes (async).
aexport_lei_records(*[, export_format, ...])Export LEI records as a file and return its raw bytes (async).
afield_modifications(lei, *[, ...])Return the historical changes of the given LEI record (async).
afields()Return technical metadata describing the API's LEI data fields.
afuzzy_completions(query, *[, field])Find legal entities with data similar to
query(async).aget_country(code)Return a single country by its ISO 3166 code (async).
aget_entity_legal_form(elf_code)Return a single entity legal form by its ELF code (async).
aget_field(field_id)Return the metadata of a single LEI data field (async).
aget_jurisdiction(jurisdiction_id)Return a single legal jurisdiction by its code (async).
aget_lei(lei)Return a normalized
RecordLikefor a single LEI (async).aget_lei_issuer(issuer_id)Return a single LEI issuer by its LEI (async).
aget_lei_record(lei)Return the full LEI record for a single LEI code (async).
aget_official_organizational_role(role_id)Return a single official organizational role (async).
aget_region(region_id)Return a single region by its sub-region code (async).
aget_registration_agent(agent_id)Return a single registration agent by its ID (async).
aget_registration_authority(authority_id)Return a single registration authority by its RA code (async).
aget_vlei_issuer(issuer_id)Return a single vLEI issuer by its LEI (async).
ahealthcheck()Return whether the API is reachable (async).
aisins(lei, *[, page_number, page_size])Return all ISINs mapped to the given LEI record (async).
ajurisdictions(*[, page_number, page_size])Return the legal jurisdictions (async).
alei_issuer(lei)Return the LEI issuer record for the given LEI (async).
alei_issuer_jurisdictions(issuer_id, *[, ...])Return the jurisdictions an LEI issuer is accredited for (async).
alei_issuers(*[, page_number, page_size])Return the accredited LEI issuers (async).
amanaging_lou(lei)Return the LEI record of the managing LOU (async).
aofficial_organizational_roles(*[, ...])Return the ISO 5009 OOR codes (async).
aregions(*[, page_number, page_size])Return the ISO 3166 sub-region codes (async).
aregistration_agents(*[, page_number, page_size])Return the registration agents (async).
aregistration_authorities(*[, page_number, ...])Return the GLEIF registration authority codes (async).
asearch(*[, filters, sort, page_number, ...])Search LEI records with JSON:API filters, sorting and pagination.
asearch_fulltext(query, *[, page_number, ...])Run a full-text search over LEI records (async).
associated_entity(lei)Return the associated entity (fund manager) LEI record.
asuccessor_entity(lei)Return the successor entity LEI record (async).
aultimate_child_relationships(lei, *[, ...])Return the ultimate child relationship records (async).
aultimate_children(lei, *[, page_number, ...])Return the LEI records of the ultimate children (async).
aultimate_parent(lei)Return the LEI record of the ultimate parent (async).
aultimate_parent_relationship(lei)Return the ultimate parent relationship record (async).
aultimate_parent_reporting_exception(lei)Return the ultimate parent reporting exception (async).
autocompletions(query, *[, field])Return suggested search terms similar to
query.avlei_issuers(*[, page_number, page_size])Return the qualified vLEI issuing organizations (async).
by_bic(bic, *[, page_number, page_size])Look up LEI records by BIC code.
by_isin(isin, *[, page_number, page_size])Look up LEI records by ISIN code.
close()Close the underlying sync transport connection pool.
countries(*[, page_number, page_size])Return the ISO 3166 country codes.
direct_child_relationships(lei, *[, ...])Return the direct child relationship records.
direct_children(lei, *[, page_number, page_size])Return the LEI records of the direct children.
direct_parent(lei)Return the LEI record of the direct parent.
direct_parent_relationship(lei)Return the direct parent relationship record.
direct_parent_reporting_exception(lei)Return the reporting exception for the missing direct parent.
entity_legal_forms(*[, page_number, page_size])Return the ISO 20275 entity legal form (ELF) codes.
export_lei_records(*[, export_format, ...])Export LEI records as a file and return its raw bytes.
field_modifications(lei, *[, ...])Return the historical changes of the given LEI record.
fields()Return technical metadata describing the API's LEI data fields.
fuzzy_completions(query, *[, field])Find legal entities with data similar to
query(fuzzy match).get_country(code)Return a single country by its ISO 3166 code.
get_entity_legal_form(elf_code)Return a single entity legal form by its ELF code.
get_field(field_id)Return the metadata of a single LEI data field.
get_jurisdiction(jurisdiction_id)Return a single legal jurisdiction by its code.
get_lei(lei)Return a normalized
RecordLikefor a single LEI.get_lei_issuer(issuer_id)Return a single LEI issuer by its LEI.
get_lei_record(lei)Return the full LEI record for a single LEI code.
get_official_organizational_role(role_id)Return a single official organizational role by its OOR code.
get_region(region_id)Return a single region by its ISO 3166 sub-region code.
get_registration_agent(agent_id)Return a single registration agent by its ID.
get_registration_authority(authority_id)Return a single registration authority by its RA code.
get_vlei_issuer(issuer_id)Return a single vLEI issuer by its LEI.
healthcheck()Return whether the API is reachable.
isins(lei, *[, page_number, page_size])Return all ISINs mapped to the given LEI record.
jurisdictions(*[, page_number, page_size])Return the legal jurisdictions.
lei_issuer(lei)Return the LEI issuer (LOU) record that manages the given LEI.
lei_issuer_jurisdictions(issuer_id, *[, ...])Return the jurisdictions an LEI issuer is accredited for.
lei_issuers(*[, page_number, page_size])Return the accredited LEI issuers (LOUs).
managing_lou(lei)Return the LEI record of the managing LOU (LEI issuer).
official_organizational_roles(*[, ...])Return the ISO 5009 official organizational role (OOR) codes.
regions(*[, page_number, page_size])Return the ISO 3166 sub-region codes.
registration_agents(*[, page_number, page_size])Return the registration agents.
registration_authorities(*[, page_number, ...])Return the GLEIF registration authority (RA) codes.
search(*[, filters, sort, page_number, ...])Search LEI records with JSON:API filters, sorting and pagination.
search_fulltext(query, *[, page_number, ...])Run a full-text search over LEI records.
successor_entity(lei)Return the successor entity LEI record.
ultimate_child_relationships(lei, *[, ...])Return the ultimate child relationship records.
ultimate_children(lei, *[, page_number, ...])Return the LEI records of the ultimate children.
ultimate_parent(lei)Return the LEI record of the ultimate parent.
ultimate_parent_relationship(lei)Return the ultimate parent relationship record.
ultimate_parent_reporting_exception(lei)Return the reporting exception for the missing ultimate parent.
vlei_issuers(*[, page_number, page_size])Return the qualified vLEI issuing organizations.
Attributes
__annotations____dict____doc____firstlineno____module____static_attributes____weakref__list of weak references to the object