Skip to main content
POST
/
v1
/
homes
/
bill-upload
[Beta] Onboard a site by uploading utility bill PDFs
curl --request POST \
  --url https://api.example.com/v1/homes/bill-upload \
  --header 'Content-Type: application/json' \
  --header 'x-ws-api-key: <api-key>' \
  --data '
{
  "name": "My home",
  "zipcode": "94107",
  "customerClass": "residential",
  "billPDFs": [
    "https://example.com/bills/january.pdf"
  ],
  "solarSystemSizeKw": 5,
  "isNonNetMetered": false,
  "hasEvCharger": true
}
'
{
  "id": "ws_home_123456789",
  "status": "processing"
}

Authorizations

x-ws-api-key
string
header
required

WattShift API key

Headers

x-ws-api-key
string

WattShift API Key

Body

application/json
name
string
required

The name of the site/home

Required string length: 1 - 255
zipcode
string
required

The zip code of the site

Pattern: ^\d{5}(?:[- ]\d{4})?$
customerClass
enum<string>
required
Available options:
residential,
commercial,
industrial
billPDFs
string<uri>[]
required

URLs pointing to the utility bill PDF(s)

Required array length: 1 - 5 elements
solarSystemSizeKw
number
Required range: x > 0
isNonNetMetered
boolean
utilityEIAId
string
Pattern: ^\d+$
ratePlanId
string
userId
string
hasEvCharger
boolean | null
hasElectricHeater
boolean | null
hasSmartWaterHeater
boolean | null
hasElectricWaterHeater
boolean | null
hasAC
boolean | null
acType
enum<string> | null
Available options:
central,
window,
split,
other
peakDemand
number
Required range: x > 0

Response

200 - application/json
id
string
required

The newly created home ID

status
enum<string>
required
Available options:
processing,
completed,
failed