Skip to content

market_location_pb2

frequenz.api.common.v1alpha8.grid.market_location_pb2 ¤

Generated protocol buffer code.

Attributes¤

frequenz.api.common.v1alpha8.grid.market_location_pb2.MARKET_LOCATION_ID_TYPE_CUPS module-attribute ¤

CUPS: Spain — Código Universal de Punto de Suministro.

frequenz.api.common.v1alpha8.grid.market_location_pb2.MARKET_LOCATION_ID_TYPE_EAN module-attribute ¤

EAN: Continental Europe (e.g. FR (legacy), NL, BE, PL, CZ, HU, ...) — European Article Number.

frequenz.api.common.v1alpha8.grid.market_location_pb2.MARKET_LOCATION_ID_TYPE_ESI_ID module-attribute ¤

ESI_ID: United States – Electric Service Identifier.

frequenz.api.common.v1alpha8.grid.market_location_pb2.MARKET_LOCATION_ID_TYPE_GSRN module-attribute ¤

GSRN: Nordic countries (e.g., DK, SE, NO, FI) — GS1 Global Service Relation Number.

frequenz.api.common.v1alpha8.grid.market_location_pb2.MARKET_LOCATION_ID_TYPE_ICP module-attribute ¤

ICP: New Zealand — Installation Control Point.

frequenz.api.common.v1alpha8.grid.market_location_pb2.MARKET_LOCATION_ID_TYPE_MALO_ID module-attribute ¤

MALO_ID: Germany – Marktlokations-ID (MaLo-ID).

frequenz.api.common.v1alpha8.grid.market_location_pb2.MARKET_LOCATION_ID_TYPE_MPAN module-attribute ¤

MPAN: United Kingdom – Meter Point Administration Number.

frequenz.api.common.v1alpha8.grid.market_location_pb2.MARKET_LOCATION_ID_TYPE_NMI module-attribute ¤

NMI: Australia – National Metering Identifier.

frequenz.api.common.v1alpha8.grid.market_location_pb2.MARKET_LOCATION_ID_TYPE_OTHER module-attribute ¤

OTHER: Generic meter identifier for markets not modeled explicitly yet.

frequenz.api.common.v1alpha8.grid.market_location_pb2.MARKET_LOCATION_ID_TYPE_POD module-attribute ¤

POD: Italy — Point of Delivery.

frequenz.api.common.v1alpha8.grid.market_location_pb2.MARKET_LOCATION_ID_TYPE_PRM module-attribute ¤

PRM: France — Point de Référence et Mesure (PRM).

frequenz.api.common.v1alpha8.grid.market_location_pb2.MARKET_LOCATION_ID_TYPE_SPN module-attribute ¤

SPN: Japan — Supply Point Number (需要地点特定番号).

frequenz.api.common.v1alpha8.grid.market_location_pb2.MARKET_LOCATION_ID_TYPE_UNSPECIFIED module-attribute ¤

UNSPECIFIED: Default unspecified value — must not be used.

frequenz.api.common.v1alpha8.grid.market_location_pb2.MARKET_LOCATION_ID_TYPE_ZAEHLPUNKT module-attribute ¤

ZAEHLPUNKT: Austria – Zählpunktbezeichnung (Semantically similar to Germany’s MaLo-ID).

Classes¤

frequenz.api.common.v1alpha8.grid.market_location_pb2.MarketLocation ¤

Bases: Message

Identifies a Market Location in a specific market area.

A Market Location is the official market-facing identifier used for settlement, billing, balancing-group allocation, portfolio aggregation, and grid-operator reporting.

Examples include: - Germany: MaLo-ID - UK: MPAN - Australia: NMI - US: ESI-ID

Attributes¤
market_area instance-attribute ¤

Market area in which the Market Location is registered.

Methods:¤
market_location_id() ¤

Official Market Location identifier.

frequenz.api.common.v1alpha8.grid.market_location_pb2.MarketLocationId ¤

Bases: Message

Market-standard identifier describing a Market Location.

A Market Location is a jurisdiction-specific point of metering used for regulatory processes such as settlement, billing, supplier switching, balancing-group reconciliation, and DSO/TSO reporting. Different markets use incompatible identifier formats—varying in length, character sets, checksum rules, and decomposition.

This message encapsulates the official, market-issued identifier used to reference such a point. Examples: • Germany: MaLo-ID (Marktlokations-ID) • UK: MPAN (Meter Point Administration Number) • US: ESI-ID (Electric Service Identifier) • Australia NMI (National Metering Identifier)

Different markets use incompatible identifier formats—varying in length, character sets, checksum rules, and presentation formatting (spaces, hyphens, prefixes).

Example values for different markets

The following examples illustrate how the fields may be populated for different jurisdictions:

Market:Type Official ID Normalized Value
DE:MALO_ID "12345678901" "12345678901"
UK:MPAN "18 1066 1234 567 8901 234" "18106612345678901234"
US_ERCOT:ESI_ID "10443720000012345" "10443720000012345"
AU:NMI "NEM12-03456-A" "NEM1203456A"

In each case, value preserves the original format as provided by the market operator, while normalized_value is an implementation-specific cleaned representation suitable for validation, indexing, and comparisons.

Attributes¤
type instance-attribute ¤

Identifies what type of official market identifier id represents.

Methods:¤
id() ¤

Official market location identifier.

frequenz.api.common.v1alpha8.grid.market_location_pb2.MarketLocationIdType ¤

Bases: _MarketLocationIdType

Identifies the type of external market identifier used to reference a Market Location in a specific regulatory regime.

The identifier type defines the format, validation rules, and semantics of the identifier value. Jurisdictional applicability is modeled separately via MarketArea.

Identifier regimes, not countries

Some identifier types (e.g. EAN, ESI_ID) are used across multiple jurisdictions. This enum models identifier formats, not geography.

frequenz.api.common.v1alpha8.grid.market_location_pb2.MarketLocationIdValue ¤

Bases: Message

Opaque identifier in its original market format as received from the source system (MSCONS, DataHub, CSV, manual entry, etc.).

The service accepts both formatted and already-normalized values. Formatting characters (spaces, hyphens, prefixes) are ignored during validation. Validation is performed exclusively on a canonical normalized form derived from the input value, based on the type.

Clients MUST NOT rely on formatting differences to distinguish identifiers.

Examples:

  • "01234567890" (Germany MaLo)
  • "18 1066 1234 567 8901 234" (UK MPAN with spaces)
  • "NEM12-03456-A" (AU NMI with hyphens)
Attributes¤
value instance-attribute ¤

Official market location identifier.