# 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: 1.1.8
- Generator version: 7.14.0
- 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 API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = '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)
    isin = 'isin_example' # str | Find companies matching the provided ISIN. (optional)
    lei = 'lei_example' # str | Find a company by its LEI. (optional)
    ordering = 'ordering_example' # str | Which field to use when ordering the results. (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)
    ticker = 'ticker_example' # str | Find a company by its Ticker. (optional)

    try:
        # List Companies
        api_response = await api_instance.companies_list(countries=countries, industry=industry, industry_group=industry_group, isin=isin, lei=lei, ordering=ordering, page=page, page_size=page_size, search=search, sector=sector, sub_industry=sub_industry, ticker=ticker)
        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/ | List Companies
*CompaniesApi* | [**companies_retrieve**](docs/CompaniesApi.md#companies_retrieve) | **GET** /companies/{id}/ | Retrieve Company Details
*FilingTypesApi* | [**filing_types_list**](docs/FilingTypesApi.md#filing_types_list) | **GET** /filing-types/ | List Filing Types
*FilingTypesApi* | [**filing_types_retrieve**](docs/FilingTypesApi.md#filing_types_retrieve) | **GET** /filing-types/{id}/ | Retrieve Filing Type
*FilingsApi* | [**filings_list**](docs/FilingsApi.md#filings_list) | **GET** /filings/ | List Filings
*FilingsApi* | [**filings_retrieve**](docs/FilingsApi.md#filings_retrieve) | **GET** /filings/{id}/ | Retrieve Filing Details
*GICSClassificationsApi* | [**industries_list**](docs/GICSClassificationsApi.md#industries_list) | **GET** /industries/ | List GICS Industries
*GICSClassificationsApi* | [**industries_retrieve**](docs/GICSClassificationsApi.md#industries_retrieve) | **GET** /industries/{id}/ | Retrieve GICS Industry
*GICSClassificationsApi* | [**industry_groups_list**](docs/GICSClassificationsApi.md#industry_groups_list) | **GET** /industry-groups/ | List GICS Industry Groups
*GICSClassificationsApi* | [**industry_groups_retrieve**](docs/GICSClassificationsApi.md#industry_groups_retrieve) | **GET** /industry-groups/{id}/ | Retrieve GICS Industry Group
*GICSClassificationsApi* | [**sectors_list**](docs/GICSClassificationsApi.md#sectors_list) | **GET** /sectors/ | List GICS Sectors
*GICSClassificationsApi* | [**sectors_retrieve**](docs/GICSClassificationsApi.md#sectors_retrieve) | **GET** /sectors/{id}/ | Retrieve GICS Sector
*GICSClassificationsApi* | [**sub_industries_list**](docs/GICSClassificationsApi.md#sub_industries_list) | **GET** /sub-industries/ | List GICS Sub-Industries
*GICSClassificationsApi* | [**sub_industries_retrieve**](docs/GICSClassificationsApi.md#sub_industries_retrieve) | **GET** /sub-industries/{id}/ | Retrieve GICS Sub-Industry
*ProcessedFilingsApi* | [**processed_filings_retrieve**](docs/ProcessedFilingsApi.md#processed_filings_retrieve) | **GET** /processed-filings/{id}/ | Retrieve Processed Filing Content
*SourcesApi* | [**sources_list**](docs/SourcesApi.md#sources_list) | **GET** /sources/ | List Data Sources
*SourcesApi* | [**sources_retrieve**](docs/SourcesApi.md#sources_retrieve) | **GET** /sources/{id}/ | Retrieve Data Source
*WatchlistApi* | [**watchlist_companies_create**](docs/WatchlistApi.md#watchlist_companies_create) | **POST** /watchlist/companies/ | Add Company to Watchlist
*WatchlistApi* | [**watchlist_companies_destroy**](docs/WatchlistApi.md#watchlist_companies_destroy) | **DELETE** /watchlist/companies/{company_id}/ | Remove Company from Watchlist
*WatchlistApi* | [**watchlist_retrieve**](docs/WatchlistApi.md#watchlist_retrieve) | **GET** /watchlist/ | Get User&#39;s Watchlist
*SchemaApi* | [**schema_retrieve**](docs/SchemaApi.md#schema_retrieve) | **GET** /schema/ | 


## Documentation For Models

 - [Company](docs/Company.md)
 - [CompanyMinimal](docs/CompanyMinimal.md)
 - [ErrorDetail](docs/ErrorDetail.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)
 - [ProcessedFiling](docs/ProcessedFiling.md)
 - [Sector](docs/Sector.md)
 - [Source](docs/Source.md)
 - [SubIndustry](docs/SubIndustry.md)
 - [WatchlistAction](docs/WatchlistAction.md)
 - [WatchlistCompany](docs/WatchlistCompany.md)
 - [WatchlistResponse](docs/WatchlistResponse.md)


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


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

- **Type**: API key
- **API key parameter name**: X-API-Key
- **Location**: HTTP header


## Author

api@financialreports.eu


