Skip to content

Protocol Documentation¤

Table of Contents¤

Top

frequenz/api/common/v1/grid/delivery_area.proto¤

DeliveryArea¤

DeliveryArea represents the geographical or administrative region, usually defined and maintained by a Transmission System Operator (TSO), where electricity deliveries for a contract occur.

The concept is important to energy trading as it delineates the agreed-upon delivery location. Delivery areas can have different codes based on the// jurisdiction in which they operate.

!!! note "Jurisdictional Differences" This is typically represented by specific codes according to local jurisdiction. In Europe, this is represented by an EIC (Energy Identification Code).

Field Type Label Description
code string Code representing the unique identifier for the delivery area.
code_type EnergyMarketCodeType Type of code used for identifying the delivery area itself.

EnergyMarketCodeType¤

CodeType specifies the type of identification code used for uniquely identifying various entities such as delivery areas, market participants, and grid components within the energy market. This enumeration aims to offer compatibility across different jurisdictional standards.

!!! note "Understanding Code Types" Different regions or countries may have their own standards for uniquely identifying various entities within the energy market. For example, in Europe, the Energy Identification Code (EIC) is commonly used for this purpose.

!!! info "Extensibility" New code types can be added to this enum to accommodate additional regional standards, enhancing the API's adaptability.

!!! caution "Validation Required" The chosen code type should correspond correctly with the code field in the relevant message objects, such as DeliveryArea or Counterparty. Failure to match the code type with the correct code could lead to processing errors.

Name Number Description
ENERGY_MARKET_CODE_TYPE_UNSPECIFIED 0 Unspecified type. This value is a placeholder and should not be used.
ENERGY_MARKET_CODE_TYPE_EUROPE_EIC 1 European Energy Identification Code Standard.
ENERGY_MARKET_CODE_TYPE_US_NERC 2 North American Electric Reliability Corporation identifiers.

Scalar Value Types¤

.proto Type Notes C++ Java Python Go C# PHP Ruby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)