api.md

Search

Types:

from openregister.types import (
    CompanyLegalForm,
    CompanyRegisterType,
    CompanySearch,
    CompanySearchResponseItem,
    Pagination,
    SearchFilterBase,
    SearchRequestPagination,
    SearchAutocompleteCompaniesV1Response,
    SearchFindPersonV1Response,
    SearchLookupCompanyByURLResponse,
)

Methods:

• client.search.autocomplete_companies_v1(**params) -> SearchAutocompleteCompaniesV1Response
• client.search.find_companies_v1(**params) -> CompanySearch
• client.search.find_person_v1(**params) -> SearchFindPersonV1Response
• client.search.lookup_company_by_url(**params) -> SearchLookupCompanyByURLResponse

Company

Types:

from openregister.types import (
    CompanyAddress,
    CompanyCapital,
    CompanyDocument,
    CompanyName,
    CompanyOwnerLegalPerson,
    CompanyOwnerNaturalPerson,
    CompanyPurpose,
    CompanyRegister,
    CompanyRelationType,
    EntityType,
    MergedReportRow,
    MergedReportTable,
    ReportRow,
    ReportTable,
    RepresentationRole,
    Source,
    CompanyGetContactV0Response,
    CompanyGetDetailsV1Response,
    CompanyGetFinancialsV1Response,
    CompanyGetHistoricalOwnersV1Response,
    CompanyGetHoldingsV1Response,
    CompanyGetOwnersV1Response,
    CompanyGetUbosV1Response,
)

Methods:

• client.company.get_contact_v0(company_id) -> CompanyGetContactV0Response
• client.company.get_details_v1(company_id, **params) -> CompanyGetDetailsV1Response
• client.company.get_financials_v1(company_id) -> CompanyGetFinancialsV1Response
• client.company.get_historical_owners_v1(company_id) -> CompanyGetHistoricalOwnersV1Response
• client.company.get_holdings_v1(company_id) -> CompanyGetHoldingsV1Response
• client.company.get_owners_v1(company_id, **params) -> CompanyGetOwnersV1Response
• client.company.get_ubos_v1(company_id) -> CompanyGetUbosV1Response

Document

Types:

from openregister.types import Document, DocumentGetRealtimeV1Response

Methods:

• client.document.get_cached_v1(document_id) -> Document
• client.document.get_realtime_v1(**params) -> DocumentGetRealtimeV1Response

Person

Types:

from openregister.types import PersonGetDetailsV1Response, PersonGetHoldingsV1Response

Methods:

• client.person.get_details_v1(person_id) -> PersonGetDetailsV1Response
• client.person.get_holdings_v1(person_id) -> PersonGetHoldingsV1Response

Monitor

Types:

from openregister.types import MonitorCreateResponse, MonitorListResponse

Methods:

• client.monitor.create(**params) -> MonitorCreateResponse
• client.monitor.list() -> MonitorListResponse
• client.monitor.delete(entity_id) -> None

Transparenzregister

Methods:

• client.transparenzregister.set_credentials_v1(**params) -> None

Extract

Types:

from openregister.types.transparenzregister import (
    TransparenzregisterDocument,
    TransparenzregisterExtract,
    TransparenzregisterGroup,
    TransparenzregisterReport,
    TransparenzregisterStatusFlags,
    TransparenzregisterUbo,
    TransparenzregisterUboInterest,
    TransparenzregisterUboNaturalPerson,
    TransparenzregisterValidity,
    TransparenzregisterValidityPoint,
    ExtractCreateV1Response,
)

Methods:

• client.transparenzregister.extract.create_v1(**params) -> ExtractCreateV1Response
• client.transparenzregister.extract.get_v1(extract_id) -> TransparenzregisterExtract