Github

Join our Slack

Rebase Platform Documentation

API Reference

Get started

Support

Get the types of actuals available for a site

Get Site Actual Types

Type

ActualType

Field

Message

ErrorItem

APIKeyHeader

Response Get Site Actual Types Platform V2 Sites  Site Id  Actual Types Get

ValidationResponse

The Python-first energy forecasting platform

Introduction

Welcome to Rebase Platform Documentation!

How it works

APIs for accessing energy-relevant data sources in one place.

Data APIs

Quickstart

Tutorial to Get Started with Rebase API

Authorization

Create, update or delete forecast sites in the Rebase Platform.

Supported sites

Create a new wind site to forecast in the Rebase Platform.

Wind

How to create a wind site

Create a new solar site to forecast in the Rebase Platform.

Solar

How to create a solar site

Create a new electricity demand site to forecast in the Rebase Platform.

Load

How to create a load site

Update site

How to update a site

Delete site

How to delete a site

Retrieve the IDs of the sites and other meta data

Get site meta

How to get site meta data

Upload measured generation or consumption data to a site

Measured power

How to upload the power measurements

Upload the site capacity changes over the time

Capacities

How to upload the capacity

Upload weather and other time series to a site

Other data

How to upload other measured data

Trigger the training of a site's ML forecast models

Train models

How to train ML models

Get the most recently updated forecast for a site

Latest forecast

How to get the latest forecast

Create a new site to forecast in the Rebase Platform.

Create site

How to create new sites

Create multiple sites to be forecasted using the UI

Create multiple sites

Visualize the forecast

Edit forecast

List all of your sites. Returns meta data about the sites. The site ids can be used in other endpoints to query the forecast, actuals, and models etc.

List Sites

Get Site

Create a new site

You can create a site with the following types:
- solar
- wind
- load

Create Site

Update the information of a site, e.g. name, assets

Update Site

Delete Site

Get the actuals of a site for a given date range

Get Site Actuals

Upload the actuals (energy production/energy consumption) for a site.

This is used for training the ML models and evaluating the forecast accuracy.

Upload Site Actuals

Delete the actuals of a site for a given date range

Delete Site Actuals

Get the capacity of a site for a given date range

Get Site Capacity

Update the available capacity of a site. Upload the timestamps that the capacity changes,
the capacity will be forward filled from every timestamp.

Upload Site Capacity

Delete the capacity of a site for a given date range

Delete Site Capacity

Get the forecast of a site for a given date range.

If no start_date is provided, 00:00 UTC of the current day is used.

Get Site Forecast

Returns the timestamps of the forecast updates for a site

Get Site Forecast Updates

List the models of a site. Returns meta data about the models as well as training status.

List Site Models

Train the models for one or more sites, specified by their site_id

Train Site Models

Get the output produced by a model, as_of can be specified
to get the output as it was at a specific point in time

If no start_date is provided, the start_date will today 00:00 UTC

API Documentation

Get Site Actual Types

Authorizations

Path Parameters

Response