Skip to main content
POST
get price signal

Authorizations

x-ws-api-key
string
header
required

WattShift API key

Headers

x-ws-api-key
string

WattShift API Key

Path Parameters

id
string
required

Body

application/json

Optional home-context signal window. If either startTime or endTime is provided, provide both.

startTime
string | null
endTime
string | null

Response

startTime
any
required
endTime
any
required
data
object[]
required
prices
number[]
required

expected price in $/kWh in 15min intervals

export
number[]
required

export rate in $/kWh in 15min intervals

import
number[]
required

import rate in $/kWh in 15min intervals

homeId
string
required
exportCompensation
object

metadata for the export compensation source used to populate export prices