[POST] /v1/homes/<homeId>/price_signal
Copy
// Request Body
// [POST] /v1/homes/ws_home_7bc31940df8a4615b2dc9e84f3a92c51/price_signal
{
"startTime": "2025-02-25T16:13:37.902Z",
"endTime": "2025-02-26T16:13:37.902Z"
}
Copy
{
"homeId":"ws_home_7bc31940df8a4615b2dc9e84f3a92c51",
"startTime":"2025-02-25T16:13:37.902Z",
"endTime":"2025-02-26T16:13:37.902Z",
"data":[
{
"startTime":"2025-02-25T16:13:37.902Z",
"endTime":"2025-02-26T01:13:37.902Z",
"price":0.42625,
"import":0.42625,
"export":0
},
{
"startTime":"2025-02-26T01:13:37.902Z",
"endTime":"2025-02-26T04:13:37.902Z",
"price":0.46486,
"import":0.46486,
"export":0
},
{
"startTime":"2025-02-26T04:13:37.902Z",
"endTime":"2025-02-26T16:13:37.902Z",
"price":0.42625,
"import":0.42625,
"export":0
}
],
"prices":[
0.42625,
0.42625,
...
0.42625,
0.46486,
...
0.46486,
0.46486,
0.46486,
0.42625,
0.42625,
...
0.42625,
0.42625
],
"imports":[
0.42625,
0.42625,
...
0.42625,
0.46486,
...
0.46486,
0.46486,
0.46486,
0.42625,
0.42625,
...
0.42625,
0.42625
],
"exports":[
0.0,
0.0,
...
0.0,
0.0
]
}
prices
represents $ / kWh for a 15-minute interval, starting at
startTime
until endTime
.
OpenADR 3.0
We also make this data available in OpenADR 3.0 format.Copy
await wattshiftApiCall(
`/homes/ws_home_7bc31940df8a4615b2dc9e84f3a92c51/price_signal/open_adr`,
);
Copy
{
"id": "12227765-47a7-4441-b9c4-215c779938e7",
"programID": "wattshift-open-adr",
"createdDateTime": "2024-12-22T23:38:09.218Z",
"modificationDateTime": "2024-12-22T23:38:09.218Z",
"eventName": "Price Event 2024-12-22",
"intervalPeriod": {
"start": "2024-12-22T23:38:09.218Z",
"duration": "PT24H"
},
"intervals": [
{
"id": 0,
"intervalPeriod": {
"start": "2024-12-22T23:38:09.218Z",
"duration": "PT1H"
},
"payloads": [
{
"type": "PRICE",
"values": [
0.4007
]
}
]
},
{
"id": 1,
"intervalPeriod": {
"start": "2024-12-23T00:38:09.218Z",
"duration": "PT4H"
},
"payloads": [
{
"type": "PRICE",
"values": [
0.3897
]
}
]
},
{
"id": 2,
"intervalPeriod": {
"start": "2024-12-23T04:38:09.218Z",
"duration": "PT1H"
},
"payloads": [
{
"type": "PRICE",
"values": [
0.4007
]
}
]
},
{
"id": 3,
"intervalPeriod": {
"start": "2024-12-23T05:38:09.218Z",
"duration": "PT2H"
},
"payloads": [
{
"type": "PRICE",
"values": [
0.4118
]
}
]
},
{
"id": 4,
"intervalPeriod": {
"start": "2024-12-23T07:38:09.218Z",
"duration": "PT1H"
},
"payloads": [
{
"type": "PRICE",
"values": [
0.3938
]
}
]
},
{
"id": 5,
"intervalPeriod": {
"start": "2024-12-23T08:38:09.218Z",
"duration": "PT14H"
},
"payloads": [
{
"type": "PRICE",
"values": [
0.3758
]
}
]
},
{
"id": 6,
"intervalPeriod": {
"start": "2024-12-23T22:38:09.218Z",
"duration": "PT1H"
},
"payloads": [
{
"type": "PRICE",
"values": [
0.3938
]
}
]
}
]
}