Entrix API (1.1.0)

The Entrix API provides the following two-step authentication process to protect access to its resources and operations:

1. API Key & Client Id:

   • The API key and Client id will be provided by Entrix as part of the integration.

2. Access Token:

   • The access token is a string that contains the credentials and permissions needed to access a resource.
   • Providing a valid API key and Client id allows you to generate a short-lived 1 hour access token using the Generate new Access Token method.This process provides partners with a convenient and secure way to access their resources and operations.

Note: This limited lifespan helps to prevent unauthorized access to resources and ensures that access is only granted to authorized parties.

This endpoint returns the asset's forecast data for each delivery period with a 15-minute granularity. The forecast provides key insights into energy capacity, power limits, and availability for a given delivery period.

Note: If delivery day is not provided, the forecast of the next 104 hours will be returned.

Forecast Details

The response includes the following fields:

• delivery_start (str, UTC ISO 8601)
  Start time of the forecast period. Example: "2025-06-01T14:15:00Z".

• delivery_end (str, UTC ISO 8601)
  End time of the forecast period. Example: "2025-06-01T14:30:00Z".

• delivery_day (str, YYYY-MM-DD)
  The date of the forecast period. Example: "2025-06-01".

• reserved (bool)
  Indicates whether the asset is reserved (True/False).

• max_state_of_energy (float, MWh)
  The asset maximum state of energy.

• min_state_of_energy (float, MWh)
  The asset minimum state of energy.

• charge_power_capacity (float, MW)
  Maximum power capacity available for charging.

• discharge_power_capacity (float, MW)
  Maximum power capacity available for discharging.

• customer_limitations
  Any customer-imposed limitations on asset usage if exists -> if set to null, no customer limitations are applied.

• dispatch_schedule
  The dispatch schedule for the asset. This info will be available only for reserved days.

Usage

This forecast helps partners optimize energy scheduling, and ensure compliance with asset physical limits and customer imposed limitations.

This endpoint provides real-time status information for a specific asset, including energy capacity, power limits, dispatch power, and state of charge (SoC).

State Details

The response includes the following fields:

• asset_id (str)
  Unique identifier for the asset. Example: "DE_50HZ_IS_1".

• max_state_of_energy (float, MWh)
  The asset current maximum state of energy.

• min_state_of_energy (float, MWh)
  The asset current minimum state of energy.

• charge_power_capacity (float, MW)
  Current Maximum power capacity available for charging.

• discharge_power_capacity (float, MW)
  Current Maximum power capacity available for discharging.

• dispatch_power (float, MW)
  The current dispatch power of the asset.

• soc (float, MWH)
  The state of charge (SoC) of the asset in MWH at the time of the request.

Usage

This API allows partners to monitor asset availability, plan energy dispatch, and ensure operational efficiency.

Functionality:

This API enables customers to limit asset dispatch -> It applies power limitations to an asset for a specified time period, adjusting both charge and discharge power limits.

Note: Power limitations should be applied to all delivery periods between specified start and end time.

Validations:

• Start and End must be UTC timestamps.
• The start timestamp must be earlier than the end timestamp.
• The start and end timestamps must align with a valid delivery period, meaning the minutes value should be one of: 00, 15, 30, or 45.
• max_charge and max_discharge should not be negative.
• If max_charge or max_discharge exceed the asset's physical limits, the asset's physical limits will be applied instead.

This API enables customers to cancel their limitations for a specified time period.

Note: limitations should be cancelled for all delivery periods between specified start and end time.

Validations:

• Start and End must be UTC timestamps.
• Start must be at least 7 minutes in the future.
• The start timestamp must be earlier than the end timestamp.
• The start and end timestamps must align with a valid delivery period, meaning the minutes value should be one of: 00, 15, 30, or 45.

Returns a list of all customer limitations details for a specified time period.

Validations:

• Start and End must be UTC timestamps.
• The start timestamp must be earlier than the end timestamp.

Returns a summary of how often asset dispatch has been limited within a calendar year, including weighted calculations for short-term interventions.

Note: if year is not specified, the usage history of the current year is provided.

This API Allows a customer to reserve and take control of an asset for a specific delivery day.

Note: This request ensures that the SoC at the start of delivery day is within the specified range -> default between 20% and 40%.

