IDX Knowledge Library

Basic Power Quality Data API overview

Summary

The Basic Power Quality Data (BPQD) API Application Programming Interface; a set of clearly defined methods of communication between various software components. overview presentation contains information about:

  • Industry Data Exchange See Relevant Rules or Procedures (IDX) platform and its first business function, BPQD.

  • Open Authorization 2.0 (OAuth2) instead of Basic Authentication (Basic Auth).

  • The existing User Rights Management (URM) for login credentials until the availability of the new Identity Access Management (IDAM) system in 2027.

  • The API endpoints available over MarketNet and protected by mTLS certificates.

  • CRUD (create, read, update, delete) operations for BPQD messages, using a fire-and-forget model without formal acknowledgements.

  • Message signing for non-repudiation, similar to the Gas FRC Hub, and primary and secondary certificates per Participant ID.

  • GZIP content encoding.

  • Schema versioning with dynamic version selection during transition windows.

  • The RFC 9457 standard for error messages, including traceability IDs for troubleshooting.

  • Pagination and metadata for message queues with a recommended WebSocket event notification API for real-time updates.

  • Message deletion from queues to avoid buildup.

 

IDX Release 1 - Web Applications and APIs Overview

Web Applications and APIs (2 MB)

Summary

The Web Applications and APIs overview presentation contains information about:

  • How IDX uplifts data exchange by replacing FTP File transfer protocol and basic authentication with REST The Representational State Transfer API architecture APIs, JSON JavaScript Object Notification payloads, and OAuth 2.0 security.

  • How the initial rollout supports basic power quality data only and later releases adds more business functions. A major foundation release is scheduled for 2027.

  • How legacy services transition to IDX after the foundation release.

  • How IDX provides both web and API access through the Markets Portal, with all UI features also available via APIs to remove the need for screen scraping.

  • The four web applications - Transaction Log, Archive, Flow Control, and Other Participant Status – and their matching APIs.

  • How the Transaction Log allows participants to view and search all sent and received B2B and B2M messages, with permissions managed through the existing participant management system.

  • The Archive service providing access to messages retained for a defined period (for example, 30 days for power quality data). Only outbound archives for receiving participants are available.

  • Flow Control providing visibility of message queues for each business function, including options to pause or resume delivery. Delivery automatically stops if a queue exceeds its high watermark and can resume once cleared.

  • How Other Participant Status shows participants nearing or exceeding queue limits to help avoid sending to overloaded participants.

  • How a metadata API provides archive durations, message patterns, schema versions, and other business function details.

  • Websocket event notifications delivering real time alerts such as queue breaches, reducing the need for polling.

  • How existing third party gateway solutions should remain compatible, but participants must confirm with vendors.

  • How IDX is designed for flexibility, security, and long term extensibility, supporting both manual and automated integration.