Before using web services, please note the following:
-
An authentication token is required to access web services (see Authentication token)
-
The supported formats for Timestamp or Date parameters are
-
yyyy-MM-dd
-
yyyy-MM-dd-HH:mm:ss
-
-
All Timestamp and Date parameters are stored and used in UTC (Coordinated Universal Time)
-
Boolean parameters support values like 1 or 0, but also true or false
-
All parameter values should be encoded in UTF-8
A unique token is required for web services access. This token is an alphanumeric string. Upon request, one will be created and supplied specifically for you.
The token must then be included in the header for each request to the web service.
The header to define must be named AUTH_API_KEY and its value must be your unique token.
Specification
Before using the request function, please note the following specifications applicable to the requests listed below.
-
Time periods (to – from) can cover a maximum of 31 days
-
If no time period is defined, the last 31 days are used by default
-
If no start date is defined, the 30 days immediately prior to the end date are used by default
-
If no end date is defined, the 30 days immediately following the start date are used by default
-
String parameter names and values are not case sensitive, i.e. a search for “DAILY”, “Daily” or “daily” will all yield the same results
Overview
| HTTP - Calls | Parameters | Type | Description | Examples |
| getauctions | horizon | String | Filter by horizon name | Yearly, Seasonal, Monthly, Daily, Intraday |
|---|---|---|---|---|
| corridor | String | Filter by corridor code | AT-IT, DE-D1, GR-IT, HU-SK | |
| shadow | Boolean | Filter for shadow auctions | 1 → only shadow auctions | |
| 0 → only non-shadow auctions | ||||
| null → only non-shadow auctions | ||||
| fromdate | Timestamp | Current max. time period of 31 days between from and to | 2019-01-01-00:00:00 | |
| todate | ||||
| getbids | auctionid | Integer | Auction identification | AT-CH-Y-BASE-------200101-01 |
| withoutcreditlimitrejection | Boolean | Filter out bids that were rejected | 0, 1, true or false | |
| gethorizons | - | Returns all horizon names | - | |
| getcorridors | - | Returns all corridor names | - | |
| getcurtailment | corridor | String | Filter by corridor code | AT-IT, DE-D1, GR-IT, HU-SK |
| fromdate | Timestamp | Current max. time period of 31 days between from and to | 2019-01-01-00:00:00 | |
| todate | ||||
| getauctioncalendar | corridor | String | Filter by corridor code | AT-IT, DE-D1, GR-IT, HU-SK |
| fromdate | Timestamp | Current max. time period of 31 days between from and to | 2019-01-01-00:00:00 | |
| todate |
Request “getauctions”
Use this request to list all auctions (closed, open or any future) filtered by horizon, corridor and for a given time period. Please note that only one year of auction data is retrievable. If no time period is specified, the last 31 days of data will be provided. As shadow and non-shadow auctions behave differently, there is also a filter for these two categories. By default, only non-shadow auctions are shown.
If you wish to view shadow auction data, please use the corresponding filter.
The results of this request will not contain any bid-related data. Linked objects are product, maintenance and resale.
Example call:
https://api.jao.eu/OWSMP/getauctions?corridor=IT-CH&fromdate=2019-01-01-13%3A00%3A00
Request “getbids”
This request will pull up all of the information about an auction that can be retrieved using a “getauctions” request, plus all of the information about the bids linked to that auction.
Example call:
https://api.jao.eu/OWSMP/getbids?auctionid=AT-CH-Y-BASE-------200101-01
Request “getcurtailment”
This request lists all curtailments in the system, with the option of filtering for corridors, curtailment period start and curtailment period end.
Example call:
Request “getcorridors” and “gethorizons”
These requests can be used to list all corridors and all horizons, respectively.
Example calls: