0% found this document useful (0 votes)
233 views19 pages

GIE API Documentation v004

The document provides information about accessing the AGSI+ and ALSI transparency platforms through their Application Programming Interface (API). It outlines the registration process, data coverage including historical data ranges and fields, and technical implementation of the REST-like API using JSON format. Data on the platforms includes daily storage and LNG data reporting for individual facilities and aggregated levels.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
233 views19 pages

GIE API Documentation v004

The document provides information about accessing the AGSI+ and ALSI transparency platforms through their Application Programming Interface (API). It outlines the registration process, data coverage including historical data ranges and fields, and technical implementation of the REST-like API using JSON format. Data on the platforms includes daily storage and LNG data reporting for individual facilities and aggregated levels.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

API

access to AGSI+ / ALSI

User Manual
1 October 2019 / v004

1. Introduction

GIE is offering an API service (Application Programming Interface) on its AGSI+ and
ALSI transparency publication platforms at https://agsi.gie.eu and https://alsi.gie.eu which
provides quick, continuous and direct access to the database and allows you to filter,
create queries and export the data as required.

This means that you do not have to set up complex processes to download files from a
remote location, or to crawl through the AGSI+/ALSI web pages to extract the data from
the various web site components. All of this can be directly downloaded, bypassing any
web layer, by accessing the available REST APIs.

API Access

The API service is available to the public free of charge.

Registration on the AGSI+ or ALSI website is mandatory for non-data providers to be


able to use the API. Registration will result in a personal API key that is required within
the API url. The only purpose of this registration is to enable us to assess and improve
the performance of our systems where and if required (user count, user activity, most
popular dataset types).

Your account information and settings can be updated (and canceled) at any time after
signing in. Your data will be stored and securely handles as long as your account
remains active.

API access for SSO/LSO data providers


Please note that all SSO / LSO accounts (data providers) using GIE as RRM (Registered
Reporting Mechanism) for REMIT reporting towards ACER or who are providing data for
the AGSI+ / ALSI publication can also generate an API key through their user account at
https://remit.gie.eu/users/profile. These accounts are already registered at GIE and are
also already subscribed to our IT mailing lists (unless you have opted out).
Data providers can use the same login credentials used for access to the REMIT portal
once you have generated an API key in your REMIT user profile interface. You can opt to
have access to solely AGSI+, ALSI or even both.

Currently, API keys are set to never expire. This might change in the future.

API mailing list

If you would like to be kept up-to-date on any changes (Service Announcements) on the
AGSI+ and ALSI platforms, you can opt to subscribe to our API mailing list in the
registration form.

Technical implementation

API (Application Programming Interface) provides programmatic access to the data.

API access is provided in a REST-like interface (Representational State Transfer)


exposing database resources in a JSON format. JSONP is currently not supported but is
foreseen in the future to also allow for cross domain requests.

Additional documentation, examples and guidance on how to use and implement the API
service is provided below.
Data coverage

Daily storage and LNG data reporting

Only the daily storage and LNG data reporting as currently available on the platforms is
made available. Unavailability reporting is currently not (yet) part of the API coverage.

Aggregated datasets

Both individual facility datasets and aggregated datasets (by company and country level)
are available. Aggregated datasets are to be exported using the additional REST API
parameters (see below).

Storage facilities and Storage Groups

Note that for storage data, a dataset can be either an individual storage facility, or a
storage group (virtual storage) which is comprised of multiple storage facilities. The
composition of a storage group can evolve and change over time (any changes will be
reported through a Service Announcement).

(Storage) Facility Operators

Note that storage facilities can change ownership, which will result in the facility dataset
being assigned to another SSO. Any such changes are reported through the Service
Announcements.

Historical data usage (timeframe)

- new facilities and decommissioning

If a new (storage) facility comes online, or when a (storage) facility is being


