Magidoc

EAC API guide

Welcome to the Enduring Auction Capability (EAC) API guide. Whether you're a developer, system integrator, or simply interested in exploring the capabilities of the EAC, this guide will provide you with the necessary knowledge to effectively leverage the power of our GraphQL API.

What is EAC?

#

The EAC, short for Enduring Auction Capability, is a platform allowing ESO to procure day-ahead Frequency Response and Reserve products in co-optimised auctions.

To learn more about the EAC, refer to the EAC webpage .

Why GraphQL API?

#

GraphQL is a modern and flexible query language for APIs, empowering developers to efficiently retrieve the precise data they need from complex systems. With its intuitive syntax and powerful features, GraphQL simplifies the process of fetching data and eliminates over-fetching or under-fetching of information. The EAC has embraced GraphQL as the primary means of accessing and manipulating data within our solution, offering you a streamlined and optimised experience.

What does this guide offer?

#

This guide serves as your go-to resource for understanding the EAC GraphQL API and harnessing its potential. Whether you're a beginner or an experienced GraphQL developer, we will take you through the fundamentals and advanced concepts, providing you with clear explanations, examples, and best practices along the way. Here's a glimpse of what you can expect:

  1. Getting started : We will walk you through the initial setup and authentication process required to access the EAC GraphQL API.
  2. Auction sessions : Understand the lifecycle of auctions in EAC. Learn how to retrieve future and past auctions.
  3. Baskets : Learn what is a basket and discover with practical examples how to query and manipulate them with the EAC GraphQL API.
  4. Auction results : Get familiar with the results of the auctions, what you can expect and how to retrieve them with the EAC GraphQL API.
  5. GraphQL : New to GraphQL? Learn about GraphQL, how it works, and how to use it.
  6. Queries : Understand the syntax and conventions of querying data using GraphQL. Learn how to construct queries to fetch specific data fields and related entities, enabling you to retrieve the precise information you need.
  7. Mutations : Explore the capabilities of GraphQL mutations to create, update, and delete data within the EAC. Discover how to make changes to entities while maintaining data integrity.
  8. Types : Discover the underlying data model and schema structure of the EAC. Learn how to navigate through the available types, fields, and relationships to understand the data you can query and manipulate.