Skip to content

API Developer Guide

Matt Magoffin edited this page May 11, 2024 · 11 revisions

SolarNetwork exposes some web service methods for use by developers wishing to create applications that integrate with SolarNetwork.

API Explorer

Use the API Explorer to try out the SolarNetwork API, which has API templates to help you form appropriate API calls.

JavaScript library

Use the solarnetwork-api-core JavaScript library to help you use the SolarNetwork API in web applications.

Use the solarnetwork-datum-loader JavaScript library to help you query datum streams using the SolarQuery API.

JavaScript examples

Here are some examples that demonstrate using the SolarNetwork API:

Example Description
Chart using TypeScript and Billboard.js TypeScript project that demonstrates using the solarnetwork-api-core package to make authenticated API calls that drive the generation of an area chart using the billboard.js library.
Datum Loader using TypeScript TypeScript project that demonstrates using the solarnetwork-datum-loader package to make authenticated API calls to fetch large data sets from SolarNetwork.
Datum Loader CLI NodeJS CLI app that demonstrates using the solarnetwork-datum-loader package to make authenticated API calls to fetch large data sets from SolarNetwork in a NodeJS environment.

SolarNetwork API access

For information on the URLs needed to access SolarNetwork services, see the SolarNet API access page.

SolarNetwork API authentication

Some web services require authentication. All SolarNetwork applications use the same authentication scheme, detailed on the SolarNet API authentication page.

SolarIn API

The SolarIn application exposes methods for posting the data collected by SolarNodes. See the SolarIn API page for more details.

SolarQuery API

The SolarQuery application exposes methods for querying the data collected by SolarNodes. See the SolarQuery API page for more details.

SolarUser API

The SolarUser application exposes methods for manipulating SolarNodes. See the SolarUser API page for more details.

Clone this wiki locally