decommissioned or shut down, the related dataset start/end date is to be taken into
account. Any such information is also reported through a Service Announcement, as it
has an impact on the historical (aggregated) dataset coverage. Historical data for
facilities that have changed ownership, or have been decommissioned or shut down,
remains available through a dedicated separate code (typically starting with PRIOR).

- historical data range

Historical data has been requested from all SSO/LSO publishing on AGSI+/ALSI for the
following timeframe :

On AGSI+ :
historical data since 01/01/2011 or
since the date the storage facility has become operational
and/or until the storage facility has been decommissioned
or changed ownership.
On ALSI :
historical data since 01/01/2012
or since the date the LNG terminal has become operational

- historical data coverage

Additionally, note that on AGSI+ not all SSO have been able to provide the full historical
data coverage. Some SSO only provide historical data since the start of REMIT reporting
(07/04/2016). A detailed data overview is available at https://agsi.gie.eu/#/faq.
2. Datafield library
The following datafields are published on AGSI+ :

AGSI+
Field identifier Description Unit of Measurement Example
E (estimated)
status C (confirmed) E/C/N C
N (no data)

The start of the gas day reported


gasDayStartedOn YYYY-MM-DD 2015-11-02
upon

Total amount of gas


TWh
gasInStorage in storage at the facility, 853.4219
(4 digits behind decimal point)
status at end of gas day

full Storage / WGV (in%) % 83.45

trend (injection - withdrawal)/WGV +/- -0.1

GWh/d
injection Injection during gas day 238.66
(2 digits behind decimal point)

GWh/d
withdrawal Withdrawal during gas day 2182.49
(2 digits behind decimal point)

Maximum amount that can be


TWh
workingGasVolume stored at the facility 1022.7059
(4 digits behind decimal point)
(technical capacity)

Maximum technical GWh/d


injectionCapacity 9973.17
injection capacity (2 digits behind decimal point)

Maximum technical GWh/d


withdrawalCapacity 17599.82
withdrawal capacity (2 digits behind decimal point)

https://agsi.gie
Service Announcement
info URL .eu/#/news/20
(if applicable)
9
The following datafields are published on ALSI:

ALSI
Field identifier Description Unit of Measurement Example
E (estimated)
status C (confirmed) E/C/N C
N (no data)

The start of the gas day reported


gasDayStartedOn YYYY-MM-DD 2017-12-18
upon

The aggregated amount of LNG 3 3


10 m LNG
lngInventory in the LNG tanks 5373.25
(2 digits behind decimal point)
at end of the previous gas day

The aggregated gas flow out of


GWh/d
sendOut the LNG facility 976.5
(1 digit behind decimal point)
withing the gas day

3 3
Declared Total 10 m LNG 8898.99
dtmi
Maximum Inventory (2 digits behind decimal point)

Declared Total GWh/d 6650.0


dtrs
Reference SendOut (1 digit behind decimal point)

Service Announcement https://alsi.gie.e


info URL
(if applicable) u/#/news/184
3. Data

3.1 Data quality indicators

The data quality status (Estimated/Confirmed) is part of the available datasets, as well as
the Service Announcements (SA) linked to each dataset.

Any applicable Service Announcements are available through the info data field as an
URL linking to the related news item.

3.2 Dataset identification

Each storage system operator (SSO) and LNG terminal operator (LSO) and its listed
facilities are identified using EIC codes.

The datasets are identified using the EIC codes as used for REMIT reporting and/or used for
data provision to GIE for those SSO/LSO not using GIE as RRM (Registered Reporting
Mechanism) for REMIT or for SSO/LSO not falling under the REMIT regulation.

The mapping table for these EIC codes is available at (after login):
https://agsi.gie.eu/#/api
https://alsi.gie.eu/#/api

Please note that the EIC code database is subject to updates and EIC codes used on AGSI+ or
ALSI can change over time. For example: Facilities can change operator, new facilities can
become operational or be decommissioned, a facility can be moved within a (virtual) storage
group and change code, etc.

