{"value":[{"id":"b2bmessaging-async-v1","name":"B2BMessagingAsync","description":"## Introduction\nThe B2BMessagingAsync API is a B2B SMP APIs used to send and recieve B2B messages between the participants in an asynchronous fashion. \n\n\nFor details on how to get access and business rules for this API:\n\n\"View","subscriptionRequired":true,"path":"ws/B2BMessagingAsync","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"x-eHub-APIKey","query":"subscription-key","bearer":null},"apiVersion":"1.0","apiVersionSetId":"b2bmessaging-async-v1"},{"id":"b2bmessaging-pull-v1","name":"B2BMessagingPull","description":"The B2BMessagingPull API is a B2B SMP API used to send and receive B2B messages between the participants in a Pull messaging pattern. The messages will be queued in the e-Hub and the receiving participant can poll the e-Hub, ‘pull’ and process the messages that are queued.\n\n\nFor details on how to get access and business rules for this API:\n\n\"View","subscriptionRequired":true,"path":"ws/B2BMessagingPull","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"x-eHub-APIKey","query":"subscription-key","bearer":null},"apiVersion":"1.0","apiVersionSetId":"b2bmessaging-pull-v1"},{"id":"b2bmessaging-sync-v1","name":"B2BMessagingSync","description":"## Introduction\nThe B2BMessagingSync API is a B2B SMP APIs used to send and receive B2B messages between the participants in a synchronous fashion. \n\nFor details on how to get access and business rules for this API:\n\n\"View","subscriptionRequired":true,"path":"ws/B2BMessagingSync","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"x-eHub-APIKey","query":"subscription-key","bearer":null},"apiVersion":"1.0","apiVersionSetId":"b2bmessaging-sync-v1"},{"id":"b2mmessaging-async-v1","name":"B2MMessagingAsync","description":"## Introduction\n The B2MMessagingAsync push-push API supports inbound submitMessages, submitMessageAcknowledgements, and getQueueMetaData endpoints and suits a high volume exchange of messages. \n Participants push their outgoing message to the e-Hub and the e-Hub pushes the message to the Participants Gateway. The message delivery occurs asynchronously, where the initiator sends the message to the e-Hub and expects the outcome (such as MACKs, TACKs, or responses) in a different API call. The response, sent later, is sent to the Participants Gateway.","subscriptionRequired":false,"path":"NEMRetail/B2MMessagingAsync","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"apiVersion":"v1","apiVersionSetId":"5ms-b2mmAsync-v1"},{"id":"b2mmessaging-pull-v1","name":"B2MMessagingPull","description":"## Introduction\n The B2MMessagingPull push-pull API supports inbound submitMessages, submitMessageAcknowledgements, getMessages, and getQueueMetaData endpoints and suits low volume exchange of messages. \n\n Participants using B2MMessagingPull are responsible for implementing the polling logic to poll their Participant Hub Queue to retrieve new messages, similar to batch programs used to poll their outbox using FTP. \n\n Implementation of a Participant API Gateway is not required for B2MMessagingPull but the speed of message delivery is slower compared to the B2BMessagingAsync API.\n\n The response is sent in the calling thread.","subscriptionRequired":false,"path":"NEMRetail/B2MMessagingPull","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"apiVersion":"v1","apiVersionSetId":"5ms-b2mmpull-v1"},{"id":"b2mmessaging-sync-v1","name":"B2MMessagingSync","description":"## Introduction\nThe B2MMessagingSync API supports generateC1Report, generateC4Report, getMSATSLimits,NMIDiscovery, getNMIDetail, getParticipantSystemStatus, and getMeterData endpoints.The API participant pushes their outgoing message to the e-Hub and the e-Hub pushes the message to the API recipient.The message delivery occurs synchronously where the participant sends the message to the e-Hub and AEMO immediately sends the response (such as MACKs,TACKs, or responses) in the same thread to the Participant's Gateway.","subscriptionRequired":false,"path":"NEMRetail/B2MMessagingSync","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"x-apikey","query":"subscription-key","bearer":null},"apiVersion":"v1","apiVersionSetId":"5ms-b2mmsync-v1"},{"id":"balancing-reports-v2","name":"Balancing Reports v2","description":null,"subscriptionRequired":false,"path":"WEM/balancing","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap","apiVersion":"v2","apiVersionSetId":"balancing-reports"},{"id":"balancing-reports-v2-1","name":"Balancing Reports v2.1","description":null,"subscriptionRequired":false,"path":"WEM/balancing","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap","apiVersion":"v2.1","apiVersionSetId":"balancing-reports"},{"id":"balancing-reports-v2-2","name":"Balancing Reports v2.2","description":null,"subscriptionRequired":false,"path":"WEM/balancing","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap","apiVersion":"v2.2","apiVersionSetId":"balancing-reports"},{"id":"balancing-reports-v2-3","name":"Balancing Reports v2.3","description":null,"subscriptionRequired":false,"path":"WEM/balancing","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap","apiVersion":"v2.3","apiVersionSetId":"balancing-reports"},{"id":"balancing-reports-v2-4","name":"Balancing Reports v2.4","description":null,"subscriptionRequired":false,"path":"WEM/balancing","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap","apiVersion":"v2.4","apiVersionSetId":"balancing-reports"},{"id":"balancing-reports-v2-5","name":"Balancing Reports v2.5","description":null,"subscriptionRequired":false,"path":"WEM/balancing","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap","apiVersion":"v2.5","apiVersionSetId":"balancing-reports"},{"id":"balancing-submission-v2","name":"Balancing Submission v2","description":null,"subscriptionRequired":false,"path":"WEM/balancing/submissions","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap","apiVersion":"v2","apiVersionSetId":"balancing-submission"},{"id":"bilateral-stem-submission-v1","name":"Bilateral/Stem Submission v1","description":null,"subscriptionRequired":false,"path":"WEM/trading","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap","apiVersion":"v1","apiVersionSetId":"bilateral-stem-submission"},{"id":"blindupdate-v1","name":"BlindUpdate","description":"## Introduction\n The BlindUpdateTool API supports Upload of blind update Data by participants facing API's to backend MSATS systems , Download processed Blind Update file, List of all the Blind Update files uploaded by the Participants. \n Participants will access the BlindUpdateTool tab from the Browser which invokes the respective process in the API Management. Uploading the Blind Update File happens which will receive a response from backend Native API after basic validation.Asynchronously, the uploaded file will be processed in the backend and listed with a status in the participants screen.Processed blindupdate files can be downloaded from the screen.","subscriptionRequired":false,"path":"NEMRetail/BlindUpdate","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"apiVersion":"v1","apiVersionSetId":"blindupdate-v1"},{"id":"capacity-v1","name":"Capacity","description":"\n## Introduction\nThe Capacity API is used by facility operators and trading participants to submit and receive data relating to capacity trades and day ahead auction for AEMO’s Capacity Transfer Platform (CTP) and Day-Ahead Auction (DAA) market systems.\n\nFor details on how to get access and business rules for this API:\n\n\"View","subscriptionRequired":false,"path":"ws/gsh/capacity","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"apiVersion":"v1","apiVersionSetId":"capacity-v1"},{"id":"capacityAuction-v1","name":"CapacityAuction","description":"\n## Introduction\nThe Capacity Auction API is used by facility operators and trading participants to submit and receive data relating to capacity trades and day ahead auction for AEMO’s Capacity Transfer Platform (CTP) and Day-Ahead Auction (DAA) market systems.\n\nFor details on how to get access and business rules for this API:\n\n\"View","subscriptionRequired":false,"path":"ws/gsh/capacityAuction","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"apiVersion":"v1","apiVersionSetId":"capacityAuction-v1"},{"id":"cdr","name":"CDR","description":"## Introduction\nThe Consumer Data Right (CDR) APIs allow Registered Financially Responsible Market Participants (FRMPs) to service API requests for AEMO data from Accredited Data Recipients.","subscriptionRequired":false,"path":"NEMRetail/cds-au/v1/secondary/energy","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null}},{"id":"cdr-common","name":"CDR Common","description":null,"subscriptionRequired":false,"path":"NEMRetail/cds-au/v1/discovery","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null}},{"id":"der-consumer-registration-v1","name":"DER Registration For Account Holders","description":"## Introduction\nUsing the DER Registration APIs, Account Holders can\n\n• Submit DER Connection Agreement data.\n\n• Provide AC Connections, and Device details in the same submission","subscriptionRequired":false,"path":"NEMWholesale/DER/consumer/registration","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"client_id","query":"clientId","bearer":null},"apiVersion":"v1","apiVersionSetId":"der-consumer-registration-v1"},{"id":"der-business-registration-v1","name":"DER Registration for NSPs","description":"## Introduction\nUsing the DER Registration APIs, NSPs can\n\n• Submit DER Connection Agreement data.\n\n• Provide AC Connections, and Device details in the same submission","subscriptionRequired":false,"path":"NEMWholesale/DER/registration","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"x-apikey","query":"subscription-key","bearer":null},"termsOfServiceUrl":"https://dev.aemo.com.au/terms","apiVersion":"v1","apiVersionSetId":"der-business-registration-v1"},{"id":"ee-simulation-status-update-v1","name":"EE Simulation Status Update","description":"## Introduction\nEE Simulation Status Update APIs are used by EE to submit the simulation status update","subscriptionRequired":false,"path":"ee-simulation-status-update","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"apiVersion":"v1","apiVersionSetId":"ee-simulation-v1"},{"id":"enablementinstruction-v1","name":"EnablementInstruction","description":null,"subscriptionRequired":false,"path":"NEM/v1/ISF-External/enablementInstruction","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"apiVersion":""},{"id":"gasbb-reporting-public-data","name":"GasBB Reporting Public Data","description":"This API is intended for AEMO's use only, used by AEMO web pages and is not supported for any other use. It can change at any time. See https://dev.aemo.com.au/ for information on using AEMO APIs.","subscriptionRequired":true,"path":"gasbb-reporting-data","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"X-DC-DEVKEY","query":"subscription-key","bearer":null},"termsOfServiceUrl":"https://dev.aemo.com.au/terms","apiVersion":"v1","apiVersionSetId":"gasbb-report-v1"},{"id":"generatorRecall-v1","name":"GeneratorRecall","description":"The Generator Recall API is used by generators to send information about recall times into the Generator Recall web-based interface in the EMMS Markets Portal. The system will then transfer the information to a central AEMO database for viewing and reporting by AEMO operators.\n\nFor details on how to get access and business rules for this API:\n\n\"View","subscriptionRequired":false,"path":"ws/GeneratorRecall","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"apiVersion":"1.0","apiVersionSetId":"generatorRecall-v1"},{"id":"hubmsgmgt-v1","name":"HubMessageManagement","description":"## Introduction\nThe HubMessageManagement API is a B2B SMP APIs used retrieve the current list of stop files for all participants or for a specific participant (using alerts) resource. \n\nParticipants can use this resource to: \n1. Ensure technical requirements required to connect to e-Hub are validated (for example, appropriate network ports are open). Participants can utilise this function to ensure their systems can connect to e-Hub using their SSL certificates and API keys.\n2. Determine if the e-Hub system is operational (ping-pong test).\n\nFor details on how to get access and business rules for this API:\n\n\"View","subscriptionRequired":true,"path":"ws/HubMessageManagement","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"x-eHub-APIKey","query":"subscription-key","bearer":null},"apiVersion":"1.0","apiVersionSetId":"5MS-hubmsgmgt-v2"},{"id":"hubmsgmgt-v2","name":"HubMessageManagementV2","description":"## Introduction\n The HubMessageManagement push API retrieves the current list of B2B and B2M stop files. Business transactions are sent as aseXML documents carried as payloads inside the API message and transmitted over HTTPS. \n\nParticipants can also use this API to:\n1. Ensure technical requirements required to connect to the e-Hub are validated (for example, appropriate network ports are open).\n2. Ensure their systems can connect to the e-Hub using their SSL certificates and API keys.\n3. Determine if AEMO's e-Hub is operational (ping-pong test).","subscriptionRequired":false,"path":"HubMessageManagement","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"x-apikey","query":"subscription-key","bearer":null},"apiVersion":"v2","apiVersionSetId":"5MS-hubmsgmgt-v2"},{"id":"identityService-v2","name":"IdentityService(v2)","description":"## Introduction\nThis API is used by a Participant to update their password for MSATs.\n\nFor details on how to get access and business rules for this API:\n\n\"View","subscriptionRequired":false,"path":"ws/Common/identityService","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"apiVersion":"v2","apiVersionSetId":"identityService-v2"},{"id":"opsforecasting-intermittentgen-v1","name":"Intermittent Generation Availability Submissions","description":"## Introduction\nThis API is used for intermittent generation availability submissions. For details on how to get access and business rules for this API:\n\n\"View","subscriptionRequired":false,"path":"v1/IntermittentGen","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"apiVersion":""},{"id":"lfas-reports-v2","name":"LFAS Reports v2","description":null,"subscriptionRequired":false,"path":"WEM/lfas/v2","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap"},{"id":"lfas-submission-v2","name":"LFAS Submission v2","description":null,"subscriptionRequired":false,"path":"WEM/lfas/submissions/v2","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap"},{"id":"market-reports-v2","name":"Market Reports v2","description":null,"subscriptionRequired":false,"path":"WEM/market","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap","apiVersion":"v2","apiVersionSetId":"market-reports"},{"id":"meterexemption-external-v1","name":"MeterExemption","description":"The Meter Exemptions API enables registered Metering Coordinators (MCs) to create and manage metering exemptions within MSATS.","subscriptionRequired":false,"path":"NEMRetail/v1/meterExemption","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null}},{"id":"mtpasaoffers-v1","name":"MT PASA Offers","description":"## Introduction\nThe MT PASA Offers API allows Scheduled Generators, Market Customers, Market Network Service Providers, and Integrated Resource Providers to submit their MT PASA Offers for Bi-directional Units (BDU), Scheduled Generation Units (SGU), Scheduled Load Units (SLU), and Scheduled Network Services (SNS). MT PASA Offers are input into the MT PASA process.","subscriptionRequired":false,"path":"NEMWholesale/v1/mtpasaoffers","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"apiVersionSetId":"mtpasaoffers-v1"},{"id":"bidding-v1","name":"NEMDispatchBidding","description":"Bidding Service Open API specification","subscriptionRequired":false,"path":"NEMWholesale/bidding","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"x-apikey","query":"subscription-key","bearer":null},"apiVersion":"v1","apiVersionSetId":"5ms-bidding-v1"},{"id":"oauth-v1","name":"oauth-v1","description":"","subscriptionRequired":false,"path":"oauth/v1","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"x-apikey","query":"subscription-key","bearer":null},"apiVersion":""},{"id":"oip-external-v1","name":"OIP","description":null,"subscriptionRequired":false,"path":"WEM/v1/outageIntentionPlan","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"apiVersion":""},{"id":"outage-management-external-v1","name":"Outage Management","description":null,"subscriptionRequired":false,"path":"WEM/v1/outageManagement","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null}},{"id":"p2pmessaging-sync-v1","name":"P2PMessagingSync","description":"## Introduction\nThe P2PMessagingSync API is a B2B SMP APIs used to exchange the following Peer-to-Peer information via the e-Hub:\n- Free-form information\n- Documents (also called Attachments). The P2PMessagingSync API supports exchange of the following attachment types (configurable): pdf, csv, jpeg, jpe, jpg, gif, zip & txt. In future, this API will support additional attachment types.\n\nFor details on how to get access and business rules for this API:\n\n\"View","subscriptionRequired":true,"path":"ws/P2PMessagingSync","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"x-eHub-APIKey","query":"subscription-key","bearer":null},"apiVersion":"1.0","apiVersionSetId":"p2pmessaging-sync-v1"},{"id":"pre-balancing-reports-v6","name":"Pre-Balancing Reports v6","description":null,"subscriptionRequired":false,"path":"WEM/reports","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap","apiVersion":"v6","apiVersionSetId":"pre-balancing-reports"},{"id":"pre-balancing-reports-v7","name":"Pre-Balancing Reports v7","description":null,"subscriptionRequired":false,"path":"WEM/reports","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap","apiVersion":"v7","apiVersionSetId":"pre-balancing-reports"},{"id":"pre-balancing-reports-v7-1","name":"Pre-Balancing Reports v7.1","description":null,"subscriptionRequired":false,"path":"WEM/reports","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap","apiVersion":"v7.1","apiVersionSetId":"pre-balancing-reports"},{"id":"pre-balancing-reports-v8","name":"Pre-Balancing Reports v8","description":null,"subscriptionRequired":false,"path":"WEM/reports","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap","apiVersion":"v8","apiVersionSetId":"pre-balancing-reports"},{"id":"prudentials-v1","name":"Prudentials","description":"This API supports the various operations performed on Prudentials dashboard","subscriptionRequired":false,"path":"NEMWholesale/Prudentials","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"apiVersion":"v1","apiVersionSetId":"5MS-prud-v1"},{"id":"rcm-ops-external-v1","name":"RCM Operations","description":null,"subscriptionRequired":false,"path":"WEM/RCM","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null}},{"id":"reallocations-v1","name":"Reallocations","description":"## Introduction\nThe Reallocation API allow you to create, authorise, cancel reallocations. You can also search and retrieve reallocations, calendars, participants, profile types, agreement types, and market price cap\n\nFor details on how to get access and business rules for this API:\n\n\"View","subscriptionRequired":false,"path":"ws/NEMWholesale/reallocations","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"apiVersion":"v1","apiVersionSetId":"reallocations-v1"},{"id":"report-v1","name":"Report","description":"\n## Introduction\nThe report API allows participants to retrieve data from the Gas Bulletin Board (BB). \n\n\nFor details on how to get access and business rules for this API:\n\n\"View","subscriptionRequired":false,"path":"ws/gbb/report","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"apiVersion":"v1","apiVersionSetId":"report-v1"},{"id":"rtms-external-v1","name":"RTMS","description":"The WEM-Reform API for Real-Time Market submissions available to all Market Participants.","subscriptionRequired":false,"path":"WEM/v1/realTimeMarketSubmission","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"contact":{"name":"AEMO Real Time Market Submissions Team","url":null,"email":"wa.operations@aemo.com.au"}},{"id":"selfForecast-v1","name":"SelfForecast","description":"## Introduction\nThe Self forecasting API is used by participants who wish to submit their Solar or Wind Forecasts for a DUID to AEMO.\n\nFor details on how to get access and business rules for this API:\n\n\"View","subscriptionRequired":false,"path":"ws/NEMWholesale/selfForecast","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"apiVersion":"v1","apiVersionSetId":"selfForecast-v1"},{"id":"settlementDirect-v1","name":"Settlement Direct","description":"This API supports the various operations performed in Settlement Direct API","subscriptionRequired":false,"path":"NEMWholesale/PublishingDirect","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"apiVersion":"v1","apiVersionSetId":"5MS-settle-v1"},{"id":"submission-v1","name":"Submission","description":"\n## Introduction\nThe submission API allows participants to submit data to the Gas Bulletin Board (BB).\nData submission from BB reporting entities to the BB are divided into two key areas-\n- Data transfer formats which includes the form, validation rules, and timing of submissions.\n- Data submission methods to the BB, and how the success and failure of those submissions is communicated back to the submitter.\n\nFor details on how to get access and business rules for this API:\n\n\"View","subscriptionRequired":false,"path":"ws/gbb/submission","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"apiVersion":"v1","apiVersionSetId":"submission-v1"},{"id":"system-management-reports-v2","name":"System Management Reports v2","description":null,"subscriptionRequired":false,"path":"WEM/sm","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap","apiVersion":"v2","apiVersionSetId":"system-management-reports"},{"id":"system-management-reports-v2-1","name":"System Management Reports v2.1","description":null,"subscriptionRequired":false,"path":"WEM/sm","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap","apiVersion":"v2.1","apiVersionSetId":"system-management-reports"},{"id":"system-management-reports-v2-2","name":"System Management Reports v2.2","description":null,"subscriptionRequired":false,"path":"WEM/sm","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap","apiVersion":"v2.2","apiVersionSetId":"system-management-reports"},{"id":"system-management-reports-v2-3","name":"System Management Reports v2.3","description":null,"subscriptionRequired":false,"path":"WEM/sm","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap","apiVersion":"v2.3","apiVersionSetId":"system-management-reports"},{"id":"system-management-reports-v2-4","name":"System Management Reports v2.4","description":null,"subscriptionRequired":false,"path":"WEM/sm","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap","apiVersion":"v2.4","apiVersionSetId":"system-management-reports"},{"id":"system-management-reports-v2-5","name":"System Management Reports v2.5","description":null,"subscriptionRequired":false,"path":"WEM/sm","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap","apiVersion":"v2.5","apiVersionSetId":"system-management-reports"},{"id":"system-management-reports-v2-6","name":"System Management Reports v2.6","description":null,"subscriptionRequired":false,"path":"WEM/sm","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"type":"soap","apiVersion":"v2.6","apiVersionSetId":"system-management-reports"},{"id":"tls-certificate-mgmt-v1","name":"TLS Certificate Mgmt v1","description":"The TLS Certificate Management API allows authorised participants to self-manage their AEMO-signed TLS certificates. This API provides the following features:\n- Retrieve a list of your AEMO-signed TLS certificates and orders\n- Download a specific TLS certificate\n- Generate a new TLS certificate\n- Reissue a TLS certificate\n- Renew a soon-to-expire TLS certificate\n- Revoke a TLS certificate\n \n\n# Status\nThis documentation presents the TLS Certificate Management API evolving design. It is updated as the technical requirements are streamlined.\n# Assumed knowledge\n- RESTful API practices and JSON basics.\n \n\n# Prerequisites\nBefore you can use the TLS Certificate Management API you must:\n1. Have a Participant ID. If your company is a Registered Participant, it is set up during the registration process. Have a Participant ID with an effective date of registration.\n2. Have a user ID and password with access rights provided by your company's participant administrator. For details, see user rights access below.\n3. Have an AEMO-signed [TLS certificate](https://portal.aemo.com.au/help/Content/API%20Reference/Manage%20TLS%20Certificates.html). If you need to get an AEMO-signed TLS certificate for the first time you can do this through the [Markets Portal](https://portal.prod.nemnet.net.au), or raise a request for a TLS certificate through the [Participant Portal](https://aemo.service-now.com/participantportal/).\n \n\n# API portal and Open API Specification\n[TLS Certificate Management Open API Specification](https://dev.aemo.com.au/api-details#api=tls-certificate-mgmt-v1)\n# Authentication and Authorization methods\n## TLS Certificates\nThis API is protected by MTLS authentication. A valid AEMO-signed TLS certificate is required to access this API. See Prerequisites above on how to get an AEMO-signed TLS certificate for the first time.\n## User rights access\nParticipant administrators provide access to the TLS Certificate Management API using the **TLS_CERTIFICATE_MANAGEMENT** entity. See the [User Rights Management](https://portal.prod.nemnet.net.au/help/Content/UserRightsManagement/URM.htm) guide (URM) for details on managing URM functions.\n\nUsers must be assigned rights that have access to the entity **TLS_CERTIFICATE_MANAGEMENT**. The API allows two privileges (access levels) of access rights for that entity:\n- **Delete right** - all endpoints are available to users with the Delete right.\n- **Read right** - all GET endpoints are available to users under this right. Users with this right cannot create, revoke, reissue or renew TLS certificates. Rights created with Create and Update only have access to Read right features.\n \n\nWhen calling this API, your username must be subscribed to a valid right under the **TLS_CERTIFICATE_MANAGEMENT** entity. You authorize your identity using Base64 encoding of your username and password, separated by a colon, in the Basic Auth header. For example:\n\n`Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==`\n# Throttling and quotas\nTo control traffic, AEMO implements Throttling on all API Endpoint requests. Also, some endpoints have a specific quota of requests. If a Participant ID requests exceed the Throttling limit a HTTP 429 or 422 response returns. For more details, see the examples under each request. \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
EndpointLimits
All endpoints6 requests per minute per participantId.\n
The participantId is identified from the X-InitiatingParticipantID request header parameter.\n
The API has a general spike-arrest limit of 6 requests per minute per participantId. This is imposed across all endpoints of the API.
POST `all endpoints`10 requests per month per participantId.\n
The participantId is identified from the X-InitiatingParticipantID request header parameter.\n
For each participantId there are only 20 POST requests that can be made to the API per month.
GET `all endpoints`60 requests per month per participantId.\n
The participantId is identified from the X-InitiatingParticipantID request header parameter.\n
For each participantId there are only 60 GET requests that can be made to the API per month.
POST `/certificates`1 request per participantId per environment. \n
The participantId is identified from the `X-InitiatingParticipantID` request header parameter.\n
The environment is identified from the value of the environment key in the request body.\n
A participantId can only have one set of TLS certificates (one PreProd certificate and one Prod certificate).\n
This restriction is due to costs associated with providing TLS certificates. If more than one certificate is required to differentiate system access to AEMO systems you can use the `/order/{order-id}/reissue` endpoint.\n
Participants systems must manage this Throttling limit because if you submit multiple JSON requests for the same participantId at the same time, AEMO may reject some.
\n\n# Response codes\nFor detailed examples of response codes see the provided example under each request.\n# URLs\nThe API is available over the internet on the following base URLs:\n\n \n \n \n \n \n \n \n \n \n \n \n \n
EnvironmentBase URL
PreProductionhttps://partner.api.preprod.aemo.com.au/v1/TLSCertificateManagement
Productionhttps://partner.api.aemo.com.au/v1/TLSCertificateManagement
\n\n\n## Environment details\n### PreProduction\nTLS Certificates created in the PreProduction environment will be suffixed with \"MOCK\" in the commonName, and are mock certificates only. These certificates will automatically expire after 3-days and are not usable for accessing any AEMO systems.\n### Production\nTLS Certificates created in the Production environment will be suffixed with either \"PROD\" or \"NONPROD\" in the commonName depending on the environment entered in the API request. These certificates will automatically expire after 3-years and are used for accessing MTLS-protected AEMO systems (both PreProduction and Production systems).\n\nNONPROD certificates can only be used for accessing AEMO Non-Production systems (for example APIs on; [https://partner.api.preprod.aemo.com.au](https://partner.api.preprod.aemo.com.au), [https://apis.preprod.aemo.com.au:9319](https://apis.preprod.aemo.com.au:9319), or [https://apis.preprod.marketnet.net.au:9319](https://apis.preprod.marketnet.net.au:9319)). You will need to use the PreProd certificate to access AEMO Non-Production environments that are MTLS protected. The NONPORD certificate will be issued by the certificate authority AEMO-ICA-TEST G1.\n\nPROD certificates can only be used for accessing AEMO Production systems (for example APIs on; [https://partner.api.aemo.com.au](https://partner.api.aemo.com.au), [https://apis.aemo.com.au:9319](https://apis.aemo.com.au:9319), or [https://apis.marketnet.net.au:9319](https://apis.marketnet.net.au:9319)). You will need to use the Prod certificate to access AEMO Production environments that are MTLS protected. The PROD certificate will be issued by the certificate authority AEMO-ICA-MARKET G1.\n\n# Glossary\n- CA - Certificate Authority\n- PKI - Public Key Infrastructure\n- TLS - Transport Layer Security\n- X.509v3 - The specific TLS certificate standard used by AEMO","subscriptionRequired":false,"path":"v1/TlsCertificateMgmt","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"x-aemo-api-key","query":"subscription-key","bearer":null},"termsOfServiceUrl":"https://dev.aemo.com.au/terms"},{"id":"variableparameter-v1","name":"VariableParameter","description":null,"subscriptionRequired":false,"path":"NEM/v1/ISF-External/variableParameter","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"apiVersion":""},{"id":"attributes-report-external-v1","name":"WEM Attributes Report","description":null,"subscriptionRequired":false,"path":"WEM/v1/attributes","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null},"apiVersion":""},{"id":"der-register-installation-v2","name":"WEM DER Installation V2","description":"## Introduction\nWEM DER Installation API enables the Network Operator to create, update, and retrieve the DER Register information details for the DER installations they have submitted to the DER Register database and to view and resolve associated exceptions","subscriptionRequired":false,"path":"v2/der-register","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"x-apikey","query":"subscription-key","bearer":null},"apiVersion":""},{"id":"der-register-nmi-v1","name":"WEM DER NMI","description":"## Introduction\nUsing the WEM DER Registration APIs, consumers can Create, update and retrieve NMI details","subscriptionRequired":false,"path":"wem/v1/der-register","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"x-apikey","query":"subscription-key","bearer":null}},{"id":"wemde-dispatchcase-external-v1","name":"WEMDE DispatchCase","description":null,"subscriptionRequired":false,"path":"WEM/v1/dispatchCase","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null}},{"id":"wemde-dispatchcase-external-v2","name":"WEMDE DispatchCase V2","description":null,"subscriptionRequired":false,"path":"WEM/v2/dispatchCase","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null}},{"id":"wemde-dispatchinstruction-external-v1","name":"WEMDE DispatchInstruction","description":null,"subscriptionRequired":false,"path":"WEM/v1/dispatchInstruction","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null}},{"id":"wemde-dispatchsolution-external-v1","name":"WEMDE DispatchSolution","description":null,"subscriptionRequired":false,"path":"WEM/v1/dispatchSolution","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null}},{"id":"wemde-dispatchsolution-external-v2","name":"WEMDE DispatchSolution V2","description":null,"subscriptionRequired":false,"path":"WEM/v2/dispatchSolution","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null}},{"id":"wemde-dispatchsummary-external-v1","name":"WEMDE DispatchSummary","description":null,"subscriptionRequired":false,"path":"WEM/v1/dispatchSummary","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null}},{"id":"wemde-dspdispatchinstruction-external-v1","name":"WEMDE DSPDispatchInstruction","description":null,"subscriptionRequired":false,"path":"WEM/v1/DSPDispatchInstruction","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null}},{"id":"wemde-ncess-external-v1","name":"WEMDE NCESS","description":"","subscriptionRequired":false,"path":"WEM/v1/Ncess","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null}},{"id":"wemde-notinservicecapacity-external-v1","name":"WEMDE NotInServiceCapacity","description":null,"subscriptionRequired":false,"path":"WEM/v1/notInServiceCapacity","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null}},{"id":"wemde-referencetradingprice-external-v1","name":"WEMDE ReferenceTradingPrice","description":null,"subscriptionRequired":false,"path":"WEM/v1/referenceTradingPrice","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null}},{"id":"wemde-tradingdayreport-external-v1","name":"WEMDE TradingDayReport","description":null,"subscriptionRequired":false,"path":"WEM/v1/tradingDayReport","protocols":["https"],"authenticationSettings":{"oAuth2AuthenticationSettings":[],"openidAuthenticationSettings":[]},"subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key","bearer":null}}],"nextLink":null}