Help Files:

Data Service

Introduction

The Data service is used to download data.

User Restrictions

You must have enprompt privileges to access this data.

Calling the Service

The parameters used when calling the service are as follows:

Code Required / Optional Description
username Required The user name
password Required The password
format Required The type of format required
action Required The type of action required
more ... Optional Depending on the action selected there will be more options.

Specific Details on a per Action Basis

Dependent on the action, the request parameters and response are different. The table below specifies the actions that are supported.

Action Description
charts Get Available Charts.
resolutions Get Available Resolutions.
formats Get Available Formats.
data Get Data.

> action=charts

Getting the list of available charts.

https://enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=charts

> action=resolutions

Getting the list of available resolutions.

https://enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=resolutions

> action=formats

Getting the list of available formats.

https://enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=formats

> action=entities

Getting entity information for plants in the market.

https://enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=entities

> action=fueltypes

Getting Fuel Type meta information.

https://enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=fueltypes

> action=locations

Getting Location meta information.

https://enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=locations

> action=data

SUMMARY SCREENS : Accepted Actions

The data for the Accepted Actions table can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required accactions
format Required The type of format. The value could be xml or csv. (See 'formats' action)
targettime Required The time selection (as in the URL on the matching charts), e.g. live or 0 to be current period or -2 to be current period minus two

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=accactions&targettime=live

SUMMARY SCREENS : Accepted BSAD

The data for the Accepted BSAD table can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required accbsad
format Required The type of format. The value could be xml or csv. (See 'formats' action)
targettime Required The time selection (as in the URL on the matching charts), e.g. live or 0 to be current period or -2 to be current period minus two
bsadtype Optional The level of detail to show (as in the URL on the matching charts), e.g. 0 (summarised values) or 1 (full detail)

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=accbsad&targettime=live&bsadtype=0

SUMMARY SCREENS : Activity Feed