The EIC codebase is expected to be updated further in accordance with REMIT regulation
(using only ACER approved EIC codes where applicable).

If such changes would have occurred, we will be able to inform you through the API mailing
list.

3.3 Units of Measurement and data definitions

Additional information on units of measurement and specific data definitions


are available at:
https://agsi.gie.eu/#/faq
https://alsi.gie.eu/#/faq

3.4 Data updates – publication timing and processing

The data is available in daily frequency and represents gas in Storage / LNG at the end
of the previous gas day. Data is updated every day at 19:30 CET and a second time at
23:00. Some SSO/LSO are not able to provide their data before 19:30 but these will be
included in the second publication time.
4. Assistance

4.1 Technical assistance (API)

Any technical inquiries related to the implementation of the API service can be addressed to
[email protected]. Our IT team will be happy to assist you.

4.2 Data clarification

Any inquiries on data published through AGSI+ / ALSI can be addressed to


[email protected]. Note that for inquiries related to a specific SSO or LSO, the operator
may need to be contacted directly, as GIE cannot speak on their behalf.

AGSI+ / ALSI offers you the possibility to be kept up to date whenever a new Service
Announcemement or update from one of our data providers is posted on the website. Please
provide your contact details using the subscription form, and you will be informed by e-mail
whenever news or updates are made available.

AGSI+: https://agsi.gie.eu/#/subscribe
ALSI : https://alsi.gie.eu/#/subscribe

GIE is also providing additional related data such as the Storage Map, LNG Map and Storage
and LNG Investment Database at http://www.gie.eu/maps-data/
5. Disclaimer

All data is provided by the contributors on a voluntary basis and free of charge. The Data
provided by AGSI+ / ALSI is for information only. GIE is using reasonable efforts to invest
in ensuring the correctness, completeness, and timeliness of the information provided
herein. Data have been carefully checked, are updated at regular intervals and may be
subject to changes, removal, or amendments without prior notice.

GIE neither assumes any warranty or liability for the correctness and completeness of
information/services and entries nor for the mode of presentation.
6. Tutorial

6.1 Account setup

Login / Register

To access the API pages, your key and profile on either ALSI or AGSI+, navigate to the
Login page.

The direct links are :


https://agsi.gie.eu/#/api
https://alsi.gie.eu/#/api

Here you have the option to either login (in case you already have an account) or
register. When registering, please do note that you need to consent to GIE to collect data
in order to track your usage of the API service. You can also subscribe to the API specific
newsletter.

Click the ‘forgot password’ link in case you don’t remember your password. You will
receive an e-mail with instructions on how to reset your account and create a new
password.
6.2 API page

After registering or logging in, you will be redirected to the API page. Here you can
update your account settings, subscribe to the newsletter and also remove your account.

To update your password, please enter a new password (no need to click update).

To remove your account, you need to provide the current email and password
combination.
For data providers: Do note that you are unable to remove the account if you logged in
using a data provider user account from the REMIT platform. If you do want to remove
such an account, please send us an e-mail to [email protected].

Below, you will find the searchable EIC code mapping used for AGSI+ / ALSI.

6.3 EIC code mapping

To access the data of a specific country, company or facility, you will require the related
EIC identification codes for your API URL. You can search for it below your account
settings.

Clicking on the EIC code will open a new page showing the url used to retrieve the data.
Example:

Clicking on the company Fluxys EIC code opens up the following page.
6.4 Importing data - cURL

Using the links from the previous pages and your API key, you can send requests to the
API to get the data in JSON format;
curl https://agsi.gie.eu/api/data/21X-BE-A-A0A0A-Y/
BE --header "x-key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

If the API key is not supplied or incorrect, the return value is an error message;

6.5 Importing data – Excel

To access the data from an external source, you need to send the x-key as a parameter
in your header.

When using Excel, you can import the data using;


Data > New Query > From Other Sources > From Web

Then you need the advanced settings;


