Skip to content

rhawiz/lilac-python-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 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

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:

import swagger_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import swagger_client

Getting Started

Please follow the installation procedure and then run the following:

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 GET /v1/CurveForecast/{CurveID}/{ForecastDate}
CurveSummaryApi v1_curve_forecast_list_curve_id_get GET /v1/CurveForecastList/{CurveID}
CurveSummaryApi v1_curve_scenario_curve_id_get GET /v1/CurveScenario/{CurveID}
CurveSummaryApi v1_curve_summary_forecasts_curve_id_get GET /v1/CurveSummary/Forecasts/{CurveID}
CurveSummaryApi 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 GET /v1/CurveValues/Aggregated/{CurveID}/{ResultPeriodType}/{ResultPeriodLength}
CurveValuesApi v1_curve_values_curve_id_get GET /v1/CurveValues/{CurveID}
CurveValuesApi 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 GET /v1/CurveValues/LatestForecast/{CurveID}/{ScenarioID}
FixturesApi v1_fixtures_fixture_data_fixture_type_get GET /v1/Fixtures/FixtureData/{FixtureType}
FixturesApi v1_fixtures_fixture_field_fixture_type_get GET /v1/Fixtures/FixtureField/{FixtureType}
FixturesApi v1_fixtures_fixture_field_value_fixture_type_field_name_get GET /v1/Fixtures/FixtureFieldValue/{FixtureType}/{FieldName}
FixturesApi v1_fixtures_fixture_types_get GET /v1/Fixtures/FixtureTypes
MetadataApi v1_metadata_curve_id_get GET /v1/Metadata/{CurveID}
MetadataApi v1_metadata_register_curve_tag_post POST /v1/Metadata/RegisterCurveTag
MetadataApi v1_metadata_register_tag_post POST /v1/Metadata/RegisterTag
MetadataApi v1_metadata_search_get GET /v1/Metadata/Search
MetadataApi v1_metadata_tag_types_get GET /v1/Metadata/TagTypes
ReferenceDataApi v1_period_types_get GET /v1/PeriodTypes
ReferenceDataApi v1_timezones_get GET /v1/Timezones
RefineryUnitsAndTurnaroundsApi v1_iir_ref_turnaround_daily_data_get GET /v1/IIR/RefTurnaroundDailyData
RefineryUnitsAndTurnaroundsApi v1_iir_ref_turnaround_data_get GET /v1/IIR/RefTurnaroundData
RefineryUnitsAndTurnaroundsApi v1_iir_ref_turnaround_field_get GET /v1/IIR/RefTurnaroundField
RefineryUnitsAndTurnaroundsApi v1_iir_ref_turnaround_field_value_field_name_get GET /v1/IIR/RefTurnaroundFieldValue/{FieldName}
RefineryUnitsAndTurnaroundsApi v1_iir_ref_unit_data_get GET /v1/IIR/RefUnitData
RefineryUnitsAndTurnaroundsApi v1_iir_ref_unit_field_get GET /v1/IIR/RefUnitField
RefineryUnitsAndTurnaroundsApi v1_iir_ref_unit_field_value_field_name_get GET /v1/IIR/RefUnitFieldValue/{FieldName}
TradeFlowsApi v1_flows_flow_data_flow_type_get GET /v1/Flows/FlowData/{FlowType}
TradeFlowsApi v1_flows_flow_field_flow_type_get GET /v1/Flows/FlowField/{FlowType}
TradeFlowsApi v1_flows_flow_field_value_flow_type_field_name_get GET /v1/Flows/FlowFieldValue/{FlowType}/{FieldName}
TradeFlowsApi v1_flows_flow_types_get GET /v1/Flows/FlowTypes
ValidationApi v1_validation_status_data_data_type_get GET /v1/ValidationStatus/Data/{DataType}
ValidationApi 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 GET /v1/ValidationStatus/DataFieldValue/{DataType}/{FieldName}
ValidationApi v1_validation_status_data_types_get GET /v1/ValidationStatus/DataTypes

Documentation For Models

Documentation For Authorization

apikey-v1

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

Releases

No releases published

Packages

No packages published