Virtual Power Plant API¶

Virtual Power Plant (VPP) integration API allows you to get and update energy price information that can be used to optimize services and power consumption.

API Usage¶

See Token Management API for more information on how to create and use the access token.

Update Energy Prices¶

Prepare Request Body¶

To prepare a request body, perform the following steps.

1. Set site ID to the request path parameter siteId.
2. Set Content-Type header as application/json and use the parameters schema VPPEnergyPricesBody as described in VPP API Reference.

Example Request¶

export ACCESS_TOKEN = <YOUR_ACCESS_TOKEN>

export SITE_ID = <YOUR_SITE_ID>
export START = <YOUR_START>
export DURATION = <YOUR_DURATION>
export PRICE = <YOUR_PRICE>

curl --location --request POST 'https://api.eu.depot.emobility.io/v1/vppController/$SITE_ID/energyPrices' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $ACCESS_TOKEN' \
--data-raw '{
    "PricesJsonStr": {
        "blocks": [
            {
                "start": $START,
                "duration": $DURATION,
                "price": $PRICE
            }
        ]
    }
}'

Response Body¶

Successful response returns 200 HTTP status code with response body as Success schema. For more information, see VPP API Reference.

Example Response¶

{
    "code": 200,
    "message": "Energy prices have been updated."
}

Get Energy Prices¶

Prepare Request Body¶

To prepare a request body, perform the following steps.

1. Set site ID to the request path parameter siteId. See VPP API Reference.

Example Request¶

export ACCESS_TOKEN = <YOUR_ACCESS_TOKEN>

export SITE_ID = <YOUR_SITE_ID>

curl --location --request GET 'https://api.eu.depot.emobility.io/v1/vppController/$SITE_ID/energyPrices' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $ACCESS_TOKEN'

Response Body¶

Successful response returns 200 HTTP status code with response body as VPPEnergyPricesResponse schema. For more information, see VPP API Reference.

Example Response¶

{
    "ClientID": "XYZ",
    "SiteID": "ABC",
    "PricesJsonStr": {
        "blocks": [
            {
                "start": "2023-02-04T23:00:00Z",
                "duration": 30,
                "price": 9.74
            }
        ]
    }
}

Get Power Consumption¶

Prepare Request Body¶

To prepare a request body, perform the following steps.

1. Set site ID to the request path parameter siteId. See VPP API Reference.

Example Request¶

export ACCESS_TOKEN = <YOUR_ACCESS_TOKEN>

export SITE_ID = <YOUR_SITE_ID>

curl --location --request GET 'https://api.eu.depot.emobility.io/v1/vppController/$SITE_ID/powerConsumption' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $ACCESS_TOKEN'

Response Body¶

Successful response returns 200 HTTP status code with response body as PowerConsumptionResponse schema. For more information, see VPP API Reference.

Example Response¶

{
    "data" : {
        "PowerConsumption": [1,2,4],
        "StartTime": "2020-02-05T23:15:00Z",
        "TimeSlotLength": 20
    }
}