To extract the data, convert the list to table and click on the double arrows in the table header
to expand the data.

6.6 Illustrative example using a browser

To extract data from the system:

• Click on one of these links:

AGSI+
https://agsi.gie.eu/api/data/eu

ALSI
https://alsi.gie.eu/api/data/eu

• Click “Save As” to download the file. You have just downloaded the values from
the 1 January 2011 (for AGSI+) or 1 January 2012 (for ALSI) till the current day.

The above URLs are illustrating that an API (Application Program Interface) can be used
as nothing more than a Web address, like http://getmesomedata.xml. When you entered
this web address in your browser, the browser retrieves the data you want, just like it
would access a web site. The result can be either viewed within the browser, or saved as
a file on your computer.

JSON web browser plugins

You can use a JSON formatter browser plugin to see the data call results directly in your
browser. For example the JSON formatter for Google Chrome or the JSON Formatter
add-on for Firefox.
6.7 I want to save the result on my computer as an Excel file

You can still download the Excel output using the historical data pages on AGSI+ and
ALSI:
7. REST API parameters
A REST API enables you to filter the data by adding parameters directly to the Web
address, where other systems would require you to go through a series of forms or web
pages.

* IMPORTANT NOTE * The API URLs are case sensitive

Below are some examples on how these can be used:


URL Parameters Description
(agsi.gie.eu | alsi.gie.eu)
/api/data/{eu}
{eu} Aggregated Historical
eu for Europe, ne for data export for Europe
Example: Non Europe or Non Europe
https://agsi.gie.eu/api/data/ne

/api/data/{countryCode}/
Aggregated Historical
{countryCode}
data export for a
2-digit country code
specific country
Example: as found on the API page
https://alsi.gie.eu/api/data/NL

{eic}
/api/data/{eic}/{countryCode} 21-digit eic code of the
company as found on the
Historical data export
API page
for a specific company
Example:
within a country
https://alsi.gie.eu/api/data/ {countryCode}
53XPL000000PLNG6/PL 2-digit country code
as found on the API page
{eic}
21-digit eic code of the
facility as found on the API
page
/api/data/{eic}/{countryCode}/{companyEIC}
Historical data export
{countryCode}
for a specific facility
2-digit country code
Example: from a company within
as found on the API page
https://agsi.gie.eu/api/data/ a country
21W000000000100J/DE/21X000000001368W
{companyEIC}
21-digit eic code of the
company as found on the
API page

What you see is a raw JSON format, which admittedly takes some time getting used to.
We advise you to use a JSON web browser plugin for reading the format easier.
7.1 How do I filter the data set on time range?

You can query the data using the URL parameters. The character “?” separates the body
of the API (the actual URL) from the parameters. You can have as many parameters as
you want.

Parameter Description
from The start date in following format: YYYY-MM-DD

till The stop date in following format: YYYY-MM-DD

limit How much results you need. Ex: 2 will only give 2 rows.

Examples:

We want the data for Europe from 2017-06-01 till 2017-06-14:


https://alsi.gie.eu/api/data/eu?from=2017-06-01&till=2017-06-14

Using a CURL command


curl "https://agsi.gie.eu/api/data/eu?from=2017-06-01&till=2017-06-14" --header "x-key:
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

We want the last 50 reports for Europe from 2017-08-14


https://alsi.gie.eu/api/data/eu?from=2017-08-14&limit=50

We want all reports for Europe till 2015-02-01


https://alsi.gie.eu/api/data/eu?till=2015-02-01

You will notice that a “&” separates these two parameters. Whenever you add a
parameter, you must start with a “&”, then write the parameter name, then the “=” sign,
then the filter you want to use.
8. Document versions
V001

March 2018 – First release

V002

September 2018 – Removal of completeness data field as it is considered obsolete by GIE.

V003

October 2018 – Change of API URLs to accommodate facilities with duplicate EIC codes,
belonging to different companies in the same country.

V004

