What’s in the REST API Reference Section

This section has the main details about each of our APIs, including their endpoints, and the data structures that are passed in and come out. Our APIs are organized into logical groups that put together common resource types and endpoints. Our products themselves sometimes give access to more than one API which allows us to reuse APIs across products where it makes sense. See below for how APIs map to Products.

How we structure each page

Each page starts with an overview of that page’s resource type and related endpoints. This lets you know if you are in the right page. Next up is a Data Definition section. This tells you in detail what fields are returned, what their data type is, and what is typically contained in them. There will usually be an example in JSON too. Then the page will have an Operations section that shows the endpoints available and the path and parameters supported for each endpoint. You’ll find a number of examples that show the request and sometimes response for common use-cases.

How APIs map to Products

The following table shows which APIs are included in which product. Columns are products, rows are APIs. When the entry is “Partial”, only some of the APIs are included, on an as needed basis.

  Switch Signal
Calculation API - Yes
Tariff APIs Partial Yes
Account APIs Yes -
Savings Analysis APIs Yes -
Smart APIs Yes -
Shared APIs Partial Partial

Note that in 2019 we merged our Conduct product into Switch.

Note also that the Open Savings API is a special case. It is an open source API that is free to use by anyone (attribution required). It is usable as-is and does not need any other API to use it.