Willow Labs Python API’s documentation¶
Willow labs APIs offers services to get information regarding companies and related entities. The main companents are:
Information about the owners of a company. This service provides owners at all levels, meaning it recursively goes trough the ownership structure until a private owner is established.
Basic company information as address, industry, number of employees and more.
Signature rights and prokura holders for a comapny.
Roles connected to the company, for example CEO, board members, accountant.
Service name |
Descritpion |
Language |
English version |
|---|---|---|---|
get_basic_company_information |
Basic information. |
English |
|
get_company_ownership |
Get the full ownership structure. |
English |
|
get_company_power_of_attorney |
Get everyone with power of attorney. |
English |
|
*get_company_prokura |
Get everyone with prokura rights (power of attorney). |
Norwegian |
get_company_power_of_attorney |
get_company_full_signatory_authority |
All signature holders. |
English |
|
*get_company_signatur |
Get all signatur (signature) holders. |
Norwegian |
get_company_signatory_information |
get_company_signatory_information |
Get the authority holder. |
English |
|
get_company_roles |
Get all roles connect to a company. |
English |
* The function is a Norwegian version of an english function - see english version column for information.
Installation¶
pip install -U willowlabs
Example usage¶
from willowlabs.company_information.client import CompanyInformationClient
client = CompanyInformationClient("client_config.yaml")
company_basic_results = client.get_basic_company_information(organisation_number)
company_ownership_results = client.get_company_ownership(organisation_number, record_year)
Client Module¶
-
class
willowlabs.company_information.client.CompanyInformationClient(configuration_path: str, **kwargs: Any)¶ Bases:
objectClass to access Willow Labs API.
-
__init__(configuration_path: str, **kwargs: Any)¶ Initialize the client.
- Parameters
configuration_path – The path of the coniguration file.
**kwargs – Extra arguments.
-
__weakref__¶ list of weak references to the object (if defined)
-
get_basic_company_information(*args, **kwargs) → willowlabs.service_grpc.company_information.company_information_service_pb2.BasicCompanyInformationResponse¶ Get the basic information for a company. May include address, industrikode (industry code), næringskode (business code).
- Parameters
organisation_number – The organization number for the company being queried.
query_date – Information retrieved will be the one valid at this date.
- Returns
The the basic information of the organization number given.
Get the signature holders for a company. Signature is the right to sign for the companies in all situations. Extension of prokura which is only for daily operations.
English version of
get_company_signatur().- Parameters
organisation_number – The organization number for the company being queried.
query_date – The date to get the signature for.
- Returns
The signature holders.
-
get_company_ownership(*args, **kwargs) → willowlabs.service_grpc.company_information.company_information_service_pb2.OwnershipResponse¶ Get owners for a company.
- Parameters
organisation_number – The organization number for the company being queried.
record_year – The ownership year.
depth – Max depth of ownership structure returned.
cutoff – Minimum percentage of ownership for inclusion in result.
top – The number of max elements returned (The top N owners).
- Returns
The ownership structure.
-
get_company_power_of_attorney(*args, **kwargs) → willowlabs.service_grpc.company_information.company_information_service_pb2.SignatoryInformationResponse¶ Get the power of attorney (prokura) for the company. Power of attorney is the signature rights for all daily operations. See (in Norwegian): Lovdata or Wikipedia.
English version of
get_company_prokura().- Parameters
organisation_number – The organization number for the company being queried.
query_date – Information retrieved will be the one valid at this date.
- Returns
The list of all the the power of attorney rights.
-
get_company_prokura(*args, **kwargs) → willowlabs.service_grpc.company_information.company_information_service_pb2.SignatoryInformationResponse¶ Get the prokura rights for the company. Prokura is the signature rights for all daily operations. See: Lovdata or Wikipedia.
Norwegian version of
get_company_power_of_attorney().- Parameters
organisation_number – The organization number for the company being queried.
query_date – Information retrieved will be the one valid at this date.
- Returns
The list of all prokuras.
-
get_company_roles(*args, **kwargs) → willowlabs.service_grpc.company_information.company_information_service_pb2.RoleResponse¶ Get the roles for a company.
- Parameters
organisation_number – The organization number for the company being queried.
query_date – Information retrieved will be the one valid at this date.
- Returns
The roles belonging to the given organization number.
-
get_company_signatory_information(*args, **kwargs) → willowlabs.service_grpc.company_information.company_information_service_pb2.SignatoryInformationResponse¶ Get the authority holders for the company for a given authority type.
- Parameters
organisation_number – The organization number for the company being queried.
authority_type – The authority type being requested.
query_date – Information retrieved will be the one valid at this date.
- Returns
The signature holders of the given organization number.
-
get_company_signatur(*args, **kwargs) → willowlabs.service_grpc.company_information.company_information_service_pb2.SignatoryInformationResponse¶ Get the signature holders for a company. Signature is the right to sign for the companies in all situations. Extension of prokura which is only for daily operations.
Norwegian version of
get_company_full_signatory_authority().- Parameters
organisation_number – The organization number for the company being queried.
query_date – The date to get the signature for.
- Returns
The signature holders.
-
get_json_web_token()¶ Loads the web token into memory Uses impersonation of Willowlabs service account by currently signed in service account. This will enable the current service account to behave as if it was logged in as Willow Labs API service account. Billing for billable requests to gcloud will be billed to current service account.
-
load_configuration()¶ Loads the configuration into memory.
-
load_credentials()¶ Loads the credentials into memory.
-
Versions¶
Using Semantic Versioning 2.0.0.
[0.2.0] - 04.04.2020¶
First beta version: Basic functionality.