This page documents version 2 of the Get Service Points (SR) endpoint.
Secondary Data Holders (i.e. AEMO) can retire this version after June 14th 2027. Primary data holders (i.e. energy retailers) must update to newer versions prior to this date.
Page size to request. Default is 25 (standard pagination).
x-v
header
string
mandatory
Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the endpoint MUST respond with a 406 Not Acceptable. See HTTP Headers.
x-min-v
header
string
optional
Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the endpoint MUST respond with a 406 Not Acceptable.
x-fapi-interaction-id
header
string
mandatory
The x-fapi-interaction-id header value provided by the Data Recipient. If not supplied by the Data Recipient, the primary Data Holder MUST create a unique [RFC4122] UUID value for the x-fapi-interaction-id header.
x-cds-arrangement
header
string
mandatory
A unique string representing a consent arrangement between a Data Recipient Software Product and Data Holder for a given consumer. The identifier MUST be unique per customer according to the definition of customer in the CDR Federation section of this profile. The x-cds-arrangement should contain the arrangement ID for the consent that the request is being made under and will be used for tracing and audit purposes. This field MUST be populated but AEMO MUST NOT seek to validate the consent associated with the arrangement.
An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400
x-fapi-interaction-id
string
optional
An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406
x-fapi-interaction-id
string
mandatory
An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422
x-fapi-interaction-id
string
mandatory
An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
title
string
mandatory
A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
detail
string
mandatory
A human-readable explanation specific to this occurrence of the problem.
meta
object
conditional
Additional data for customised error codes.
» urn
string
conditional
The CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code.
The independent ID of the service point, known in the industry as the National Meter Identifier (NMI). Note that the servicePointId will be replaced with NMI for all interactions between Data Holder and AEMO.
nationalMeteringId
string
mandatory
The independent ID of the service point, known in the industry as the NMI.
Jurisdiction code to which the service point belongs. This code defines the jurisdictional rules which apply to the service point. Note the details of enumeration values below:
This flag determines whether the energy at this connection point is to be treated as consumer load or as a generating unit (this may include generator auxiliary loads). If absent defaults to false. Note: Only applicable for scheduled or semischeduled generators, does not indicate on site generation by consumer.
A code that defines the consumption threshold as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments. Note the details of enumeration values below:
LOW: Consumption is less than the 'lower consumption threshold' as defined in the National Energy Retail Regulations
MEDIUM: Consumption is equal to or greater than the 'lower consumption threshold', but less than the 'upper consumption threshold', as defined in the National Energy Retail Regulations
HIGH: Consumption is equal to or greater than the 'upper consumption threshold' as defined in the National Energy Retail Regulations.
A code used to identify data loss factor for the service point values. Refer to AEMO distribution loss factor documents for each financial year to interpret.
»» description
string
mandatory
Description of the data loss factor code and value.
»» lossValue
string
mandatory
The value associated with the loss factor code.
» relatedParticipants
[object]
mandatory
none
»» party
string
mandatory
The name of the party/organisation related to this service point.
The metering Installation type code indicates whether the metering installation has to be manually read. Note the details of enumeration values below:
BASIC: Accumulation Meter – Type 6
COMMS1: Interval Meter with communications – Type 1
COMMS2: Interval Meter with communications – Type 2
COMMS3: Interval Meter with communications – Type 3
COMMS4: Interval Meter with communications – Type 4
COMMS4C: CT connected metering installation that meets the minimum services specifications
COMMS4D: Whole current metering installation that meets the minimum services specifications
MRAM: Small customer metering installation – Type 4A
MRIM: Manually Read Interval Meter – Type 5
UMCP: Unmetered Supply – Type 7
VICAMI: A relevant metering installation as defined in clause 9.9C of the NER
NCONUML: Non-contestable unmeter load - Introduced as part of Global Settlement.
»»» manufacturer
string
optional
Free text field to identify the manufacturer of the installed meter.
»»» model
string
optional
Free text field to identify the meter manufacturer's designation for the meter model.
»»» readType
string
optional
Code to denote the method and frequency of Meter Reading. The value is formatted as follows:
First Character = Remote (R) or Manual (M)
Second Character = Mode: T = telephone, W = wireless, P = powerline, I = infra-red, G = galvanic, V = visual
Third Character = Frequency of Scheduled Meter Readings: 1 = Twelve times per year, 2 = Six times per year, 3 = Four times per year, D = Daily or weekly
Optional Fourth Character = to identify what interval length the meter is capable of reading. This includes five, 15 and 30 minute granularity as the following: A = 5 minute, B = 15 minute, C = 30 minute, D = Cannot convert to 5 minute (i.e. due to metering installation de-energised), M = Manually Read Accumulation Meter.
For example,
MV3 = Manual, Visual, Quarterly
MV3M = Manual, Visual, Quarterly, Manually Read Accumulation Meter
This date is the next scheduled meter read date (NSRD) if a manual Meter Reading is required.
»» registers
[object]
optional
Usage data registers available from the meter. This may be empty where there are no meters physically installed at the service point.
»»» registerId
string
mandatory
Unique identifier of the register within this service point. Is not globally unique.
»»» registerSuffix
string
optional
Register suffix of the meter register where the meter reads are obtained.
»»» averagedDailyLoad
number
optional
The energy delivered through a connection point or metering point over an extended period normalised to a 'per day' basis (kWh). This value is calculated annually.
Actual/Subtractive Indicator. Note the details of enumeration values below:
ACTUAL: implies volume of energy actually metered between two dates
CUMULATIVE: indicates a meter reading for a specific date. A second Meter Reading is required to determine the consumption between those two Meter Reading dates.
The independent ID of the service point, known in the industry as the National Meter Identifier (NMI). Note that the servicePointId will be replaced with NMI for all interactions between Data Holder and AEMO.
registerId
string
optional
Register ID of the meter register where the meter reads are obtained.
registerSuffix
string
mandatory
Register suffix of the meter register where the meter reads are obtained.
meterId
string
optional
Meter id/serial number as it appears in customer's bill. ID permanence rules do not apply.
Date when the meter reads end in AEST. If absent then assumed to be equal to readStartDate. In this case the entry represents data for a single date specified by readStartDate.
Read interval length in minutes. Required when interval-reads query parameter equals FULL or MIN_30.
» aggregateValue
number
mandatory
The aggregate sum of the interval read values. If positive then it means net consumption, if negative it means net export.
» intervalReads
[number]
conditional
Array of Interval read values. If positive then it means consumption, if negative it means export. Required when interval-reads query parameter equals FULL or MIN_30. Each read value indicates the read for the interval specified by readIntervalLength beginning at midnight of readStartDate (for example 00:00 to 00:30 would be the first reading in a 30 minute Interval).
» readQualities
[object]
conditional
Specifies quality of reads that are not ACTUAL. For read indices that are not specified, quality is assumed to be ACTUAL. If not present, all quality of all reads are assumed to be actual. Required when interval-reads query parameter equals FULL or MIN_30.
The independent ID of the service point, known in the industry as the National Meter Identifier (NMI). Note that the servicePointId will be replaced with NMI for all interactions between Data Holder and AEMO.
approvedCapacity
number
mandatory
Approved small generating unit capacity as agreed with NSP in the connection agreement, expressed in kVA. Value of 0 indicates no DER record exists for the given servicePointId.
The number of phases available for the installation of DER. Acceptable values are 0, 1, 2 or 3. Value of 0 indicates no DER record exists for the given servicePointId.
The number of phases that DER is connected to. Acceptable values are 0, 1, 2 or 3. Value of 0 indicates no DER record exists for the given servicePointId.
For DER installations where NSPs specify the need for additional forms of protection above those inbuilt in an inverter. If absent then assumed to be false.
protectionMode
object
conditional
Required only when the hasCentralProtectionControl flag is set to true. One or more of the object fields will be provided to describe the protection modes in place.
» exportLimitKva
number
optional
Maximum amount of power (kVA) that may be exported from a connection point to the grid, as monitored by a control/relay function. An absent value indicates no limit.
» underFrequencyProtection
number
optional
Protective function limit in Hz.
» underFrequencyProtectionDelay
number
optional
Trip delay time in seconds.
» overFrequencyProtection
number
optional
Protective function limit in Hz.
» overFrequencyProtectionDelay
number
optional
Trip delay time in seconds.
» underVoltageProtection
number
optional
Protective function limit in V.
» underVoltageProtectionDelay
number
optional
Trip delay time in seconds.
» overVoltageProtection
number
optional
Protective function limit in V.
» overVoltageProtectionDelay
number
optional
Trip delay time in seconds.
» sustainedOverVoltage
number
optional
Sustained over voltage.
» sustainedOverVoltageDelay
number
optional
Sustained Over voltage protection delay in seconds.
» frequencyRateOfChange
number
optional
Rate of change of frequency trip point (Hz/s).
» voltageVectorShift
number
optional
Trip angle in degrees.
» interTripScheme
string
optional
Description of the form of inter-trip (e.g., 'from local substation').
» neutralVoltageDisplacement
number
optional
Trip voltage.
acConnections
[object]
mandatory
none
» connectionIdentifier
number
mandatory
AC Connection ID as defined in the DER register. Does not align with CDR ID permanence standards.
Number of AC Connections in the group. For the suite of AC Connections to be considered as a group, all of the AC Connections included must have the same attributes.
Indicates whether the DER device is connected via an inverter (and what category of inverter it is) or not (e.g., rotating machine). If absent, assume equipment type to be OTHER.
» manufacturerName
string
conditional
The name of the inverter manufacturer. Mandatory if equipmentType is INVERTER.
» inverterSeries
string
conditional
The inverter series. Mandatory if equipmentType is INVERTER.
» inverterModelNumber
string
conditional
The inverter model number. Mandatory if equipmentType is INVERTER.
Code used to indicate the status of the Inverter. This will be used to identify if an inverter is active or inactive or decommissioned.
» inverterDeviceCapacity
number
conditional
The rated AC output power that is listed in the product specified by the manufacturer. Mandatory if equipmentType is INVERTER. Default is 0 if value not known.
» derDevices
[object]
mandatory
none
»» deviceIdentifier
number
mandatory
Unique identifier for a single DER device or a group of DER devices with the same attributes. Does not align with CDR ID permanence standards.
Used to indicate the primary technology used in the DER device.
»» subtype
string
optional
Used to indicate the primary technology used in the DER device. This field is also used to record for example the battery chemistry, or the type of PV panel. It is also used to record if a battery is contained in an electric vehicle connected in a vehicle-to-grid arrangement. If absent then assumed to be "other".
»» nominalRatedCapacity
number
mandatory
Maximum output in kVA that is listed in the product specification by the manufacturer. This refers to the capacity of each unit within the device group. Default is 0 if value not known.
»» nominalStorageCapacity
number
conditional
Maximum storage capacity in kVAh. This refers to the capacity of each storage module within the device group. Mandatory if type is equal to STORAGE. Default is 0 if value not known.
Name of the individual or business formatted for inclusion in an address used for physical mail.
addressLine1
string
mandatory
First line of the standard address object.
addressLine2
string
optional
Second line of the standard address object.
addressLine3
string
optional
Third line of the standard address object.
postcode
string
conditional
Mandatory for Australian addresses.
city
string
mandatory
Name of the city or locality.
state
string
mandatory
Free text if the country is not Australia. If country is Australia then must be one of the values defined by the State Type Abbreviation in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT.
Postal delivery number if the address is a postal delivery type.
postalDeliveryNumberPrefix
string
optional
Postal delivery number prefix related to the postal delivery number.
postalDeliveryNumberSuffix
string
optional
Postal delivery number suffix related to the postal delivery number.
localityName
string
mandatory
Full name of locality.
postcode
string
mandatory
Postcode for the locality.
state
string
mandatory
State in which the address belongs. Valid enumeration defined by Australia Post PAF code file State Type Abbreviation. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT.
The independent ID of the service point, known in the industry as the National Meter Identifier (NMI). Note that the servicePointId will be replaced with NMI for all interactions between Data Holder and AEMO.
The independent ID of the service point, known in the industry as the National Meter Identifier (NMI). Note that the servicePointId will be replaced with NMI for all interactions between Data Holder and AEMO.
