# financial-reports-generated-client
API for accessing company filings, financial data, industry classifications, and related information.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 0.1.5
- Generator version: 7.13.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://financialreports.eu/](https://financialreports.eu/)

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import financial_reports_generated_client
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import financial_reports_generated_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import financial_reports_generated_client
from financial_reports_generated_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.financialreports.eu
# See configuration.py for a list of all supported configuration parameters.
configuration = financial_reports_generated_client.Configuration(
    host = "https://api.financialreports.eu"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = financial_reports_generated_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'


# Enter a context with an instance of the API client
async with financial_reports_generated_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = financial_reports_generated_client.CompaniesApi(api_client)
    countries = 'countries_example' # str | Filter by Company country ISO Alpha-2 code(s). Comma-separated for multiple values (e.g., US,GB,DE). (optional)
    industry = 'industry_example' # str | Filter by GICS Industry code. (optional)
    industry_group = 'industry_group_example' # str | Filter by GICS Industry Group code. (optional)
    page = 56 # int | A page number within the paginated result set. (optional)
    page_size = 56 # int | Number of results to return per page. (optional)
    search = 'search_example' # str | A search term. (optional)
    sector = 'sector_example' # str | Filter by GICS Sector code. (optional)
    sub_industry = 'sub_industry_example' # str | Filter by GICS Sub-Industry code. (optional)

    try:
        api_response = await api_instance.companies_list(countries=countries, industry=industry, industry_group=industry_group, page=page, page_size=page_size, search=search, sector=sector, sub_industry=sub_industry)
        print("The response of CompaniesApi->companies_list:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CompaniesApi->companies_list: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.financialreports.eu*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CompaniesApi* | [**companies_list**](docs/CompaniesApi.md#companies_list) | **GET** /companies/ | 
*CompaniesApi* | [**companies_retrieve**](docs/CompaniesApi.md#companies_retrieve) | **GET** /companies/{id}/ | 
*FilingTypesApi* | [**filing_types_list**](docs/FilingTypesApi.md#filing_types_list) | **GET** /filing-types/ | 
*FilingTypesApi* | [**filing_types_retrieve**](docs/FilingTypesApi.md#filing_types_retrieve) | **GET** /filing-types/{id}/ | 
*FilingsApi* | [**filings_list**](docs/FilingsApi.md#filings_list) | **GET** /filings/ | 
*FilingsApi* | [**filings_retrieve**](docs/FilingsApi.md#filings_retrieve) | **GET** /filings/{id}/ | 
*IndustriesApi* | [**industries_list**](docs/IndustriesApi.md#industries_list) | **GET** /industries/ | 
*IndustriesApi* | [**industries_retrieve**](docs/IndustriesApi.md#industries_retrieve) | **GET** /industries/{id}/ | 
*IndustryGroupsApi* | [**industry_groups_list**](docs/IndustryGroupsApi.md#industry_groups_list) | **GET** /industry-groups/ | 
*IndustryGroupsApi* | [**industry_groups_retrieve**](docs/IndustryGroupsApi.md#industry_groups_retrieve) | **GET** /industry-groups/{id}/ | 
*SchemaApi* | [**schema_retrieve**](docs/SchemaApi.md#schema_retrieve) | **GET** /schema/ | 
*SectorsApi* | [**sectors_list**](docs/SectorsApi.md#sectors_list) | **GET** /sectors/ | 
*SectorsApi* | [**sectors_retrieve**](docs/SectorsApi.md#sectors_retrieve) | **GET** /sectors/{id}/ | 
*SourcesApi* | [**sources_list**](docs/SourcesApi.md#sources_list) | **GET** /sources/ | 
*SourcesApi* | [**sources_retrieve**](docs/SourcesApi.md#sources_retrieve) | **GET** /sources/{id}/ | 
*SubIndustriesApi* | [**sub_industries_list**](docs/SubIndustriesApi.md#sub_industries_list) | **GET** /sub-industries/ | 
*SubIndustriesApi* | [**sub_industries_retrieve**](docs/SubIndustriesApi.md#sub_industries_retrieve) | **GET** /sub-industries/{id}/ | 


## Documentation For Models

 - [Company](docs/Company.md)
 - [CompanyMinimal](docs/CompanyMinimal.md)
 - [Filing](docs/Filing.md)
 - [FilingType](docs/FilingType.md)
 - [Industry](docs/Industry.md)
 - [IndustryGroup](docs/IndustryGroup.md)
 - [Language](docs/Language.md)
 - [PaginatedCompanyList](docs/PaginatedCompanyList.md)
 - [PaginatedFilingList](docs/PaginatedFilingList.md)
 - [PaginatedFilingTypeList](docs/PaginatedFilingTypeList.md)
 - [PaginatedIndustryGroupList](docs/PaginatedIndustryGroupList.md)
 - [PaginatedIndustryList](docs/PaginatedIndustryList.md)
 - [PaginatedSectorList](docs/PaginatedSectorList.md)
 - [PaginatedSourceList](docs/PaginatedSourceList.md)
 - [PaginatedSubIndustryList](docs/PaginatedSubIndustryList.md)
 - [Sector](docs/Sector.md)
 - [Source](docs/Source.md)
 - [SubIndustry](docs/SubIndustry.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="basicAuth"></a>
### basicAuth

- **Type**: HTTP basic authentication

<a id="cookieAuth"></a>
### cookieAuth

- **Type**: API key
- **API key parameter name**: sessionid
- **Location**: 


## Author

api@financialreports.eu


