| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Name | Name | Last commit date | ||
|---|---|---|---|---|
IP RL BSP API for participation in capacity/energy market tenders.
This Python package is automatically generated by the Swagger Codegen project:
Python 2.7 and 3.4+
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/NW-Tech/BSP-API.git(you may need to run pip with root permission: sudo pip install git+https://github.com/NW-Tech/BSP-API.git)
Then import the package:
import swagger_client 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_clientPlease 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 OAuth2 access token for authorization: OAuth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.BSPApi(swagger_client.ApiClient(configuration))
valid_date = '2013-10-20' # date | Contracts for a specified day can be queried. If not specified, contracts for today will be listed. (optional)
product_type = 'product_type_example' # str | Product type filter for contracts. If not specified, then contracts for all product types are returned. (optional)
try:
# Returns current backup contracts
api_response = api_instance.get_backup_contracts(valid_date=valid_date, product_type=product_type)
pprint(api_response)
except ApiException as e:
print("Exception when calling BSPApi->get_backup_contracts: %s\n" % e)
# Configure OAuth2 access token for authorization: OAuth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.BSPApi(swagger_client.ApiClient(configuration))
product_type = 'product_type_example' # str | Product type filter for framework agreements. If this query parameter is not set, contracts for all product types are returned. (optional)
try:
# Current framework agreements
api_response = api_instance.get_framework_contracts(product_type=product_type)
pprint(api_response)
except ApiException as e:
print("Exception when calling BSPApi->get_framework_contracts: %s\n" % e)
# Configure OAuth2 access token for authorization: OAuth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.BSPApi(swagger_client.ApiClient(configuration))
delivery_date = '2013-10-20' # date | Defines the delivery date for which the pre-qualified capacities are to be returned.
product_type = 'product_type_example' # str | Product type filter for contracts. If not specified, then contracts for all product types are returned. (optional)
try:
# Prequalified capacities.
api_response = api_instance.get_pre_qualified_capacities(delivery_date, product_type=product_type)
pprint(api_response)
except ApiException as e:
print("Exception when calling BSPApi->get_pre_qualified_capacities: %s\n" % e)All URIs are relative to https://api.regelleistung.net/v3
| Class | Method | HTTP request | Description |
|---|---|---|---|
| BSPApi | get_backup_contracts | GET /backup-contracts | Returns current backup contracts |
| BSPApi | get_framework_contracts | GET /framework-agreements | Current framework agreements |
| BSPApi | get_pre_qualified_capacities | GET /pre-qualified-capacities/{deliveryDate} | Prequalified capacities. |
| BatchApi | batch | POST /batch | Submit batch requests |
| BiddingApi | delete_bid | DELETE /bids/{id} | Deletes a simple, complex bid or a bid component |
| BiddingApi | get_bid | GET /bids/{id} | Get a simple, complex bid or a complex bid component |
| BiddingApi | get_bids | GET /bids | List submitted bids (optionally capacity or energy market) |
| BiddingApi | submit_bid | POST /bids | Submit a simple, complex bid or a complex bid component |
| BiddingApi | update_bid | PATCH /bids/{id} | Updates a simple, complex bid or a bid component |
| DocumentsApi | get_document | GET /documents/{id} | Returns a document by its id. |
| DocumentsApi | get_document_content | GET /documents/{id}/content | Returns the content of requested document as "file download" |
| DocumentsApi | get_documents | GET /documents | Result documents |
| HealthApi | get_api_health_informations | GET /health | API health endpoint. |
| NotificationsApi | get_notifications | GET /notifications | Notifications |
| ResultsApi | get_allocation_results | GET /results | Anonymous results |
| TendersApi | get_tender | GET /tenders/{id} | Get tender |
| TendersApi | get_tender_demand | GET /tenders/{id}/demands | Demand of tender |
| TendersApi | get_tender_list | GET /tenders | List tenders (optionally capacity/energy market) |
| Back | FazBrowse Home | New Git URL |