# financial-reports-generated-client
Welcome to the Financial Reports API, your gateway to European company filings, financial data, and corporate information. All API requests must be authenticated. Authentication is performed by including your unique API key in the **X-API-Key** HTTP header. Please use the \"Authorize\" button to set your key and try out the endpoints.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.0
- Package version: 1.2.9
- 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. (optional)
industry = 'industry_example' # str | Filter by ISIC Group code. (optional)
industry_group = 'industry_group_example' # str | Filter by ISIC Division code. (optional)
isin = 'isin_example' # str | Filter by Company ISIN. Case-insensitive. (optional)
lei = 'lei_example' # str | Filter by Company Legal Entity Identifier (LEI). Case-insensitive. (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 ISIC Section code. (optional)
sub_industry = 'sub_industry_example' # str | Filter by ISIC Class code. (optional)
ticker = 'ticker_example' # str | Filter by Company primary stock Ticker symbol. Case-insensitive. (optional)
view = summary # str | Controls the level of detail. Omit for a default 'summary' view, or use 'full' to include all details for each company. (optional) (default to summary)
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, view=view)
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
*CountriesApi* | [**countries_list**](docs/CountriesApi.md#countries_list) | **GET** /countries/ | List Countries
*CountriesApi* | [**countries_retrieve**](docs/CountriesApi.md#countries_retrieve) | **GET** /countries/{id}/ | Retrieve Country
*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_markdown_retrieve**](docs/FilingsApi.md#filings_markdown_retrieve) | **GET** /filings/{filing_id}/markdown/ | Retrieve Filing Markdown
*FilingsApi* | [**filings_retrieve**](docs/FilingsApi.md#filings_retrieve) | **GET** /filings/{id}/ | Retrieve Filing Details
*ISICClassificationsApi* | [**isic_classes_list**](docs/ISICClassificationsApi.md#isic_classes_list) | **GET** /isic-classes/ | List ISIC Classes
*ISICClassificationsApi* | [**isic_classes_retrieve**](docs/ISICClassificationsApi.md#isic_classes_retrieve) | **GET** /isic-classes/{id}/ | Retrieve ISIC Class
*ISICClassificationsApi* | [**isic_divisions_list**](docs/ISICClassificationsApi.md#isic_divisions_list) | **GET** /isic-divisions/ | List ISIC Divisions
*ISICClassificationsApi* | [**isic_divisions_retrieve**](docs/ISICClassificationsApi.md#isic_divisions_retrieve) | **GET** /isic-divisions/{id}/ | Retrieve ISIC Division
*ISICClassificationsApi* | [**isic_groups_list**](docs/ISICClassificationsApi.md#isic_groups_list) | **GET** /isic-groups/ | List ISIC Groups
*ISICClassificationsApi* | [**isic_groups_retrieve**](docs/ISICClassificationsApi.md#isic_groups_retrieve) | **GET** /isic-groups/{id}/ | Retrieve ISIC Group
*ISICClassificationsApi* | [**isic_sections_list**](docs/ISICClassificationsApi.md#isic_sections_list) | **GET** /isic-sections/ | List ISIC Sections
*ISICClassificationsApi* | [**isic_sections_retrieve**](docs/ISICClassificationsApi.md#isic_sections_retrieve) | **GET** /isic-sections/{id}/ | Retrieve ISIC Section
*LanguagesApi* | [**languages_list**](docs/LanguagesApi.md#languages_list) | **GET** /languages/ | List Languages
*LanguagesApi* | [**languages_retrieve**](docs/LanguagesApi.md#languages_retrieve) | **GET** /languages/{id}/ | Retrieve Language
*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's Watchlist
*SchemaApi* | [**schema_retrieve**](docs/SchemaApi.md#schema_retrieve) | **GET** /schema/ |
## Documentation For Models
- [Company](docs/Company.md)
- [CompanyMinimal](docs/CompanyMinimal.md)
- [Country](docs/Country.md)
- [ErrorDetail](docs/ErrorDetail.md)
- [Filing](docs/Filing.md)
- [FilingSummary](docs/FilingSummary.md)
- [FilingType](docs/FilingType.md)
- [ISICClass](docs/ISICClass.md)
- [ISICDivision](docs/ISICDivision.md)
- [ISICGroup](docs/ISICGroup.md)
- [ISICSection](docs/ISICSection.md)
- [Language](docs/Language.md)
- [PaginatedCompanyMinimalList](docs/PaginatedCompanyMinimalList.md)
- [PaginatedCountryList](docs/PaginatedCountryList.md)
- [PaginatedFilingSummaryList](docs/PaginatedFilingSummaryList.md)
- [PaginatedFilingTypeList](docs/PaginatedFilingTypeList.md)
- [PaginatedISICClassList](docs/PaginatedISICClassList.md)
- [PaginatedISICDivisionList](docs/PaginatedISICDivisionList.md)
- [PaginatedISICGroupList](docs/PaginatedISICGroupList.md)
- [PaginatedISICSectionList](docs/PaginatedISICSectionList.md)
- [PaginatedLanguageList](docs/PaginatedLanguageList.md)
- [PaginatedSourceList](docs/PaginatedSourceList.md)
- [Source](docs/Source.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
Raw data
{
"_id": null,
"home_page": null,
"name": "financial-reports-generated-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Financial Reports API",
"author": "API Support",
"author_email": "API Support <api@financialreports.eu>",
"download_url": "https://files.pythonhosted.org/packages/ac/56/5256d8603da83e405b9a0d4d07db43f3f775a6da50413526a7d54c7aa285/financial_reports_generated_client-1.2.9.tar.gz",
"platform": null,
"description": "# financial-reports-generated-client\nWelcome to the Financial Reports API, your gateway to European company filings, financial data, and corporate information. All API requests must be authenticated. Authentication is performed by including your unique API key in the **X-API-Key** HTTP header. Please use the \\\"Authorize\\\" button to set your key and try out the endpoints.\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.0\n- Package version: 1.2.9\n- Generator version: 7.14.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\nFor more information, please visit [https://financialreports.eu/](https://financialreports.eu/)\n\n## Requirements.\n\nPython 3.9+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport financial_reports_generated_client\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport financial_reports_generated_client\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport financial_reports_generated_client\nfrom financial_reports_generated_client.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://api.financialreports.eu\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = financial_reports_generated_client.Configuration(\n host = \"https://api.financialreports.eu\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure API key authorization: ApiKeyAuth\nconfiguration.api_key['ApiKeyAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'\n\n\n# Enter a context with an instance of the API client\nasync with financial_reports_generated_client.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = financial_reports_generated_client.CompaniesApi(api_client)\n countries = 'countries_example' # str | Filter by Company country ISO Alpha-2 code(s). Comma-separated for multiple values. (optional)\n industry = 'industry_example' # str | Filter by ISIC Group code. (optional)\n industry_group = 'industry_group_example' # str | Filter by ISIC Division code. (optional)\n isin = 'isin_example' # str | Filter by Company ISIN. Case-insensitive. (optional)\n lei = 'lei_example' # str | Filter by Company Legal Entity Identifier (LEI). Case-insensitive. (optional)\n ordering = 'ordering_example' # str | Which field to use when ordering the results. (optional)\n page = 56 # int | A page number within the paginated result set. (optional)\n page_size = 56 # int | Number of results to return per page. (optional)\n search = 'search_example' # str | A search term. (optional)\n sector = 'sector_example' # str | Filter by ISIC Section code. (optional)\n sub_industry = 'sub_industry_example' # str | Filter by ISIC Class code. (optional)\n ticker = 'ticker_example' # str | Filter by Company primary stock Ticker symbol. Case-insensitive. (optional)\n view = summary # str | Controls the level of detail. Omit for a default 'summary' view, or use 'full' to include all details for each company. (optional) (default to summary)\n\n try:\n # List Companies\n 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, view=view)\n print(\"The response of CompaniesApi->companies_list:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling CompaniesApi->companies_list: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.financialreports.eu*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*CompaniesApi* | [**companies_list**](docs/CompaniesApi.md#companies_list) | **GET** /companies/ | List Companies\n*CompaniesApi* | [**companies_retrieve**](docs/CompaniesApi.md#companies_retrieve) | **GET** /companies/{id}/ | Retrieve Company Details\n*CountriesApi* | [**countries_list**](docs/CountriesApi.md#countries_list) | **GET** /countries/ | List Countries\n*CountriesApi* | [**countries_retrieve**](docs/CountriesApi.md#countries_retrieve) | **GET** /countries/{id}/ | Retrieve Country\n*FilingTypesApi* | [**filing_types_list**](docs/FilingTypesApi.md#filing_types_list) | **GET** /filing-types/ | List Filing Types\n*FilingTypesApi* | [**filing_types_retrieve**](docs/FilingTypesApi.md#filing_types_retrieve) | **GET** /filing-types/{id}/ | Retrieve Filing Type\n*FilingsApi* | [**filings_list**](docs/FilingsApi.md#filings_list) | **GET** /filings/ | List Filings\n*FilingsApi* | [**filings_markdown_retrieve**](docs/FilingsApi.md#filings_markdown_retrieve) | **GET** /filings/{filing_id}/markdown/ | Retrieve Filing Markdown\n*FilingsApi* | [**filings_retrieve**](docs/FilingsApi.md#filings_retrieve) | **GET** /filings/{id}/ | Retrieve Filing Details\n*ISICClassificationsApi* | [**isic_classes_list**](docs/ISICClassificationsApi.md#isic_classes_list) | **GET** /isic-classes/ | List ISIC Classes\n*ISICClassificationsApi* | [**isic_classes_retrieve**](docs/ISICClassificationsApi.md#isic_classes_retrieve) | **GET** /isic-classes/{id}/ | Retrieve ISIC Class\n*ISICClassificationsApi* | [**isic_divisions_list**](docs/ISICClassificationsApi.md#isic_divisions_list) | **GET** /isic-divisions/ | List ISIC Divisions\n*ISICClassificationsApi* | [**isic_divisions_retrieve**](docs/ISICClassificationsApi.md#isic_divisions_retrieve) | **GET** /isic-divisions/{id}/ | Retrieve ISIC Division\n*ISICClassificationsApi* | [**isic_groups_list**](docs/ISICClassificationsApi.md#isic_groups_list) | **GET** /isic-groups/ | List ISIC Groups\n*ISICClassificationsApi* | [**isic_groups_retrieve**](docs/ISICClassificationsApi.md#isic_groups_retrieve) | **GET** /isic-groups/{id}/ | Retrieve ISIC Group\n*ISICClassificationsApi* | [**isic_sections_list**](docs/ISICClassificationsApi.md#isic_sections_list) | **GET** /isic-sections/ | List ISIC Sections\n*ISICClassificationsApi* | [**isic_sections_retrieve**](docs/ISICClassificationsApi.md#isic_sections_retrieve) | **GET** /isic-sections/{id}/ | Retrieve ISIC Section\n*LanguagesApi* | [**languages_list**](docs/LanguagesApi.md#languages_list) | **GET** /languages/ | List Languages\n*LanguagesApi* | [**languages_retrieve**](docs/LanguagesApi.md#languages_retrieve) | **GET** /languages/{id}/ | Retrieve Language\n*SourcesApi* | [**sources_list**](docs/SourcesApi.md#sources_list) | **GET** /sources/ | List Data Sources\n*SourcesApi* | [**sources_retrieve**](docs/SourcesApi.md#sources_retrieve) | **GET** /sources/{id}/ | Retrieve Data Source\n*WatchlistApi* | [**watchlist_companies_create**](docs/WatchlistApi.md#watchlist_companies_create) | **POST** /watchlist/companies/ | Add Company to Watchlist\n*WatchlistApi* | [**watchlist_companies_destroy**](docs/WatchlistApi.md#watchlist_companies_destroy) | **DELETE** /watchlist/companies/{company_id}/ | Remove Company from Watchlist\n*WatchlistApi* | [**watchlist_retrieve**](docs/WatchlistApi.md#watchlist_retrieve) | **GET** /watchlist/ | Get User's Watchlist\n*SchemaApi* | [**schema_retrieve**](docs/SchemaApi.md#schema_retrieve) | **GET** /schema/ | \n\n\n## Documentation For Models\n\n - [Company](docs/Company.md)\n - [CompanyMinimal](docs/CompanyMinimal.md)\n - [Country](docs/Country.md)\n - [ErrorDetail](docs/ErrorDetail.md)\n - [Filing](docs/Filing.md)\n - [FilingSummary](docs/FilingSummary.md)\n - [FilingType](docs/FilingType.md)\n - [ISICClass](docs/ISICClass.md)\n - [ISICDivision](docs/ISICDivision.md)\n - [ISICGroup](docs/ISICGroup.md)\n - [ISICSection](docs/ISICSection.md)\n - [Language](docs/Language.md)\n - [PaginatedCompanyMinimalList](docs/PaginatedCompanyMinimalList.md)\n - [PaginatedCountryList](docs/PaginatedCountryList.md)\n - [PaginatedFilingSummaryList](docs/PaginatedFilingSummaryList.md)\n - [PaginatedFilingTypeList](docs/PaginatedFilingTypeList.md)\n - [PaginatedISICClassList](docs/PaginatedISICClassList.md)\n - [PaginatedISICDivisionList](docs/PaginatedISICDivisionList.md)\n - [PaginatedISICGroupList](docs/PaginatedISICGroupList.md)\n - [PaginatedISICSectionList](docs/PaginatedISICSectionList.md)\n - [PaginatedLanguageList](docs/PaginatedLanguageList.md)\n - [PaginatedSourceList](docs/PaginatedSourceList.md)\n - [Source](docs/Source.md)\n - [WatchlistAction](docs/WatchlistAction.md)\n - [WatchlistCompany](docs/WatchlistCompany.md)\n - [WatchlistResponse](docs/WatchlistResponse.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"ApiKeyAuth\"></a>\n### ApiKeyAuth\n\n- **Type**: API key\n- **API key parameter name**: X-API-Key\n- **Location**: HTTP header\n\n\n## Author\n\napi@financialreports.eu\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Financial Reports API",
"version": "1.2.9",
"project_urls": {
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
" openapi-generator",
" financial reports api"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "bf1a511fca5f5a1a2b8b59c94fb649d53968c87289566bbff1d59622d3391dab",
"md5": "f83d20c29e775f42b21deef59c6ef812",
"sha256": "bf302b9abd7ef974f0b862619cc5a04489b435e9b76122cf5e65af0969aa4105"
},
"downloads": -1,
"filename": "financial_reports_generated_client-1.2.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f83d20c29e775f42b21deef59c6ef812",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 96550,
"upload_time": "2025-08-16T10:16:12",
"upload_time_iso_8601": "2025-08-16T10:16:12.812767Z",
"url": "https://files.pythonhosted.org/packages/bf/1a/511fca5f5a1a2b8b59c94fb649d53968c87289566bbff1d59622d3391dab/financial_reports_generated_client-1.2.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ac565256d8603da83e405b9a0d4d07db43f3f775a6da50413526a7d54c7aa285",
"md5": "7449b7413388bb5559d9d7f97e087940",
"sha256": "279393c0c05b763babb98fac63e33af71a3a731cbf4eae5cf2ea6a63749ccce6"
},
"downloads": -1,
"filename": "financial_reports_generated_client-1.2.9.tar.gz",
"has_sig": false,
"md5_digest": "7449b7413388bb5559d9d7f97e087940",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 49039,
"upload_time": "2025-08-16T10:16:14",
"upload_time_iso_8601": "2025-08-16T10:16:14.055652Z",
"url": "https://files.pythonhosted.org/packages/ac/56/5256d8603da83e405b9a0d4d07db43f3f775a6da50413526a7d54c7aa285/financial_reports_generated_client-1.2.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-16 10:16:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "financial-reports-generated-client"
}