Introduction

What's in the REST API Reference Section

This section has the main details about each of the APIs in our Signal product, 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.

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 on 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 are grouped

The following table shows how we've logically grouped our APIs on this site. We've also added a column for whether the API is built into the Data Explorer web application (most but not all are). When the entry is "Partial", only some of the APIs are integrated into Data Explorer.

APIs	Overview	DATA EXPLORER	SIGNAL API
Calculation APIs	On-demand calculators (rate engine) for bill matching, rate comparisons, what-ifs, and project economics	Partial (1)	Yes
Tariff APIs	All our utility, tariff, TOU, calendar, and related data	Yes	Yes
Other APIs	Other useful APIs such as Typical usage and property meta-data \|	Partial (2)	Yes

Only the On-demand Cost Calculator, not the Mass Calculator
The typical usage data is available to use in the calculator, but not to browse in a UI