-
Notifications
You must be signed in to change notification settings - Fork 2
Public Data
Several endpoints in the API Specification (under the tags starting with the public
prefix, e.g public-auction
, public-nomination
) do not require authentication - these are the endpoints serving the publicly facing features of Empire.
💡 Users that are not registered with BritNed are able to use the public endpoints without an API Key for fetching publicly available data from Empire.
Participants are free to use these endpoints at their convenience, although some of them have authenticated "counterparts", which can offer extended functionality for logged-in users.
- Aggregated Nominations Overview - publishing the NTC in both Border Directions, alongside with the Aggregated Nominations in both Border Directions and the Netted Nominations (Flow) of the Interconnector
-
Auction Schedule - list of Auctions that are between
PRELIMINARY_SPEC_PUBLISHED
toPROVISIONAL_RESULTS_PUBLISHED
state -
Auction Results - list of Auctions that are in
FINAL_RESULTS_PUBLISHED
state - Auction Details - the Auction Detail screen for all Long Term, Day Ahead and Intraday auctions contain information of the Details of the Auction and the Auction Results information - (accessible from the Auction Schedule or Auction Results when using the GUI)
Please study first the 🔨 Auctions Wiki page for general information on how Empire works with Auction Statuses, the difference between the Auction Schedule List and the Auction Results List and how to fetch Auction Results for Long Term, Day Ahead and Intraday auctions.
Within the 🧭 API Navigator please refer to the public-auction
endpoints to fetch publicly available Auction information:
-
getPublicAuctions
- public Auction Schedule -
getPublicAllocatedAuctions
- public Auction Results -
getPublicLongTermAuction
,getPublicDayAheadAuction
,getPublicIntraDayAuction
- Auction Detail information for each Auction within different Timescales -
getPublicLongTermAuctionResults
- Auction Results for any Long Term Auction -
getPublicDayAheadOrIntraDayAuctionResults
- Auction Results for any Day Ahead or Intraday Auction
💡 For internal business logic on specific parameters please also refer to the 🔨 Auctions Wiki page
Empire publishes the following data
- NTC in both Border Directions
- Aggregated Nominations in both Border Directions
- Netted Nominations (Flow) alongside with the Border Direction of the Flow of the Interconnector
Use the getPublicAggregatedNominationsOverview
endpoint to fetch the above information. Parameters that can be set are:
-
deliveryDay
- the selected delivery day inYYYY-MM-DD
format -
timescales
- array of the Timescales with the following values:LONG_TERM
,DAY_AHEAD
,INTRA_DAY
⚠️ Make sure to include all three Timescales if you want to query the Interconnector's Netted Nominations for determining the Flow of BritNedUse the following syntax in query parameters:
?deliveryDay=XXXX-XX-XX×cales=LONG_TERM×cales=DAY_AHEAD×cales=INTRA_DAY
© 2023 BritNed Empire
🏠 britned.com/empire | 🧭 API Navigator | 📚 openapi.yaml