Note: Asset Reservation could be canceled up until 7:00 AM of previous day (D -1), after that the reservation is considered as final.

Note: Customers exceeding their maximum allowed usage of the reservation feature are not blocked, but this is flagged for later resolution based on contractual agreements.

Validations:

• delivery_day must be in the future.

This API Allows a customer to cancel asset reservations he made.

Note: Asset Reservation could be canceled up until 7:00 AM of previous day (D -1), after that the reservation is considered as final.

Validations:

• delivery_day must be in the future.

This API Allows the customer to submit a dispatch schedule for an asset on a reserved day. The schedule consists of power-time pairs defining the asset’s operation at a 15-minute resolution.

Note: Asset Dispatch schedule can only be sent after 7:00 AM of previous day (D -1), after that the reservation is considered as final.

Note: The dispatch schedule submitted by the customer must be sent at least 7 minutes before the start of the first delivery period indicated in the schedule. Schedules that do not meet this requirement will be rejected.

Note: If dispatch power would result in the violation of the asset physical limits, the dispatch schedule will be corrected according to asset physical limits.

Conventions:

• Each item of the schedule is a signed power-time pairs in megawatts on a left-aligned 15-minute cadence. i.e., {“dispatch_power”: 0.1, “delivery_start”: “2025-07-01T14:30:00Z”} represents an instruction to discharge at 100 kW between 2025-07-01T14:30:00Z and 2025-07-01T14:45:00Z
• For dispatch_power, Positive values indicate discharge, negative values indicate charging

Validations:

• delivery_start must be UTC timestamps.
• The delivery_start timestamps must align with a valid delivery period, meaning the minutes value should be one of: 00, 15, 30, or 45.

Returns asset revenues by delivery period

Functionality:

This endpoint is used by a third party to access all the nominations between his Balancing Group and the Entrix Balancing Group.

Note: Wholesale nominations data should be available latest by 03:30 local time (CET).

Note: Ancillary Services (aFRRe) nominations data should be available latest by 09:55 local time (CET). The aFRRe volumes are summed to the wholesale volumes.

Note: gzip and br are the only supported compression methods.

This API Allows the customer to send a schedule for the specified asset. The schedule consists of power-time pairs defining the asset’s operation at a 15-minute resolution.

Note: Only delivery periods specified in the request will be affected.

Note: A new successful schedule submission will result in replacing the quantities of the specified delivery periods completely.

Note: If schedule would result in the violation of the asset physical limits, The schedule will be rejected.

Conventions:

• Each item of the schedule is a signed power-time pairs in megawatts on a left-aligned 15-minute cadence. i.e., {“quantity”: 0.1, “delivery_start”: “2025-07-01T14:30:00Z”} represents an instruction to discharge at 100 kW between 2025-07-01T14:30:00Z and 2025-07-01T14:45:00Z
• For quantity, Positive values indicate discharge or selling energy, negative values indicate charging or buying energy.

Validations:

• delivery_start must be UTC timestamps.
• The delivery_start timestamps must align with a valid delivery period, meaning the minutes value should be one of: 00, 15, 30, or 45.
• All delivery periods within schedule must fall within the delivery day for which the DAA schedule is sent in case of daa_swap schedule type.

This API Allows the customer to get the schedule for the specified asset. The schedule consists of power-time pairs defining the asset’s operation at a 15-minute resolution. it also provides information about the expected SoC and the cumulative discharged energy at the end of each delivery period.

Note: All delivery periods of the specified delivery day will be returned.

Note: Both the predicted SoC and discharge energy represent values at the end of the delivery period, i.e., after the traded quantity has been dispatched by the asset.

Conventions:

• Each item of the schedule is a signed power-time pairs in megawatts on a left-aligned 15-minute cadence. i.e., {“quantity”: 0.1, “delivery_start”: “2025-07-01T14:30:00Z”} represents an instruction to discharge at 100 kW between 2025-07-01T14:30:00Z and 2025-07-01T14:45:00Z
• For quantity, Positive values indicate discharge or selling energy, negative values indicate charging or buying energy.
• SoC values (in MWH) are the expected SoC values based on the quantities submitted during that delivery period.
• Cumulative discharge energy values (in MWH) are the expected values based on the quantities submitted during that delivery period.
• Last delivery period SoC represents the expected SoC at the end of the delivery day, which also represents the SoC at the start of next delivery day.