# WattShift Documentation

## Docs

- [Battery estimate savings](https://docs.wattshift.com/api-reference/endpoint/homes/battery-estimate-savings.md)
- [find home](https://docs.wattshift.com/api-reference/endpoint/homes/find-home.md)
- [get price signal](https://docs.wattshift.com/api-reference/endpoint/homes/get-price-signal.md)
- [get price signal open adr](https://docs.wattshift.com/api-reference/endpoint/homes/get-price-signal-open-adr.md)
- [Hvac estimate savings](https://docs.wattshift.com/api-reference/endpoint/homes/hvac-estimate-savings.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)
- [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)
- [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)
- [Introduction](https://docs.wattshift.com/api-reference/introduction.md): API Reference for WattShift
- [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): Demonstrate bills savings, grid revenue
- [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)