Skip to main content
POST
/
v1
/
homes
/
{id}
/
price_signal
get price signal
curl --request POST \
  --url https://api.example.com/v1/homes/{id}/price_signal \
  --header 'Content-Type: application/json' \
  --header 'x-ws-api-key: <api-key>' \
  --data '
{
  "startTime": "2025-02-25T16:13:37.902Z",
  "endTime": "2025-02-26T16:13:37.902Z"
}
'
{
  "homeId": "ws_home_123456789",
  "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,
      "confidence": 0.95
    },
    {
      "startTime": "2025-02-26T01:13:37.902Z",
      "endTime": "2025-02-26T04:13:37.902Z",
      "price": 0.46486,
      "import": 0.46486,
      "export": 0,
      "confidence": 0.95
    },
    {
      "startTime": "2025-02-26T04:13:37.902Z",
      "endTime": "2025-02-26T16:13:37.902Z",
      "price": 0.42625,
      "import": 0.42625,
      "export": 0,
      "confidence": 0.95
    }
  ],
  "prices": [
    0.42625,
    0.46486,
    0.42625
  ],
  "export": [
    0,
    0,
    0
  ],
  "import": [
    0.42625,
    0.46486,
    0.42625
  ]
}

Authorizations

x-ws-api-key
string
header
required

Headers

x-ws-api-key
string

WattShift API Key

Path Parameters

id
string
required

Body

application/json
startTime
string | null
endTime
string | null

Response

200 - application/json
startTime
any
required
endTime
any
required
data
object[]
required
prices
number[]
required

expected price in $/kWh in 15min intervals

export
number[]
required

import rate in $/kWh in 15min intervals

import
number[]
required

export rate in $/kWh in 15min intervals

homeId
string
required