> For the complete documentation index, see [llms.txt](https://developer.ideavate.co.uk/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.ideavate.co.uk/guides/open-utilities-api/introduction.md).

# Introduction

Introduction to Open Utilities API

## Terminology

A **Provider** is a business or organisation that supplies a utility or other kind of service to an **End User**. The End User is said to hold an **Account** with the Provider.

A **Client Application** is an application or service that wishes to get access to the Account details held by a Provider after gaining consent to do so from the End User.

The **Open Utilities API** are the set of APIs provided by Ideavate that allow a Client Application to achieve this consented access.

{% @mermaid/diagram content="graph
C(Client Application)
I(Ideavate<br/>Open Utilites API)
EU((End User))
A\[(Account)]

C -. Client App wishes to access the Account .-> A
C -- Client App uses Ideavate APIs--- I

I -- Ideavate gains consent from End User --- EU
EU -- End User has an Account with Provider --- A

A -- Ideavate retrieves data from Provider --- I

subgraph Provider
A
end" %}

## High level process

1. End User gives consent and shares credentials
2. Open Utilities API uses the credentials for accessing the Account data held by the Provider
3. Client Application queries the data via Open Utilities API