The Consumer Data Right (CDR) APIs allow Registered Financially Responsible Market Participants (FRMPs) to service API requests for AEMO data from Accredited Data Recipients.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"10032049","collectionId":"a163461f-0594-434b-b934-2ceb03e93f65","publishedId":"2s93CNNDaK","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-02-24T05:20:29.000Z"},"item":[{"name":"Get DER For Specific ServicePoints","id":"fac77bf9-4c82-4b4b-8496-ef637566a1e8","protocolProfileBehavior":{"disabledSystemHeaders":{"accept-encoding":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"(Required) The participant ID who the request is from.
\n","key":"X-initiatingParticipantId","value":"{{X-initiatingParticipantId}}"},{"description":"(Required) Version of the API supported by AEMO.e.g 1
\n","key":"x-v","value":"{{x-v}}"},{"description":"Minimum Version of the API supported by AEMO.e.g 1
\n","key":"x-min-v","value":"{{x-min-v}}"},{"description":"(Required) The x-fapi-interaction-id is supplied for end to end tracing. If the ADR has not populated this on their API call to the retailer, the retailer must generate a unique value to pass through to AEMO.
\n","key":"x-fapi-interaction-id","value":"(Required) Arrangement ID for the consent that the request is being made under to be used for tracing and audit purposes. AEMO will not validate the consent associated with the arrangement.
\n","key":"x-cds-arrangement","value":"Obtain DER data for a specific set of service points
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Page of results being requested (standard pagination)
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Page size. Default is 25 (standard pagination). Maximum page size of 1000 results.
\n","type":"text/plain"},"key":"page-size","value":"1"},{"disabled":true,"description":{"content":"For Internal AEMO pagination purpose
\n","type":"text/plain"},"key":"continuation-token","value":""}],"variable":[]}},"response":[{"id":"04e267d1-c2c8-41af-ac21-1434c4baa9c9","name":"Successful response","originalRequest":{"method":"POST","header":[{"description":"(Required) Details the expected content type of the response.","key":"Accept","value":"application/json"},{"description":"Specifies the encoding support for the response.","key":"Accept-Encoding","value":"gzip"},{"description":"(Required) The participant ID who the request is from.","key":"X-initiatingParticipantId","value":"NEMMCO"},{"description":"(Required) Version of the API supported by AEMO.e.g 1","key":"x-v","value":"1"},{"description":"Minimum Version of the API supported by AEMO.e.g 1","key":"x-min-v","value":"1"},{"description":"(Required) The x-fapi-interaction-id is supplied for end to end tracing. If the ADR has not populated this on their API call to the retailer, the retailer must generate a unique value to pass through to AEMO.","key":"x-fapi-interaction-id","value":"test"},{"description":"(Required) Arrangement ID for the consent that the request is being made under to be used for tracing and audit purposes. AEMO will not validate the consent associated with the arrangement.","key":"x-cds-arrangement","value":"test"},{"description":"(Required) Base64 encoding of the URM username and password, concatenated with a colon.","key":"Authorization","value":"","disabled":true}],"body":{"mode":"raw","raw":"{\r\n\r\n \"data\": {\r\n\r\n \"servicePointIds\": [\"1234567890\"]\r\n\r\n },\r\n \"meta\":{}\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://apis.preprod.aemo.com.au:9319/NEMRetail/cds-au/v1/secondary/energy/electricity/servicepoints/der?page=1&page-size=1","host":["https://apis.preprod.aemo.com.au:9319"],"path":["NEMRetail","cds-au","v1","secondary","energy","electricity","servicepoints","der"],"query":[{"key":"page","value":"1"},{"key":"page-size","value":"1"},{"key":"continuation-token","value":"1","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-v","value":"1","description":""},{"key":"x-fapi-interaction-id","value":"test","description":""},{"key":"Content-Type","value":"application/json"},{"key":"Content-Encoding","value":"gzip","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"derRecords\": [\n {\n \"servicePointId\": \"1234567890\",\n \"approvedCapacity\": 5,\n \"availablePhasesCount\": 3,\n \"installedPhasesCount\": 3,\n \"islandableInstallation\": false,\n \"hasCentralProtectionControl\": false,\n \"acConnections\": [\n {\n \"connectionIdentifier\": 300000005223144,\n \"count\": 1,\n \"equipmentType\": \"INVERTER\",\n \"manufacturerName\": \"Unknown\",\n \"inverterSeries\": \"Unknown\",\n \"inverterModelNumber\": \"Unknown\",\n \"commissioningDate\": \"2020-10-02\",\n \"status\": \"ACTIVE\",\n \"inverterDeviceCapacity\": 5,\n \"derDevices\": [\n {\n \"deviceIdentifier\": 200000005234779,\n \"count\": 1,\n \"manufacturer\": \"Unknown\",\n \"modelNumber\": \"Unknown\",\n \"status\": \"ACTIVE\",\n \"type\": \"SOLAR_PV\",\n \"subtype\": \"Unknown_subtype\",\n \"nominalRatedCapacity\": 6.6,\n \"nominalStorageCapacity\": 0\n }\n ]\n }\n ]\n }\n ]\n },\n \"links\": {\n \"self\": \"https://apis.preprod.aemo.com.au:9319/NEMRetail/cds-au/v1/secondary/energy/electricity/servicepoints/der?page=1&page-size=1&continuation-token=26a4b28f07570cc44aa77eac545fd279\"\n },\n \"meta\": {\n \"totalRecords\": 1,\n \"totalPages\": 1\n }\n}"},{"id":"363544e5-e928-4ad3-91b7-a908f7b53bbd","name":"Mandatory Header Missing X-initiatingParticipantId","originalRequest":{"method":"POST","header":[{"description":"(Required) Details the expected content type of the response.","key":"Accept","value":"application/json"},{"description":"(Required) Version of the API supported by AEMO.e.g 1","key":"x-v","value":"1"},{"description":"Minimum Version of the API supported by AEMO.e.g 1","key":"x-min-v","value":"1"},{"description":"(Required) Arrangement ID for the consent that the request is being made under to be used for tracing and audit purposes. AEMO will not validate the consent associated with the arrangement.","key":"x-cds-arrangement","value":"test"},{"description":"(Required) Base64 encoding of the URM username and password, concatenated with a colon.","key":"x-fapi-interaction-id","value":"test"}],"body":{"mode":"raw","raw":"{\r\n\r\n \"data\": {\r\n\r\n \"servicePointIds\": [\"1234567890\"]\r\n\r\n },\r\n \"meta\":{}\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://apis.preprod.aemo.com.au:9319/NEMRetail/cds-au/v1/secondary/energy/electricity/servicepoints/der?page=1&page-size=1","host":["https://apis.preprod.aemo.com.au:9319"],"path":["NEMRetail","cds-au","v1","secondary","energy","electricity","servicepoints","der"],"query":[{"key":"page","value":"1"},{"key":"page-size","value":"1"},{"key":"continuation-token","value":"1","disabled":true}]}},"status":"Missing Required Header","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-fapi-interaction-id","value":"test","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"urn:au-cds:error:cds-all:Header/Missing\",\n \"title\": \"Missing Required Header\",\n \"detail\": \"Header X-initiatingParticipantID was not found in the request. Access denied.\"\n }\n ]\n}"}],"_postman_id":"fac77bf9-4c82-4b4b-8496-ef637566a1e8"},{"name":"Get Usage For Specific ServicePoints","id":"e3cf2d88-0b88-4421-a38c-c12778b91d94","protocolProfileBehavior":{"disabledSystemHeaders":{"accept-encoding":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-initiatingParticipantId","value":"{{X-initiatingParticipantId}}","type":"text","description":"(Required) The participant ID who the request is from.
\n"},{"key":"x-v","value":"{{x-v}}","type":"text","description":"(Required) Version of the API supported by AEMO.e.g 1
\n"},{"key":"x-min-v","value":"{{x-min-v}}","type":"text","description":"Minimum Version of the API supported by AEMO.e.g 1
\n"},{"key":"x-fapi-interaction-id","value":"(Required) The x-fapi-interaction-id is supplied for end to end tracing. If the ADR has not populated this on their API call to the retailer, the retailer must generate a unique value to pass through to AEMO.
\n"},{"key":"x-cds-arrangement","value":"(Required) Arrangement ID for the consent that the request is being made under to be used for tracing and audit purposes. AEMO will not validate the consent associated with the arrangement.
\n"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Accept-Encoding","value":"compress","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\r\n \"data\": {\r\n\r\n \"servicePointIds\": [\"servicePointIds\"]\r\n\r\n },\r\n \"meta\":{}\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apis.preprod.aemo.com.au:9319/NEMRetail/cds-au/v1/secondary/energy/electricity/servicepoints/usage?interval-reads=Obtain a list of DER data from a particular service point
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"FULL or MIN_30 or NONE
\n","type":"text/plain"},"key":"interval-reads","value":"Integer value
\n","type":"text/plain"},"key":"page","value":"Integer value 1-1000
\n","type":"text/plain"},"key":"page-size","value":"(Required) The participant ID who the request is from.
\n","key":"X-initiatingParticipantId","value":"{{X-initiatingParticipantId}}"},{"description":"(Required) Version of the API supported by AEMO.e.g 1
\n","key":"x-v","value":"{{x-v}}"},{"description":"Minimum Version of the API supported by AEMO.e.g 1
\n","key":"x-min-v","value":"{{x-min-v}}"},{"description":"(Required) The x-fapi-interaction-id is supplied for end to end tracing. If the ADR has not populated this on their API call to the retailer, the retailer must generate a unique value to pass through to AEMO.
\n","key":"x-fapi-interaction-id","value":"(Required) Arrangement ID for the consent that the request is being made under to be used for tracing and audit purposes. AEMO will not validate the consent associated with the arrangement.
\n","key":"x-cds-arrangement","value":"Obtain DER data for a specific set of service points
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Page of results being requested (standard pagination)
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Page size. Default is 25 (standard pagination). Maximum page size of 1000 results.
\n","type":"text/plain"},"key":"page-size","value":"1"},{"disabled":true,"description":{"content":"For Internal AEMO pagination purpose
\n","type":"text/plain"},"key":"continuation-token","value":""}],"variable":[]}},"response":[{"id":"2923ead7-cefc-433c-bfef-65045c060526","name":"Successful response","originalRequest":{"method":"POST","header":[{"description":"(Required) Details the expected content type of the response.","key":"Accept","value":"application/json"},{"description":"Specifies the encoding support for the response.","key":"Accept-Encoding","value":"gzip"},{"description":"(Required) The participant ID who the request is from.","key":"X-initiatingParticipantId","value":"NEMMCO"},{"description":"(Required) Version of the API supported by AEMO.e.g 1","key":"x-v","value":"1"},{"description":"Minimum Version of the API supported by AEMO.e.g 1","key":"x-min-v","value":"1"},{"description":"(Required) The x-fapi-interaction-id is supplied for end to end tracing. If the ADR has not populated this on their API call to the retailer, the retailer must generate a unique value to pass through to AEMO.","key":"x-fapi-interaction-id","value":"test"},{"description":"(Required) Arrangement ID for the consent that the request is being made under to be used for tracing and audit purposes. AEMO will not validate the consent associated with the arrangement.","key":"x-cds-arrangement","value":"test"},{"description":"(Required) Base64 encoding of the URM username and password, concatenated with a colon.","key":"Authorization","value":"","disabled":true}],"body":{"mode":"raw","raw":"{\r\n\r\n \"data\": {\r\n\r\n \"servicePointIds\": [\"1234567890\"]\r\n\r\n },\r\n \"meta\":{}\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://apis.preprod.aemo.com.au:9319/NEMRetail/cds-au/v1/secondary/energy/electricity/servicepoints?page=1&page-size=1","host":["https://apis.preprod.aemo.com.au:9319"],"path":["NEMRetail","cds-au","v1","secondary","energy","electricity","servicepoints"],"query":[{"key":"page","value":"1"},{"key":"page-size","value":"1"},{"key":"continuation-token","value":"1","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-v","value":"1","description":""},{"key":"x-fapi-interaction-id","value":"test","description":""},{"key":"Content-Type","value":"application/json"},{"key":"Content-Encoding","value":"gzip","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"servicePoints\": [\n {\n \"servicePointId\": \"1234567890\",\n \"nationalMeteringId\": \"1234567890\",\n \"servicePointClassification\": \"SMALL\",\n \"servicePointStatus\": \"ACTIVE\",\n \"jurisdictionCode\": \"VIC\",\n \"validFromDate\": \"2021-03-17\",\n \"lastUpdateDateTime\": \"2021-10-02T01:20:59+10:00\",\n \"consumerProfile\": {\n \"classification\": \"RESIDENTIAL\",\n \"threshold\": \"LOW\"\n }\n }\n ]\n },\n \"links\": {\n \"self\": \"https://apis.preprod.aemo.com.au:9319/NEMRetail/cds-au/v1/secondary/energy/electricity/servicepoints?page=1&page-size=1&continuation-token=698ad5ee3a03dec5d407b5225db0f438\"\n },\n \"meta\": {\n \"totalRecords\": 1,\n \"totalPages\": 1\n }\n}"},{"id":"6d511c10-db1f-48b6-bc18-c88354e76408","name":"Mandatory Header Missing x-fapi-interaction-id","originalRequest":{"method":"POST","header":[{"description":"(Required) Details the expected content type of the response.","key":"Accept","value":"application/json"},{"description":"(Required) The participant ID who the request is from.","key":"X-initiatingParticipantId","value":"NEMMCO"},{"description":"(Required) Version of the API supported by AEMO.e.g 1","key":"x-v","value":"1"},{"description":"Minimum Version of the API supported by AEMO.e.g 1","key":"x-min-v","value":"1"},{"description":"(Required) Arrangement ID for the consent that the request is being made under to be used for tracing and audit purposes. AEMO will not validate the consent associated with the arrangement.","key":"x-cds-arrangement","value":"test"},{"description":"(Required) Base64 encoding of the URM username and password, concatenated with a colon.","key":"Authorization","value":"","disabled":true}],"body":{"mode":"raw","raw":"{\r\n\r\n \"data\": {\r\n\r\n \"servicePointIds\": [\"1234567890\"]\r\n\r\n },\r\n \"meta\":{}\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://apis.preprod.aemo.com.au:9319/NEMRetail/cds-au/v1/secondary/energy/electricity/servicepoints?page=1&page-size=1","host":["https://apis.preprod.aemo.com.au:9319"],"path":["NEMRetail","cds-au","v1","secondary","energy","electricity","servicepoints"],"query":[{"key":"page","value":"1"},{"key":"page-size","value":"1"},{"key":"continuation-token","value":"1","disabled":true}]}},"status":"Missing Required Header","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"urn:au-cds:error:cds-all:Header/Missing\",\n \"title\": \"Missing Required Header\",\n \"detail\": \"Header x-fapi-interaction-id was not found in the request. Access denied.\"\n }\n ]\n}"}],"_postman_id":"4e8972cd-c3bf-4ce0-a008-23c59d2f9116"},{"name":"Get DER For Service Point","id":"987c4cba-039e-4384-b9bd-7f84e618e670","protocolProfileBehavior":{"disabledSystemHeaders":{"accept-encoding":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"(Required) The participant ID who the request is from.
\n","key":"X-initiatingParticipantId","value":"{{X-initiatingParticipantId}}"},{"description":"(Required) Version of the API supported by AEMO.e.g 1
\n","key":"x-v","value":"{{x-v}}"},{"description":"Minimum Version of the API supported by AEMO.e.g 1
\n","key":"x-min-v","value":"{{x-min-v}}"},{"description":"(Required) The x-fapi-interaction-id is supplied for end to end tracing. If the ADR has not populated this on their API call to the retailer, the retailer must generate a unique value to pass through to AEMO.
\n","key":"x-fapi-interaction-id","value":"(Required) Arrangement ID for the consent that the request is being made under to be used for tracing and audit purposes. AEMO will not validate the consent associated with the arrangement.
\n","key":"x-cds-arrangement","value":"Obtain a list of DER data from a particular service point
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"(Required) The participant ID who the request is from.
\n"},{"key":"x-v","value":"{{x-v}}","type":"text","description":"(Required) Version of the API supported by AEMO.e.g 1
\n"},{"key":"x-min-v","value":"{{x-min-v}}","type":"text","description":"Minimum Version of the API supported by AEMO.e.g 1
\n"},{"key":"x-fapi-interaction-id","value":"(Required) The x-fapi-interaction-id is supplied for end to end tracing. If the ADR has not populated this on their API call to the retailer, the retailer must generate a unique value to pass through to AEMO.
\n"},{"key":"x-cds-arrangement","value":"(Required) Arrangement ID for the consent that the request is being made under to be used for tracing and audit purposes. AEMO will not validate the consent associated with the arrangement.
\n"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Accept-Encoding","value":"compress","type":"text"}],"url":"https://apis.preprod.aemo.com.au:9319/NEMRetail/cds-au/v1/secondary/energy/electricity/servicepoints/:servicePointId/usage?interval-reads=Obtain a list of DER data from a particular service point
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"FULL or MIN_30 or NONE
\n","type":"text/plain"},"key":"interval-reads","value":"Integer value
\n","type":"text/plain"},"key":"page","value":"Integer value 1-1000
\n","type":"text/plain"},"key":"page-size","value":"(Required) The participant ID who the request is from.
\n","key":"X-initiatingParticipantId","value":"{{X-initiatingParticipantId}}"},{"description":"(Required) Version of the API supported by AEMO.e.g 1
\n","key":"x-v","value":"{{x-v}}"},{"description":"Minimum Version of the API supported by AEMO.e.g 1
\n","key":"x-min-v","value":"{{x-min-v}}"},{"description":"(Required) The x-fapi-interaction-id is supplied for end to end tracing. If the ADR has not populated this on their API call to the retailer, the retailer must generate a unique value to pass through to AEMO.
\n","key":"x-fapi-interaction-id","value":"(Required) Arrangement ID for the consent that the request is being made under to be used for tracing and audit purposes. AEMO will not validate the consent associated with the arrangement.
\n","key":"x-cds-arrangement","value":"Obtain a list of DER data from a particular service point
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"