API Reference Introduction
Find Signal REST API endpoints, data structures, and examples organized by resource type.
Use this guide to map Signal API resource groups to the endpoint pages, schemas, and examples you need.
Use the API Reference button in the header to open the endpoint pages. There you can review endpoint paths, request parameters, response examples, and the interactive call builder tool.
What each reference page includes
- Resource overview: A summary of the resource type and the related endpoints on that page.
- Data definitions: Field-level details for request and response objects, including data types and example JSON when available.
- Operations: Supported endpoints, paths, parameters, and example requests or responses for common use cases.
How APIs are grouped
Choose the API group that matches the data or workflow you need. Each section also notes whether the API is available in the Data Explorer web application.
Use these APIs for on-demand calculations such as bill matching, rate comparisons, what-if scenarios, and project economics.
Data Explorer: Partial (Only the On-demand Cost Calculator, not the Mass Calculator)
Signal API: Yes
Use these APIs to work with utility, tariff, TOU, calendar, and related data.
Data Explorer: Yes
Signal API: Yes
Use these APIs for additional data sets such as typical usage and property metadata.
Data Explorer: Partial (The typical usage data is available to use in the calculator, but not to browse in a UI)
Signal API: Yes
Updated 1 day ago