October 2019 – Addition of Excel tutorial and small document changes; chapters,
repositioning text blocks


IT inquiries

IT Team
for IT implementation
E [email protected]

Data inquiries

GIE Secretariat
for business inquiries (content-related) on Storage & LNG publications
[email protected]
T +32 2 209 05 00

Gas Infrastructure Europe (GIE)


Avenue de Cortenbergh 100
1000 Brussels
Belgium

EU Transparency Register No 76130992074-15

Common questions

Powered by AI

To access and use the AGSI+ and ALSI API, a user must first register on either platform to obtain a personal API key, necessary for API access. The user can update account settings, subscribe to newsletters, and manage subscriptions. For data providers using a REMIT platform account, additional registration is unnecessary. Users should be aware that API URLs are case sensitive and that it is essential to provide the correct API key when accessing data .

The AGSI+ and ALSI platforms provide daily storage and LNG data reporting through their API. However, unavailability reporting is not currently included in the API coverage. The data includes both individual facility datasets and aggregated datasets by company and country level. These are available for export using additional REST API parameters .

When a new facility comes online or a facility undergoes ownership change, a new dataset start or end date is recorded to account for these changes in the historical dataset coverage. Information about new or decommissioned facilities and ownership changes is communicated through service announcements. For facilities that have changed ownership or been decommissioned, historical data remains available with a dedicated code, typically starting with 'PRIOR' .

When using multiple parameters in a REST API query, it's important to separate the body of the API URL from the parameters using a '?' character. Each additional parameter should start with a '&', followed by the parameter name, an '=', and the filter value. Common parameters include 'from' and 'till' for specifying date ranges, and 'limit' for constraining the number of results. The API endpoints are case-sensitive, so users must ensure the correct case is used in their queries .

Technical support for users needing assistance with the API service on AGSI+ and ALSI is provided through contact with the IT team, which can be reached via email at [email protected]. Additionally, data clarification inquiries can be directed to [email protected]. For specific questions about data from a particular SSO or LSO, users may need to contact the operator directly, as GIE cannot speak on their behalf .

REST API parameters in the AGSI+ and ALSI platforms allow users to filter data queries by specifying aspects like the time range, country, or facility EIC code. This parameterization enables users to customize data retrieval tailored to their specific needs without having to navigate through multiple web interfaces. The API supports queries that provide granular control over data selection, enhancing both the efficiency and effectiveness of data access .

Changes to the EIC code database can significantly impact data retrieval from the AGSI+ and ALSI APIs, as these codes are essential for identifying storage system operators and facilities. Updates might occur when facilities change operators or become part of different storage groups. Such changes necessitate adjustments to the API queries by updating the EIC codes used in the URL. Regular updates ensure compliance with REMIT regulations, and users are informed of critical changes through the API mailing list, minimizing disruptions in data access .

EIC codes are used to identify each storage system operator (SSO) and LNG terminal operator within the AGSI+ and ALSI platforms' datasets. These codes are crucial for dataset identification, particularly for REMIT reporting and data provision to GIE. The datasets are mapped using these codes and are subject to updates due to changes in facility operatorship, new operational facilities, or decommissioned ones. These changes necessitate tracking through the API mailing list to stay informed about updates .

The AGSI+ and ALSI API provides improvements over traditional data acquisition methods by allowing for direct, real-time access to databases using user-friendly REST-like interfaces. Unlike needing to manually navigate web pages or download files, users can programmatically query and filter data, leading to increased efficiency and reduced complexity. This API model supports robust data integration into various systems and applications without the need to interact with intermediate web layers .

The API reports on daily storage and LNG data available on the AGSI+ and ALSI platforms. It categorizes the data into individual facility datasets and aggregated datasets, allowing exports at both company and country levels. Unavailability reporting is not yet included in the API coverage. Changes in ownership or facility status, such as decommissioning, are reflected in associated datasets, and these updates are communicated through service announcements .

You might also like