Meter Technical Details Schema Reference

This page summarizes the request and response contract for the Meter Technical Details API.

Request Parameters

Field	Location	Required	Type	Format / Constraints	Notes
X-API-KEY	Header	Yes	string	UUID format	Required on the endpoint.
mpid	Path	Yes	string	Not specified	Supplier MPID used for tenant authorization.
mpan_id	Query	Yes	integer	13 digits in practice	Used to fetch meter IDs for a single MPAN.
as_of	Query	No	string(date or datetime)	ISO 8601 date or datetime	Returns historical MTD snapshot for the timestamp/date provided.

Response Schema (MTDResponseSchema)

Field	Required	Type	Format / Constraints	Notes
mpan_core	Yes	integer	13 digits in practice	MPAN core linked to the meter.
meter_id	Yes	string	Max 10 chars	Physical meter identifier / serial number.
meter_type	No	MeterTypeSchema or null	See below	Market segment, connection type, meter type, and meter group metadata.
manufacturer	No	string or null	Not specified	Meter manufacturer.
meter_installation_datetime	No	string(datetime) or null	ISO 8601 datetime	Meter install timestamp.
meter_location	No	string or null	Single character	Meter location code.
meter_removal_datetime	No	string(datetime) or null	ISO 8601 datetime	Meter removal timestamp.
effective_from_settlement_date_msmtd	No	string(date) or null	ISO 8601 date (YYYY-MM-DD)	Effective-from settlement date from the selected MTD version.
hh_mtd	No	HHMTDResponse or null	See below	Present for HH meters.
nhh_mtd	No	NHHMTDResponse or null	See below	Present for NHH meters.

Additional behavior:

• Meter register arrays are filtered to registers owned by the requested MPAN.

MeterTypeSchema

Field	Required	Type	Format / Constraints
market_segment	Yes	string	Not specified
connection_type	Yes	string	Not specified
meter_type	Yes	string	Not specified
meter_group	No	string or null	One of Traditional, Smart, Advanced, Unmetered

HH-specific shape (HHMTDResponse)

Representative fields and constraints:

• meter_cop: string, max 3.
• meter_cop_issue_number: integer, 0-99.
• complex_site_indicator: boolean.
• meter_equipment_location: string, max 30.
• system_voltage: integer, 0-999999.
• number_of_phases: integer, 0-3.
• additional_information: string, max 200.
• current_rating: integer, 0-999.
• communications_method: string, max 2.
• communications_address: string, max 20.
• sim_serial_number: string, max 25.
• sequence_mpan_core: integer, 13 digits when present.
• meter_registers: array of HHMRDResponse.

HH register shape (HHMRDResponse)

Field	Required	Type	Format / Constraints
meter_register_id	Yes	string	Max 2
outstation_id	Yes	string	Max 20
channel_number	Yes	string	Max 3
pulse_multiplier	Yes	number	No explicit min/max
meter_register_multiplier	Yes	number	No explicit min/max
outstation_multiplier	Yes	number	No explicit min/max
measurement_quantity_id	Yes	string	Max 2
number_of_register_digits	Yes	integer	0-9
associated_meter_id	No	string or null	Max 10
associated_meter_register_id	No	string or null	Max 2

NHH-specific shape (NHHMTDResponse)

Representative fields and constraints:

• meter_cop: string, max 3.
• meter_cop_dispensation: integer, 0-999.
• current_rating: integer, 0-999.
• meter_asset_provider_id: string, max 4.
• communications_method: string, max 2.
• outstation_pin: string, max 12.
• outstation_cop: string, max 20.
• outstation_type: string, max 3.
• retrieval_method: string, max 1.
• displayed_register_digits: integer, 0-9.
• meter_registers: array of NHHMRDResponse.

NHH register shape (NHHMRDResponse)

Field	Required	Type	Format / Constraints
meter_register_id	No	string or null	Max 2
type	No	string or null	Max 1
measurement_quantity_id	No	string or null	Max 2
multiplier	No	number or null	No explicit min/max
main_check_indicator	No	boolean or null	N/A
register_digits	No	integer or null	0-9
time_pattern_regime	No	string or null	Max 5
register_mapping_coefficient	No	number or null	No explicit min/max
associated_meter_id	No	string or null	Max 10
associated_meter_register_id	No	string or null	Max 2