# WattShift Documentation ## Docs - [Calculate monthly bill](https://docs.wattshift.com/api-reference/endpoint/homes/calculate-monthly-bill.md) - [Calculate period bill](https://docs.wattshift.com/api-reference/endpoint/homes/calculate-period-bill.md) - [Calculate period bill using a specific rate plan](https://docs.wattshift.com/api-reference/endpoint/homes/calculate-period-bill-using-a-specific-rate-plan.md) - [Create home](https://docs.wattshift.com/api-reference/endpoint/homes/create-home.md) - [Create solar](https://docs.wattshift.com/api-reference/endpoint/homes/create-solar.md) - [Find home](https://docs.wattshift.com/api-reference/endpoint/homes/find-home.md) - [Get battery estimated savings](https://docs.wattshift.com/api-reference/endpoint/homes/get-battery-estimated-savings.md) - [Get hvac estimated savings monthly or annual](https://docs.wattshift.com/api-reference/endpoint/homes/get-hvac-estimated-savings-monthly-or-annual.md) - [Get price signal](https://docs.wattshift.com/api-reference/endpoint/homes/get-price-signal.md) - [Get price signal for rate plan](https://docs.wattshift.com/api-reference/endpoint/homes/get-price-signal-for-rate-plan.md) - [Get price signal open adr](https://docs.wattshift.com/api-reference/endpoint/homes/get-price-signal-open-adr.md) - [List home hvac devices](https://docs.wattshift.com/api-reference/endpoint/homes/list-home-hvac-devices.md) - [List homes](https://docs.wattshift.com/api-reference/endpoint/homes/list-homes.md) - [Remove home](https://docs.wattshift.com/api-reference/endpoint/homes/remove-home.md) - [Update home](https://docs.wattshift.com/api-reference/endpoint/homes/update-home.md) - [Find hvac](https://docs.wattshift.com/api-reference/endpoint/hvac/find-hvac.md) - [Get set point schedule](https://docs.wattshift.com/api-reference/endpoint/hvac/get-set-point-schedule.md) - [Get user preference](https://docs.wattshift.com/api-reference/endpoint/hvac/get-user-preference.md) - [Preview](https://docs.wattshift.com/api-reference/endpoint/hvac/preview.md) - [Record thermostat behavior](https://docs.wattshift.com/api-reference/endpoint/hvac/record-thermostat-behavior.md) - [Remove hvac](https://docs.wattshift.com/api-reference/endpoint/hvac/remove-hvac.md) - [Remove hvac 1](https://docs.wattshift.com/api-reference/endpoint/hvac/remove-hvac-1.md) - [Set user preference](https://docs.wattshift.com/api-reference/endpoint/hvac/set-user-preference.md) - [Set webhook set points](https://docs.wattshift.com/api-reference/endpoint/hvac/set-webhook-set-points.md) - [Set webhook thermostat behavior](https://docs.wattshift.com/api-reference/endpoint/hvac/set-webhook-thermostat-behavior.md) - [Update hvac](https://docs.wattshift.com/api-reference/endpoint/hvac/update-hvac.md) - [Url for today view](https://docs.wattshift.com/api-reference/endpoint/hvac/url-for-today-view.md) - [Check eligibility for zipcode](https://docs.wattshift.com/api-reference/endpoint/onboarding/check-eligibility-for-zipcode.md) - [Generate onboarding url](https://docs.wattshift.com/api-reference/endpoint/onboarding/generate-onboarding-url.md) - [Generate session token](https://docs.wattshift.com/api-reference/endpoint/onboarding/generate-session-token.md) - [Get onboarding status](https://docs.wattshift.com/api-reference/endpoint/onboarding/get-onboarding-status.md) - [Create a contact us message](https://docs.wattshift.com/api-reference/endpoint/public-user/create-a-contact-us-message.md) - [List utilities](https://docs.wattshift.com/api-reference/endpoint/utility/list-utilities.md) - [Trigger webhook](https://docs.wattshift.com/api-reference/endpoint/webhook/trigger-webhook.md) - [calculate monthly bill impact](https://docs.wattshift.com/api-reference/homes/calculate-monthly-bill-impact.md): Calculates monthly bill cost and includes grid-services revenue and carbon impact when home context and signal data are available. - [calculate period bill impact](https://docs.wattshift.com/api-reference/homes/calculate-period-bill-impact.md): Calculates bill cost for a custom date range and includes optional grid-services revenue and carbon impact when home context and signal data are available. - [calculate period bill using a specific rate plan](https://docs.wattshift.com/api-reference/homes/calculate-period-bill-using-a-specific-rate-plan.md): Bill calculation for a MongoDB rate plan id only (no home). Carbon and grid revenue are omitted without a home zipcode. - [create home](https://docs.wattshift.com/api-reference/homes/create-home.md) - [create solar](https://docs.wattshift.com/api-reference/homes/create-solar.md) - [find home](https://docs.wattshift.com/api-reference/homes/find-home.md) - [get battery estimated savings](https://docs.wattshift.com/api-reference/homes/get-battery-estimated-savings.md) - [get HVAC estimated savings (monthly or annual)](https://docs.wattshift.com/api-reference/homes/get-hvac-estimated-savings-monthly-or-annual.md) - [get price signal](https://docs.wattshift.com/api-reference/homes/get-price-signal.md) - [get price signal for rate plan](https://docs.wattshift.com/api-reference/homes/get-price-signal-for-rate-plan.md) - [get price signal open adr](https://docs.wattshift.com/api-reference/homes/get-price-signal-open-adr.md) - [list home hvac devices](https://docs.wattshift.com/api-reference/homes/list-home-hvac-devices.md) - [list homes](https://docs.wattshift.com/api-reference/homes/list-homes.md) - [remove home](https://docs.wattshift.com/api-reference/homes/remove-home.md) - [update home](https://docs.wattshift.com/api-reference/homes/update-home.md) - [find HVAC](https://docs.wattshift.com/api-reference/hvac/find-hvac.md) - [get set point schedule](https://docs.wattshift.com/api-reference/hvac/get-set-point-schedule.md) - [get user preference](https://docs.wattshift.com/api-reference/hvac/get-user-preference.md) - [preview](https://docs.wattshift.com/api-reference/hvac/preview.md) - [record thermostat behavior](https://docs.wattshift.com/api-reference/hvac/record-thermostat-behavior.md) - [remove HVAC](https://docs.wattshift.com/api-reference/hvac/remove-hvac.md) - [remove HVAC](https://docs.wattshift.com/api-reference/hvac/remove-hvac-1.md) - [set user preference](https://docs.wattshift.com/api-reference/hvac/set-user-preference.md) - [set webhook set-points](https://docs.wattshift.com/api-reference/hvac/set-webhook-set-points.md) - [set webhook thermostat behavior](https://docs.wattshift.com/api-reference/hvac/set-webhook-thermostat-behavior.md) - [update HVAC](https://docs.wattshift.com/api-reference/hvac/update-hvac.md) - [url for today view](https://docs.wattshift.com/api-reference/hvac/url-for-today-view.md) - [Introduction](https://docs.wattshift.com/api-reference/introduction.md): API Reference for WattShift - [check eligibility for zipcode](https://docs.wattshift.com/api-reference/onboarding/check-eligibility-for-zipcode.md) - [generate onboarding url](https://docs.wattshift.com/api-reference/onboarding/generate-onboarding-url.md) - [generate session token](https://docs.wattshift.com/api-reference/onboarding/generate-session-token.md) - [get onboarding status](https://docs.wattshift.com/api-reference/onboarding/get-onboarding-status.md) - [Delete v1partnersuser](https://docs.wattshift.com/api-reference/partners/delete-v1partnersuser.md) - [Get v1partnersapi request countsall organizations](https://docs.wattshift.com/api-reference/partners/get-v1partnersapi-request-countsall-organizations.md) - [Post v1partnerschannel partnersdevices](https://docs.wattshift.com/api-reference/partners/post-v1partnerschannel-partnersdevices.md) - [Post v1partnerschannel partnersdeviceshome](https://docs.wattshift.com/api-reference/partners/post-v1partnerschannel-partnersdeviceshome.md) - [Post v1partnerschannel partnershomes](https://docs.wattshift.com/api-reference/partners/post-v1partnerschannel-partnershomes.md) - [Post v1partnerschannel partnerslink](https://docs.wattshift.com/api-reference/partners/post-v1partnerschannel-partnerslink.md) - [Post v1partnerscreate key](https://docs.wattshift.com/api-reference/partners/post-v1partnerscreate-key.md) - [Post v1partnerscreate user](https://docs.wattshift.com/api-reference/partners/post-v1partnerscreate-user.md) - [Post v1partnersget dashboard info](https://docs.wattshift.com/api-reference/partners/post-v1partnersget-dashboard-info.md) - [Post v1partnersget devices](https://docs.wattshift.com/api-reference/partners/post-v1partnersget-devices.md) - [Post v1partnersget deviceshome](https://docs.wattshift.com/api-reference/partners/post-v1partnersget-deviceshome.md) - [Post v1partnersget homes](https://docs.wattshift.com/api-reference/partners/post-v1partnersget-homes.md) - [Post v1partnersget keys](https://docs.wattshift.com/api-reference/partners/post-v1partnersget-keys.md) - [Post v1partnersget organizations](https://docs.wattshift.com/api-reference/partners/post-v1partnersget-organizations.md) - [Post v1partnersget user](https://docs.wattshift.com/api-reference/partners/post-v1partnersget-user.md) - [Post v1partnersget users](https://docs.wattshift.com/api-reference/partners/post-v1partnersget-users.md) - [Create a contact us message](https://docs.wattshift.com/api-reference/public-user/create-a-contact-us-message.md) - [list utilities](https://docs.wattshift.com/api-reference/utility/list-utilities.md) - [trigger webhook](https://docs.wattshift.com/api-reference/webhook/trigger-webhook.md) - [Querying Homes and Devices](https://docs.wattshift.com/docs/advanced_options/query-homes.md) - [Rate Plan ID Intro & Usage](https://docs.wattshift.com/docs/advanced_options/rate-plan-Id-Intro&usage.md): How to find, use, and understand WattShift rate plan IDs - [Rate Plan ID - Full Specification and Examples](https://docs.wattshift.com/docs/advanced_options/rate-plan-Id-full-Spec&Examples.md): Semantic rate ID schema used by normalized WattShift tariff data - [Authenticating API Calls](https://docs.wattshift.com/docs/get_started/authentication.md): Authentication and Making API Calls - [Environments](https://docs.wattshift.com/docs/get_started/environments.md): Testing out WattShift on sandbox - [Get API Key](https://docs.wattshift.com/docs/get_started/get-api-keys.md): How to obtain API keys for sandbox and production environments - [Quickstart Guide](https://docs.wattshift.com/docs/get_started/quickstart.md): From Zero to Price Signal in 5 Minutes - [Integration Overview](https://docs.wattshift.com/docs/home/integration-overview.md) - [Welcome!](https://docs.wattshift.com/docs/home/welcome.md): Welcome to WattShift Documentation - [API Based Onboarding](https://docs.wattshift.com/docs/onboard_sites/api-based-onboarding.md): Onboard homes programmatically - [[Beta] Bill Upload Auto Onboarding](https://docs.wattshift.com/docs/onboard_sites/bill_upload_auto_onboard.md): Onboard sites by uploading utility bills - [UI-Based Onboarding Flow](https://docs.wattshift.com/docs/onboard_sites/onboarding.md): Display our onboarding UI in your app - [Onboarding Options](https://docs.wattshift.com/docs/onboard_sites/prepare-onboarding.md): Generate Onboarding URL with User Context - [Estimate Savings](https://docs.wattshift.com/docs/optimize_shifts_calculate_impacts/estimate-savings.md): Calculate potential savings for HVAC and Battery systems - [Impact Calculations](https://docs.wattshift.com/docs/optimize_shifts_calculate_impacts/impact_calculations.md): Calculate bill cost, grid-services revenue, and carbon impact from interval usage data - [Price Signals for Shifting Optimization](https://docs.wattshift.com/docs/optimize_shifts_calculate_impacts/price_signal.md): Getting price signals for onboarded homes - [Shift Watts!](https://docs.wattshift.com/docs/optimize_shifts_calculate_impacts/receiving-updates.md): Responding to Optimized Schedules - [Updating User Preferences](https://docs.wattshift.com/docs/optimize_shifts_calculate_impacts/user-preferences.md) ## OpenAPI Specs - [openapi](https://docs.wattshift.com/api-reference/openapi.json) - [pnpm-lock](https://docs.wattshift.com/pnpm-lock.yaml) - [package](https://docs.wattshift.com/package.json) - [settings](https://docs.wattshift.com/.vscode/settings.json)