The data for the Activity Feed can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required activityfeed
format Required The type of format. The value could be xml or csv. (See 'formats' action)
gmtupdatetime Required The time in (GMT) to get from (this will filter all entries before this time.

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=activityfeed&gmtupdatetime=20200512163245

SUMMARY SCREENS : Bid Table

The data for the Bid Table can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required bidtable
format Required The type of format. The value could be xml or csv. (See 'formats' action)
targettime Required The time selection (as in the URL on the matching charts), e.g. live or 0 to be current period or -2 to be current period minus two

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=bidtable&targettime=0

SUMMARY SCREENS : Bid to SEL Table

The data for the Bid to SEL Table can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required bidtoseltable
format Required The type of format. The value could be xml or csv. (See 'formats' action)
targettime Required The time selection (as in the URL on the matching charts), e.g. live or 0 to be current period or -2 to be current period minus two

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=bidtoseltable&targettime=0

SUMMARY SCREENS : Offer On Table

The data for the Offer On Table can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required offerontable
format Required The type of format. The value could be xml or csv. (See 'formats' action)
targettime Required The time selection (as in the URL on the matching charts), e.g. live or 0 to be current period or -2 to be current period minus two

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=offerontable&targettime=0

SUMMARY SCREENS : Offer Table

The data for the Offer Table can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required offertable
format Required The type of format. The value could be xml or csv. (See 'formats' action)
targettime Required The time selection (as in the URL on the matching charts), e.g. live or 0 to be current period or -2 to be current period minus two

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=offertable&targettime=0

SUMMARY SCREENS : Submitted Bids

The data for the Submitted Bids can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required submittedbids
format Required The type of format. The value could be xml or csv. (See 'formats' action)
targettime Required The time selection (as in the URL on the matching charts), e.g. live or 0 to be current period or -2 to be current period minus two
capped Optional If 0 (default) will show bids capped by FPN else will show the full declared prices and volumes (capped=1)

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=submittedbids&targettime=0&capped=0

SUMMARY SCREENS : Submitted Offers

The data for the Submitted Offers can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required submittedoffers
format Required The type of format. The value could be xml or csv. (See 'formats' action)
targettime Required The time selection (as in the URL on the matching charts), e.g. live or 0 to be current period or -2 to be current period minus two
capped Optional If 0 (default) will show offers capped by FPN / MEL else will show the full declared prices and volumes (capped=1)

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=submittedoffers&targettime=0&capped=0

AVAILABILITY : System Margin Summary

The data for the System Margin Summary chart can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required systemmarginoverall
update Optional If false will always return data, else will return no data message if no change since submitted time
gmtupdatetime Required if update=true If update=true must put in the time of the last update. Can use the top field timestamp="2018-06-20T08:46:51" to get the last check time and then this feature can be used to only get data when a change has occurred.
format Required The type of format. The value could be xml or csv. (See 'formats' action)
series_to_plot Optional The type of aggregation to use, e.g. fuel or offerprice (see chart URL for more types). Defaults to fuel if missing.
spinningreserve Optional Whether spinning reserve only (1) or not (0). Defaults to 0 (all margin).

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=systemmarginoverall&update=false&series_to_plot=offerprice&spinningreserve=1

BALANCING MECHANISM : Bid to SEL Volumes Summary

The data for the Bid to SEL Volumes Summary chart can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required bidtoseloverall
update Optional If false will always return data, else will return no data message if no change since submitted time
gmtupdatetime Required if update=true If update=true must put in the time of the last update. Can use the top field timestamp="2018-06-20T08:46:51" to get the last check time and then this feature can be used to only get data when a change has occurred.
format Required The type of format. The value could be xml or csv. (See 'formats' action)
series_to_plot Optional The type of aggregation to use, e.g. fuel or bidprice (see chart URL for more types). Defaults to fuel if missing.

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=bidtoseloverall&update=false&series_to_plot=bidprice

BALANCING MECHANISM : Bid Volumes Summary

The data for the Bid Volumes Summary chart can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required bidvoloverall
update Optional If false will always return data, else will return no data message if no change since submitted time
gmtupdatetime Required if update=true If update=true must put in the time of the last update. Can use the top field timestamp="2018-06-20T08:46:51" to get the last check time and then this feature can be used to only get data when a change has occurred.
format Required The type of format. The value could be xml or csv. (See 'formats' action)
series_to_plot Optional The type of aggregation to use, e.g. fuel or bidprice (see chart URL for more types). Defaults to fuel if missing.

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=bidvoloverall&update=false&series_to_plot=bidprice

BALANCING MECHANISM : Bid/Offer Prices

The data for the Bid/Offer Prices chart can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required boprice
update Optional If false will always return data, else will return no data message if no change since submitted time
gmtupdatetime Required if update=true If update=true must put in the time of the last update. Can use the top field timestamp="2018-06-20T08:46:51" to get the last check time and then this feature can be used to only get data when a change has occurred.
format Required The type of format. The value could be xml or csv. (See 'formats' action)
targettime Required The time selection (as in the URL on the matching charts), e.g. live or 0 for current period or -2 for current period minus 2
accdecl Required Whether for accepted actions (0) or declared ones (1)
fuel Optional If not set (or equal to all) will show the summary values by fuel, else if set for battery, biomass, ccgt, coal, hydro, nuclear, ocgt, ps or wind this will show the values for each of the units of the given fuel types. The tags are as in the URL once an option has been picked on the chart view.

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=boprice&update=false&targettime=live&accdecl=0&fuel=all

BALANCING MECHANISM : Bid/Offer Volumes

The data for the Bid/Offer Volumes chart can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required bovol
update Optional If false will always return data, else will return no data message if no change since submitted time
gmtupdatetime Required if update=true If update=true must put in the time of the last update. Can use the top field timestamp="2018-06-20T08:46:51" to get the last check time and then this feature can be used to only get data when a change has occurred.
format Required The type of format. The value could be xml or csv. (See 'formats' action)
targettime Required The time selection (as in the URL on the matching charts), e.g. live or 0 for current period or -2 for current period minus 2
accdecl Required Whether for accepted actions (0) or declared ones (1)
fuel Optional If not set (or equal to all) will show the summary values by fuel, else if set for battery, biomass, ccgt, coal, hydro, nuclear, ocgt, ps or wind this will show the values for each of the units of the given fuel types. The tags are as in the URL once an option has been picked on the chart view.

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=bovol&update=false&targettime=live&accdecl=0&fuel=all

BALANCING MECHANISM : Bid/Offer Volumes Summary

The data for the Bid/Offer Volumes Summary chart can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required bidoffvoloverall
update Optional If false will always return data, else will return no data message if no change since submitted time
gmtupdatetime Required if update=true If update=true must put in the time of the last update. Can use the top field timestamp="2018-06-20T08:46:51" to get the last check time and then this feature can be used to only get data when a change has occurred.
format Required The type of format. The value could be xml or csv. (See 'formats' action)
series_to_plot Optional The type of aggregation to use, e.g. fuel or bidprice (see chart URL for more types). Defaults to fuel if missing.

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=bidoffvoloverall&update=false&series_to_plot=bidprice

BALANCING MECHANISM : Offer Volumes Summary

The data for the Offer Volumes Summary chart can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required offervoloverall
update Optional If false will always return data, else will return no data message if no change since submitted time
gmtupdatetime Required if update=true If update=true must put in the time of the last update. Can use the top field timestamp="2018-06-20T08:46:51" to get the last check time and then this feature can be used to only get data when a change has occurred.
format Required The type of format. The value could be xml or csv. (See 'formats' action)
series_to_plot Optional The type of aggregation to use, e.g. fuel or offerprice (see chart URL for more types). Defaults to fuel if missing.

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=offervoloverall&update=false&series_to_plot=offerprice

GENERATION : BM Unit Operations

The data for the BM Unit Operations chart can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required bmops
update Optional If false will always return data, else will return no data message if no change since submitted time
gmtupdatetime Required if update=true If update=true must put in the time of the last update. Can use the top field timestamp="2018-06-20T08:46:51" to get the last check time and then this feature can be used to only get data when a change has occurred.
format Required The type of format. The value could be xml or csv. (See 'formats' action)
bmunitid Required The ID of the unit to get data for, e.g. T_ABTH7. This will be as on the URL when in chart view.

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=bmops&update=false&fuel=all&bmunitid=T_ABTH7

GENERATION : Generation & Availability

The data for the Generation & Availability chart can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required gaa
update Optional If false will always return data, else will return no data message if no change since submitted time
gmtupdatetime Required if update=true If update=true must put in the time of the last update. Can use the top field timestamp="2018-06-20T08:46:51" to get the last check time and then this feature can be used to only get data when a change has occurred.
format Required The type of format. The value could be xml or csv. (See 'formats' action)
targettime Required The time selection (as in the URL on the matching charts), e.g. live or 0 for current period or -2 for current period minus 2
fuel Optional If not set (or equal to all) will show the summary values by fuel, else if set for battery, biomass, ccgt, coal, hydro, nuclear, ocgt, ps or wind this will show the values for each of the units of the given fuel types. The tags are as in the URL once an option has been picked on the chart view.

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=gaa&update=false&targettime=live&fuel=all

GENERATION : Interconnector Flows

The data for the Interconnector Flows chart can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required interflows
update Optional If false will always return data, else will return no data message if no change since submitted time
gmtupdatetime Required if update=true If update=true must put in the time of the last update. Can use the top field timestamp="2018-06-20T08:46:51" to get the last check time and then this feature can be used to only get data when a change has occurred.
format Required The type of format. The value could be xml or csv. (See 'formats' action)
inter Required The interconnector to plot for (look at URL from charts to pair ids with interconnectors). IDs are 0 (BritNed), 1 (East-West), 2 (French), 3 (Moyle), 4 (Nemo), 5 (IFA2), 6 (NSL), 7 (Eleclink) and 8 (Viking).

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=interflows&update=false&inter=0

GENERATION : System Generation Summary

The data for the System Generation Summary chart can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required systemgenoverall
update Optional If false will always return data, else will return no data message if no change since submitted time
gmtupdatetime Required if update=true If update=true must put in the time of the last update. Can use the top field timestamp="2018-06-20T08:46:51" to get the last check time and then this feature can be used to only get data when a change has occurred.
format Required The type of format. The value could be xml or csv. (See 'formats' action)

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=systemgenoverall&update=false

IMBALANCES : Imbalance (Trip) Summary

The data for the Imbalance (Trip) Summary chart can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required systemimbalanceoverall
update Optional If false will always return data, else will return no data message if no change since submitted time
gmtupdatetime Required if update=true If update=true must put in the time of the last update. Can use the top field timestamp="2018-06-20T08:46:51" to get the last check time and then this feature can be used to only get data when a change has occurred.
format Required The type of format. The value could be xml or csv. (See 'formats' action)

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=systemimbalanceoverall&update=false

IMBALANCES : Imbalance (Trip) Table

The data for the Imbalance (Trip) Table table can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required triptable
format Required The type of format. The value could be xml or csv. (See 'formats' action)
targettime Required The time selection (as in the URL on the matching charts), e.g. live or 0 to be current period or -2 to be current period minus two

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=triptable&targettime=live

IMBALANCES : Imbalances

The data for the Imbalances chart can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required imbal
update Optional If false will always return data, else will return no data message if no change since submitted time
gmtupdatetime Required if update=true If update=true must put in the time of the last update. Can use the top field timestamp="2018-06-20T08:46:51" to get the last check time and then this feature can be used to only get data when a change has occurred.
format Required The type of format. The value could be xml or csv. (See 'formats' action)
targettime Required The time selection (as in the URL on the matching charts), e.g. live or 0 for current period or -2 for current period minus 2
fuel Optional If not set (or equal to all) will show the summary values by fuel, else if set for battery, biomass, ccgt, coal, hydro, nuclear, ocgt, ps or wind this will show the values for each of the units of the given fuel types. The tags are as in the URL once an option has been picked on the chart view.

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=imbal&update=false&targettime=live&fuel=all

SYSTEM : Derated Margin Progression

The data for the Derated Margin Progression chart can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required deratedmargin
update Optional If false will always return data, else will return no data message if no change since submitted time
gmtupdatetime Required if update=true If update=true must put in the time of the last update. Can use the top field timestamp="2018-06-20T08:46:51" to get the last check time and then this feature can be used to only get data when a change has occurred.
format Required The type of format. The value could be xml or csv. (See 'formats' action)

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=deratedmargin&update=false

SYSTEM : Frequency

The data for the Frequency chart can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required freq
update Optional If false will always return data, else will return no data message if no change since submitted time
gmtupdatetime Required if update=true If update=true must put in the time of the last update. Can use the top field timestamp="2018-06-20T08:46:51" to get the last check time and then this feature can be used to only get data when a change has occurred.
format Required The type of format. The value could be xml or csv. (See 'formats' action)

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=freq&update=false

SYSTEM : Inertia Estimate

The data for the Inertia Estimate chart can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required inertia
update Optional If false will always return data, else will return no data message if no change since submitted time
gmtupdatetime Required if update=true If update=true must put in the time of the last update. Can use the top field timestamp="2018-06-20T08:46:51" to get the last check time and then this feature can be used to only get data when a change has occurred.
format Required The type of format. The value could be xml or csv. (See 'formats' action)

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=inertia&update=false

SYSTEM : NIV Analysis

The data for the NIV Analysis chart can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required pricingscreen
update Optional If false will always return data, else will return no data message if no change since submitted time
gmtupdatetime Required if update=true If update=true must put in the time of the last update. Can use the top field timestamp="2018-06-20T08:46:51" to get the last check time and then this feature can be used to only get data when a change has occurred.
format Required The type of format. The value could be xml or csv. (See 'formats' action)

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=pricingscreen&update=false

SYSTEM : System Fuel Mix

The data for the System Fuel Mix chart can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required systemfuelmix
update Optional If false will always return data, else will return no data message if no change since submitted time
gmtupdatetime Required if update=true If update=true must put in the time of the last update. Can use the top field timestamp="2018-06-20T08:46:51" to get the last check time and then this feature can be used to only get data when a change has occurred.
format Required The type of format. The value could be xml or csv. (See 'formats' action)

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=systemfuelmix&update=false

SYSTEM : System Summary

The data for the System Summary chart can be extracted from the API. The parameters are as follows:


Code Required/Optional Description
chart Required systemsummary
update Optional If false will always return data, else will return no data message if no change since submitted time
gmtupdatetime Required if update=true If update=true must put in the time of the last update. Can use the top field timestamp="2018-06-20T08:46:51" to get the last check time and then this feature can be used to only get data when a change has occurred.
format Required The type of format. The value could be xml or csv. (See 'formats' action)

Example :

enprompt.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=systemsummary&update=false