https://github.com/rhawiz/lilac-python-client
Auto-generated python client for lilac energy API using the swagger doc.
https://github.com/rhawiz/lilac-python-client
api api-client client energy lilac lilac-energy lilacenergy python
Last synced: 5 months ago
JSON representation
Auto-generated python client for lilac energy API using the swagger doc.
- Host: GitHub
- URL: https://github.com/rhawiz/lilac-python-client
- Owner: rhawiz
- Created: 2020-07-17T16:16:09.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-07-17T16:19:48.000Z (almost 6 years ago)
- Last Synced: 2024-01-28T16:06:49.608Z (over 2 years ago)
- Topics: api, api-client, client, energy, lilac, lilac-energy, lilacenergy, python
- Language: Python
- Homepage: https://sprod1.lilacfdm.com/api/swagger/index.html
- Size: 1.81 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# swagger-client
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
- API version: v1
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
### pip install
If the python package is hosted on Github, you can install directly from Github
```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 swagger_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 swagger_client
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: apikey-v1
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = swagger_client.CurveSummaryApi(swagger_client.ApiClient(configuration))
curve_id = 56 # int |
forecast_date = '2013-10-20T19:20:30+01:00' # datetime |
min_value_date = '2013-10-20T19:20:30+01:00' # datetime | (optional)
max_value_date = '2013-10-20T19:20:30+01:00' # datetime | (optional)
try:
api_response = api_instance.v1_curve_forecast_curve_id_forecast_date_get(curve_id, forecast_date, min_value_date=min_value_date, max_value_date=max_value_date)
pprint(api_response)
except ApiException as e:
print("Exception when calling CurveSummaryApi->v1_curve_forecast_curve_id_forecast_date_get: %s\n" % e)
# Configure API key authorization: apikey-v1
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = swagger_client.CurveSummaryApi(swagger_client.ApiClient(configuration))
curve_id = 56 # int |
scenario_id = 56 # int | (optional)
min_value_date = '2013-10-20T19:20:30+01:00' # datetime | (optional)
max_value_date = '2013-10-20T19:20:30+01:00' # datetime | (optional)
min_forecast_date = '2013-10-20T19:20:30+01:00' # datetime | (optional)
max_forecast_date = '2013-10-20T19:20:30+01:00' # datetime | (optional)
try:
api_response = api_instance.v1_curve_forecast_list_curve_id_get(curve_id, scenario_id=scenario_id, min_value_date=min_value_date, max_value_date=max_value_date, min_forecast_date=min_forecast_date, max_forecast_date=max_forecast_date)
pprint(api_response)
except ApiException as e:
print("Exception when calling CurveSummaryApi->v1_curve_forecast_list_curve_id_get: %s\n" % e)
# Configure API key authorization: apikey-v1
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = swagger_client.CurveSummaryApi(swagger_client.ApiClient(configuration))
curve_id = 56 # int |
min_value_date = '2013-10-20T19:20:30+01:00' # datetime | (optional)
max_value_date = '2013-10-20T19:20:30+01:00' # datetime | (optional)
min_forecast_date = '2013-10-20T19:20:30+01:00' # datetime | (optional)
max_forecast_date = '2013-10-20T19:20:30+01:00' # datetime | (optional)
try:
api_response = api_instance.v1_curve_scenario_curve_id_get(curve_id, min_value_date=min_value_date, max_value_date=max_value_date, min_forecast_date=min_forecast_date, max_forecast_date=max_forecast_date)
pprint(api_response)
except ApiException as e:
print("Exception when calling CurveSummaryApi->v1_curve_scenario_curve_id_get: %s\n" % e)
# Configure API key authorization: apikey-v1
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = swagger_client.CurveSummaryApi(swagger_client.ApiClient(configuration))
curve_id = 56 # int |
value_date = '2013-10-20T19:20:30+01:00' # datetime | (optional)
min_forecast_date = '2013-10-20T19:20:30+01:00' # datetime | (optional)
max_forecast_date = '2013-10-20T19:20:30+01:00' # datetime | (optional)
try:
api_response = api_instance.v1_curve_summary_forecasts_curve_id_get(curve_id, value_date=value_date, min_forecast_date=min_forecast_date, max_forecast_date=max_forecast_date)
pprint(api_response)
except ApiException as e:
print("Exception when calling CurveSummaryApi->v1_curve_summary_forecasts_curve_id_get: %s\n" % e)
# Configure API key authorization: apikey-v1
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = swagger_client.CurveSummaryApi(swagger_client.ApiClient(configuration))
curve_id = 56 # int |
min_forecast_date = '2013-10-20T19:20:30+01:00' # datetime | (optional)
max_forecast_date = '2013-10-20T19:20:30+01:00' # datetime | (optional)
try:
api_response = api_instance.v1_curve_summary_values_curve_id_get(curve_id, min_forecast_date=min_forecast_date, max_forecast_date=max_forecast_date)
pprint(api_response)
except ApiException as e:
print("Exception when calling CurveSummaryApi->v1_curve_summary_values_curve_id_get: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://sprod1.lilacfdm.com/api*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CurveSummaryApi* | [**v1_curve_forecast_curve_id_forecast_date_get**](docs/CurveSummaryApi.md#v1_curve_forecast_curve_id_forecast_date_get) | **GET** /v1/CurveForecast/{CurveID}/{ForecastDate} |
*CurveSummaryApi* | [**v1_curve_forecast_list_curve_id_get**](docs/CurveSummaryApi.md#v1_curve_forecast_list_curve_id_get) | **GET** /v1/CurveForecastList/{CurveID} |
*CurveSummaryApi* | [**v1_curve_scenario_curve_id_get**](docs/CurveSummaryApi.md#v1_curve_scenario_curve_id_get) | **GET** /v1/CurveScenario/{CurveID} |
*CurveSummaryApi* | [**v1_curve_summary_forecasts_curve_id_get**](docs/CurveSummaryApi.md#v1_curve_summary_forecasts_curve_id_get) | **GET** /v1/CurveSummary/Forecasts/{CurveID} |
*CurveSummaryApi* | [**v1_curve_summary_values_curve_id_get**](docs/CurveSummaryApi.md#v1_curve_summary_values_curve_id_get) | **GET** /v1/CurveSummary/Values/{CurveID} |
*CurveValuesApi* | [**v1_curve_values_aggregated_curve_id_result_period_type_result_period_length_get**](docs/CurveValuesApi.md#v1_curve_values_aggregated_curve_id_result_period_type_result_period_length_get) | **GET** /v1/CurveValues/Aggregated/{CurveID}/{ResultPeriodType}/{ResultPeriodLength} |
*CurveValuesApi* | [**v1_curve_values_curve_id_get**](docs/CurveValuesApi.md#v1_curve_values_curve_id_get) | **GET** /v1/CurveValues/{CurveID} |
*CurveValuesApi* | [**v1_curve_values_forecast_curve_id_scenario_id_forecast_date_get**](docs/CurveValuesApi.md#v1_curve_values_forecast_curve_id_scenario_id_forecast_date_get) | **GET** /v1/CurveValues/Forecast/{CurveID}/{ScenarioID}/{ForecastDate} |
*CurveValuesApi* | [**v1_curve_values_latest_forecast_curve_id_scenario_id_get**](docs/CurveValuesApi.md#v1_curve_values_latest_forecast_curve_id_scenario_id_get) | **GET** /v1/CurveValues/LatestForecast/{CurveID}/{ScenarioID} |
*FixturesApi* | [**v1_fixtures_fixture_data_fixture_type_get**](docs/FixturesApi.md#v1_fixtures_fixture_data_fixture_type_get) | **GET** /v1/Fixtures/FixtureData/{FixtureType} |
*FixturesApi* | [**v1_fixtures_fixture_field_fixture_type_get**](docs/FixturesApi.md#v1_fixtures_fixture_field_fixture_type_get) | **GET** /v1/Fixtures/FixtureField/{FixtureType} |
*FixturesApi* | [**v1_fixtures_fixture_field_value_fixture_type_field_name_get**](docs/FixturesApi.md#v1_fixtures_fixture_field_value_fixture_type_field_name_get) | **GET** /v1/Fixtures/FixtureFieldValue/{FixtureType}/{FieldName} |
*FixturesApi* | [**v1_fixtures_fixture_types_get**](docs/FixturesApi.md#v1_fixtures_fixture_types_get) | **GET** /v1/Fixtures/FixtureTypes |
*MetadataApi* | [**v1_metadata_curve_id_get**](docs/MetadataApi.md#v1_metadata_curve_id_get) | **GET** /v1/Metadata/{CurveID} |
*MetadataApi* | [**v1_metadata_register_curve_tag_post**](docs/MetadataApi.md#v1_metadata_register_curve_tag_post) | **POST** /v1/Metadata/RegisterCurveTag |
*MetadataApi* | [**v1_metadata_register_tag_post**](docs/MetadataApi.md#v1_metadata_register_tag_post) | **POST** /v1/Metadata/RegisterTag |
*MetadataApi* | [**v1_metadata_search_get**](docs/MetadataApi.md#v1_metadata_search_get) | **GET** /v1/Metadata/Search |
*MetadataApi* | [**v1_metadata_tag_types_get**](docs/MetadataApi.md#v1_metadata_tag_types_get) | **GET** /v1/Metadata/TagTypes |
*ReferenceDataApi* | [**v1_period_types_get**](docs/ReferenceDataApi.md#v1_period_types_get) | **GET** /v1/PeriodTypes |
*ReferenceDataApi* | [**v1_timezones_get**](docs/ReferenceDataApi.md#v1_timezones_get) | **GET** /v1/Timezones |
*RefineryUnitsAndTurnaroundsApi* | [**v1_iir_ref_turnaround_daily_data_get**](docs/RefineryUnitsAndTurnaroundsApi.md#v1_iir_ref_turnaround_daily_data_get) | **GET** /v1/IIR/RefTurnaroundDailyData |
*RefineryUnitsAndTurnaroundsApi* | [**v1_iir_ref_turnaround_data_get**](docs/RefineryUnitsAndTurnaroundsApi.md#v1_iir_ref_turnaround_data_get) | **GET** /v1/IIR/RefTurnaroundData |
*RefineryUnitsAndTurnaroundsApi* | [**v1_iir_ref_turnaround_field_get**](docs/RefineryUnitsAndTurnaroundsApi.md#v1_iir_ref_turnaround_field_get) | **GET** /v1/IIR/RefTurnaroundField |
*RefineryUnitsAndTurnaroundsApi* | [**v1_iir_ref_turnaround_field_value_field_name_get**](docs/RefineryUnitsAndTurnaroundsApi.md#v1_iir_ref_turnaround_field_value_field_name_get) | **GET** /v1/IIR/RefTurnaroundFieldValue/{FieldName} |
*RefineryUnitsAndTurnaroundsApi* | [**v1_iir_ref_unit_data_get**](docs/RefineryUnitsAndTurnaroundsApi.md#v1_iir_ref_unit_data_get) | **GET** /v1/IIR/RefUnitData |
*RefineryUnitsAndTurnaroundsApi* | [**v1_iir_ref_unit_field_get**](docs/RefineryUnitsAndTurnaroundsApi.md#v1_iir_ref_unit_field_get) | **GET** /v1/IIR/RefUnitField |
*RefineryUnitsAndTurnaroundsApi* | [**v1_iir_ref_unit_field_value_field_name_get**](docs/RefineryUnitsAndTurnaroundsApi.md#v1_iir_ref_unit_field_value_field_name_get) | **GET** /v1/IIR/RefUnitFieldValue/{FieldName} |
*TradeFlowsApi* | [**v1_flows_flow_data_flow_type_get**](docs/TradeFlowsApi.md#v1_flows_flow_data_flow_type_get) | **GET** /v1/Flows/FlowData/{FlowType} |
*TradeFlowsApi* | [**v1_flows_flow_field_flow_type_get**](docs/TradeFlowsApi.md#v1_flows_flow_field_flow_type_get) | **GET** /v1/Flows/FlowField/{FlowType} |
*TradeFlowsApi* | [**v1_flows_flow_field_value_flow_type_field_name_get**](docs/TradeFlowsApi.md#v1_flows_flow_field_value_flow_type_field_name_get) | **GET** /v1/Flows/FlowFieldValue/{FlowType}/{FieldName} |
*TradeFlowsApi* | [**v1_flows_flow_types_get**](docs/TradeFlowsApi.md#v1_flows_flow_types_get) | **GET** /v1/Flows/FlowTypes |
*ValidationApi* | [**v1_validation_status_data_data_type_get**](docs/ValidationApi.md#v1_validation_status_data_data_type_get) | **GET** /v1/ValidationStatus/Data/{DataType} |
*ValidationApi* | [**v1_validation_status_data_field_data_type_get**](docs/ValidationApi.md#v1_validation_status_data_field_data_type_get) | **GET** /v1/ValidationStatus/DataField/{DataType} |
*ValidationApi* | [**v1_validation_status_data_field_value_data_type_field_name_get**](docs/ValidationApi.md#v1_validation_status_data_field_value_data_type_field_name_get) | **GET** /v1/ValidationStatus/DataFieldValue/{DataType}/{FieldName} |
*ValidationApi* | [**v1_validation_status_data_types_get**](docs/ValidationApi.md#v1_validation_status_data_types_get) | **GET** /v1/ValidationStatus/DataTypes |
## Documentation For Models
- [FDMAPIDTOV1CrudesCrudesGrade](docs/FDMAPIDTOV1CrudesCrudesGrade.md)
- [FDMAPIDTOV1CrudesCrudesMeta](docs/FDMAPIDTOV1CrudesCrudesMeta.md)
- [FDMAPIDTOV1CrudesCrudesRefineryMeta](docs/FDMAPIDTOV1CrudesCrudesRefineryMeta.md)
- [FDMAPIDTOV1CrudesCrudesRefineryProduct](docs/FDMAPIDTOV1CrudesCrudesRefineryProduct.md)
- [FDMAPIDTOV1CurveAggregatedValue](docs/FDMAPIDTOV1CurveAggregatedValue.md)
- [FDMAPIDTOV1CurveForecast](docs/FDMAPIDTOV1CurveForecast.md)
- [FDMAPIDTOV1CurveForecastScenario](docs/FDMAPIDTOV1CurveForecastScenario.md)
- [FDMAPIDTOV1CurveForecastSummary](docs/FDMAPIDTOV1CurveForecastSummary.md)
- [FDMAPIDTOV1CurveImport](docs/FDMAPIDTOV1CurveImport.md)
- [FDMAPIDTOV1CurveMetadata](docs/FDMAPIDTOV1CurveMetadata.md)
- [FDMAPIDTOV1CurveMetadataTag](docs/FDMAPIDTOV1CurveMetadataTag.md)
- [FDMAPIDTOV1CurveScenarioForecastValue](docs/FDMAPIDTOV1CurveScenarioForecastValue.md)
- [FDMAPIDTOV1CurveValue](docs/FDMAPIDTOV1CurveValue.md)
- [FDMAPIDTOV1CurveValuesSummary](docs/FDMAPIDTOV1CurveValuesSummary.md)
- [FDMAPIDTOV1DataFieldValueItems](docs/FDMAPIDTOV1DataFieldValueItems.md)
- [FDMAPIDTOV1DataTypeFieldValue](docs/FDMAPIDTOV1DataTypeFieldValue.md)
- [FDMAPIDTOV1FixturesFixtureData](docs/FDMAPIDTOV1FixturesFixtureData.md)
- [FDMAPIDTOV1FixturesFixtureField](docs/FDMAPIDTOV1FixturesFixtureField.md)
- [FDMAPIDTOV1FlowsFlowData](docs/FDMAPIDTOV1FlowsFlowData.md)
- [FDMAPIDTOV1FlowsFlowField](docs/FDMAPIDTOV1FlowsFlowField.md)
- [FDMAPIDTOV1IIRIIRData](docs/FDMAPIDTOV1IIRIIRData.md)
- [FDMAPIDTOV1IIRIIRField](docs/FDMAPIDTOV1IIRIIRField.md)
- [FDMAPIDTOV1PropCurveDefinition](docs/FDMAPIDTOV1PropCurveDefinition.md)
- [FDMAPIDTOV1TabularDataDataTypeField](docs/FDMAPIDTOV1TabularDataDataTypeField.md)
- [FDMAPIDTOV1TabularDataTabularData](docs/FDMAPIDTOV1TabularDataTabularData.md)
## Documentation For Authorization
## apikey-v1
- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header
## Author