PlantPredict API

 

The engine powering PlantPredict’s web interface is the PlantPredict API (Application Programming Interface). All of the calculations, models and algorithms necessary to process data, manage the asset libraries, and run complex utility-scale energy predictions are done by PlantPredict’s API – in other words, “the backend” of PlantPredict.

Anyone with a PlantPredict account and access to their API credentials (through their company administrator) can access all of PlantPredict’s functionality through the API directly. This enables powerful scripting and automation of high-time-resolution, complex, utility-scale energy predictions, which in turn can supercharge your business or analytical needs – a capability that is unparalleled in the industry. No UI interaction necessary!

Below is an example of a command that can be sent directly to the API – in this case, to create a new module.

 

1. Create a Module

Command to create a new Module using the contents of the file “Module_POST_Request.txt”

The new module id will be found in a file called “Module_POST_Response.txt” that is created by this command:

curl -o "Module_POST_Response.txt" -d @"Module_POST_Request.txt" "https://app.plantpredict.com/api/Module" -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Bearer <access_token>"

 

 

The PlantPredict API is programming language-agnostic, and can be used with any language or tool capable of making HTTP requests. The API Starter Kit, available for download below, provides all of the resources necessary to get started with the API.  Of course, we’re always here to help at support@plantpredict.com

Click the link below to download the API Starter Kit

PlantPredict API Starter Kit

PlantPredict API Developer Guide

 

PlantPredict Python SDK (BETA)

The PlantPredict Python SDK (Software Development Kit) is currently an unofficial offering in its Beta phase. Created by engineer Stephen Kaplan, it is a library/package written in the Python programming language designed to make interacting with the PlantPredict API easy for developers, engineers, scientists, students, and anyone with a very basic understanding of Python. External documentation including installation instructions and many example use cases can be found HERE.