{
"request_id": "req_123",
"error_code": "AUTH_MISSING_API_KEY",
"message": "Missing x-ws-api-key header.",
"recovery_action": "Provide the x-ws-api-key header. If this contradicts the public docs or OpenAPI contract, submit structured feedback through /v1/feedback."
}
homes
get battery estimated savings
Estimates annual solar+battery savings for a home. Month inputs use calendar month numbers 1-12.
{
"request_id": "req_123",
"error_code": "AUTH_MISSING_API_KEY",
"message": "Missing x-ws-api-key header.",
"recovery_action": "Provide the x-ws-api-key header. If this contradicts the public docs or OpenAPI contract, submit structured feedback through /v1/feedback."
}
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"WattShift Documentation","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/wattshift/nRrIEJpPCWJRYPos/images/logo.png?fit=max\u0026auto=format\u0026n=nRrIEJpPCWJRYPos\u0026q=85\u0026s=4f036ac2553148e6902032822b918ff4","dark":"https://mintcdn.com/wattshift/nRrIEJpPCWJRYPos/images/logo.png?fit=max\u0026auto=format\u0026n=nRrIEJpPCWJRYPos\u0026q=85\u0026s=4f036ac2553148e6902032822b918ff4"},"favicon":"https://mintcdn.com/wattshift/nRrIEJpPCWJRYPos/images/favicon.webp?fit=max\u0026auto=format\u0026n=nRrIEJpPCWJRYPos\u0026q=85\u0026s=5a2ec6828c140aaa5a2aa243316cdf50","navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}]},"footer":{"socials":{"github":"https://github.com/WattShift","linkedin":"https://www.linkedin.com/company/wattshift"}},"integrations":{"telemetry":{"enabled":false}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"wattshift","hasAudioNarration":false,"actualSubdomain":"wattshift","customDomains":["docs.wattshift.com"],"gitSource":{"type":"github","owner":"wattshift","repo":"wattshift-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a740cb80052849904a14ad7","collectionId":"e4770bca-5c97-4806-9352-ca5c06d8a8a7","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a740cb80052849904a14ad7"},"entitlements":{},"buildId":"6a740cb80052849904a14ad7:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":131},{"language":"default","tag":"Endpoints","count":43},{"language":"default","tag":"Documentation","count":38},{"language":"default","tag":"homes","count":36},{"language":"default","tag":"hvac","count":22},{"language":"default","tag":"onboarding","count":8},{"language":"default","tag":"webhook","count":8},{"language":"default","tag":"Getting Started","count":5},{"language":"default","tag":"Optimize Shifts and Calculate Impacts","count":5},{"language":"default","tag":"agent-credentials","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/homes/get-battery-estimated-savings","slug":"/api-reference/endpoint/homes/get-battery-estimated-savings","pageMetadata":{"openapi":"api-reference/openapi.json POST /v1/homes/{id}/battery/estimate_savings","title":"get battery estimated savings","description":"Estimates annual solar+battery savings for a home. Month inputs use calendar month numbers 1-12.","href":"/api-reference/endpoint/homes/get-battery-estimated-savings"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Estimates annual solar+battery savings for a home. Month inputs use calendar month numbers 1-12.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"api-reference/openapi.json POST /v1/homes/{id}/battery/estimate_savings","title":"get battery estimated savings","description":"Estimates annual solar+battery savings for a home. Month inputs use calendar month numbers 1-12.","href":"/api-reference/endpoint/homes/get-battery-estimated-savings"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/wattshift/c6b4919f908235e9/scripts/check-file-sizes.js","/_mintlify/custom/wattshift/4a8f98ad3ccbb3e6/scripts/check-secrets.js","/_mintlify/custom/wattshift/7960aa6c0521941b/scripts/generate-api-reference.js","/_mintlify/custom/wattshift/6f327f6f9fd98bdd/scripts/generate-docs.js","/_mintlify/custom/wattshift/d3c19d799274adf0/scripts/validate-docs.js","/_mintlify/custom/wattshift/8a5ff63acda4532f/scripts/verify-docs.js","/_mintlify/custom/wattshift/29f2d14fa9d732b6/tests/generate-api-reference.test.js","/_mintlify/custom/wattshift/32d6bf053395c4d5/tests/docs-contract.test.js","/_mintlify/custom/wattshift/ef23302a2da12414/scripts/openapi-examples.js","/_mintlify/custom/wattshift/e1cd97519d690a64/scripts/openapi-device-examples.js","/_mintlify/custom/wattshift/c123904c20df4b24/scripts/openapi-example-payloads.js","/_mintlify/custom/wattshift/78618a53f16f1ef2/scripts/openapi-home-examples.js","/_mintlify/custom/wattshift/365e28a382701a87/scripts/openapi-platform-examples.js","/_mintlify/custom/wattshift/88957da1b12beeb3/scripts/endpoint-page-supplements.js","/_mintlify/custom/wattshift/f590148926d9af9a/scripts/openapi-normalize.js"],"openApiReferenceData":{"operation":{"description":"Estimates annual solar+battery savings for a home. Month inputs use calendar month numbers 1-12.","operationId":"estimateBatterySavings","parameters":["2f309281-f0aa-4ff1-bb93-b839b7dc7d9c","1052ed93-72a6-4ca8-9d46-c06b91a94a8f"],"requestBody":"761a40e2-bb39-40fc-993e-1ed896eadfcb","responses":{"400":"daf90a95-f0a1-411e-a639-4997416bc212","401":"dd9c6254-f260-4085-b4fb-d76cbf259a02"},"security":["14dc755e-52f6-4cc5-ba12-66187bcab736","4dad2cca-e3e7-4012-892c-647ebc8967c7"],"summary":"get battery estimated savings","tags":["homes"],"method":"post","type":"path","servers":[],"path":"/v1/homes/{id}/battery/estimate_savings","baseUrlOptions":[],"title":"get battery estimated savings","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2f309281-f0aa-4ff1-bb93-b839b7dc7d9c":{"name":"x-ws-api-key","in":"header","description":"WattShift API Key","schema":{"type":"string","description":"WattShift API Key","uniqueKey":"","typeLabel":"string"}},"1052ed93-72a6-4ca8-9d46-c06b91a94a8f":{"name":"id","required":true,"in":"path","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"days":{"type":"number","isRequired":true,"uniqueKey":"days","typeLabel":"number"},"solarCapacity":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"solarCapacity.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"solarCapacity.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"solarCapacity","typeLabel":"number | null"},"maxCapacityKiloWattHours":{"type":"number","isRequired":true,"uniqueKey":"maxCapacityKiloWattHours","typeLabel":"number"},"chargingPowerKiloWatts":{"type":"number","isRequired":true,"uniqueKey":"chargingPowerKiloWatts","typeLabel":"number"},"dischargingPowerKiloWatts":{"type":"number","isRequired":true,"uniqueKey":"dischargingPowerKiloWatts","typeLabel":"number"},"chargingEfficiency":{"type":"number","isRequired":true,"uniqueKey":"chargingEfficiency","typeLabel":"number"},"dischargingEfficiency":{"type":"number","isRequired":true,"uniqueKey":"dischargingEfficiency","typeLabel":"number"},"currentSOC":{"type":"number","isRequired":true,"uniqueKey":"currentSOC","typeLabel":"number"},"minPreferredSOC":{"type":"number","isRequired":true,"uniqueKey":"minPreferredSOC","typeLabel":"number"},"maxPreferredSOC":{"type":"number","isRequired":true,"uniqueKey":"maxPreferredSOC","typeLabel":"number"},"dispatchHoursPerDay":{"oneOf":[{"type":"array","items":{"type":"array","items":{"type":"object","properties":{"hour":{"type":"number","isRequired":true,"uniqueKey":"dispatchHoursPerDay.oneOf.0.items.[INDEX].items.[INDEX].hour","typeLabel":"number"},"price":{"type":"number","isRequired":true,"uniqueKey":"dispatchHoursPerDay.oneOf.0.items.[INDEX].items.[INDEX].price","typeLabel":"number"}},"required":["hour","price"],"uniqueKey":"dispatchHoursPerDay.oneOf.0.items.[INDEX].items.[INDEX]","typeLabel":"object"},"uniqueKey":"dispatchHoursPerDay.oneOf.0.items.[INDEX]","typeLabel":"object[]"},"uniqueKey":"dispatchHoursPerDay.oneOf.0","typeLabel":"object[][]"},{"type":"null","items":{"type":"array","items":{"type":"object","properties":{"hour":{"type":"number"},"price":{"type":"number"}},"required":["hour","price"]}},"uniqueKey":"dispatchHoursPerDay.oneOf.1","typeLabel":"null"}],"uniqueKey":"dispatchHoursPerDay","typeLabel":"object[][] | null"},"numBiddingHours":{"oneOf":[{"type":"number","uniqueKey":"numBiddingHours.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"numBiddingHours.oneOf.1","typeLabel":"null"}],"uniqueKey":"numBiddingHours","typeLabel":"number | null"},"leap":{"oneOf":[{"type":"string","enum":["CAISO","NYISO"],"uniqueKey":"leap.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["CAISO","NYISO"],"uniqueKey":"leap.oneOf.1","typeLabel":"null"}],"uniqueKey":"leap","typeLabel":"enum\u003cstring> | null"},"months":{"oneOf":[{"description":"Optional calendar months to include, using 1-12 month numbers. Omit or pass null for all months.","type":"array","items":{"description":"Calendar month number, 1-12 where 1 = January and 12 = December.","type":"integer","minimum":1,"exclusiveMinimum":false,"maximum":12,"exclusiveMaximum":false,"uniqueKey":"months.oneOf.0.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"months.oneOf.0","typeLabel":"integer[]"},{"description":"Optional calendar months to include, using 1-12 month numbers. Omit or pass null for all months.","type":"null","items":{"description":"Calendar month number, 1-12 where 1 = January and 12 = December.","type":"integer","minimum":1,"exclusiveMinimum":false,"maximum":12,"exclusiveMaximum":false},"uniqueKey":"months.oneOf.1","typeLabel":"null"}],"uniqueKey":"months","typeLabel":"integer[] | null"}},"required":["days","solarCapacity","maxCapacityKiloWattHours","chargingPowerKiloWatts","dischargingPowerKiloWatts","chargingEfficiency","dischargingEfficiency","currentSOC","minPreferredSOC","maxPreferredSOC"],"uniqueKey":"","typeLabel":"object"},"example":{"days":1,"solarCapacity":5,"maxCapacityKiloWattHours":13.5,"chargingPowerKiloWatts":5,"dischargingPowerKiloWatts":5,"chargingEfficiency":0.95,"dischargingEfficiency":0.95,"currentSOC":0.5,"minPreferredSOC":0.2,"maxPreferredSOC":0.9,"months":[1,2,3,4,5,6,7,8,9,10,11,12]},"examples":{"Example":{"title":"Example","value":{"days":1,"solarCapacity":5,"maxCapacityKiloWattHours":13.5,"chargingPowerKiloWatts":5,"dischargingPowerKiloWatts":5,"chargingEfficiency":0.95,"dischargingEfficiency":0.95,"currentSOC":0.5,"minPreferredSOC":0.2,"maxPreferredSOC":0.9,"months":[1,2,3,4,5,6,7,8,9,10,11,12]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"daf90a95-f0a1-411e-a639-4997416bc212":{"description":"Validation failure","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string","example":"req_123","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"error_code":{"type":"string","enum":["AUTH_MISSING_API_KEY","AUTH_INVALID_API_KEY","AUTH_EXPIRED_CREDENTIAL","AUTH_REVOKED_CREDENTIAL","AUTH_INSUFFICIENT_SCOPE","VALIDATION_FAILED","RATE_LIMITED","NOT_FOUND","FORBIDDEN","PRODUCTION_ACCESS_DENIED","INTERNAL_ERROR"],"example":"VALIDATION_FAILED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"Request validation failed.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"recovery_action":{"type":"string","example":"Provide the x-ws-api-key header. If this contradicts the public docs, submit feedback through /v1/feedback.","uniqueKey":"recovery_action","typeLabel":"string"},"field_errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","example":"zipcode is invalid","isRequired":true,"uniqueKey":"field_errors.items.[INDEX].message","typeLabel":"string"},"field":{"type":"string","example":"zipcode","uniqueKey":"field_errors.items.[INDEX].field","typeLabel":"string"}},"required":["message"],"uniqueKey":"field_errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"field_errors","typeLabel":"object[]"},"retry_after_seconds":{"type":"number","example":3600,"uniqueKey":"retry_after_seconds","typeLabel":"number"}},"required":["request_id","error_code","message"],"uniqueKey":"","typeLabel":"object"},"example":{"request_id":"req_123","error_code":"VALIDATION_FAILED","message":"Request validation failed.","field_errors":[{"field":"zipcode","message":"zipcode is invalid"}]},"examples":{"Example":{"title":"Example","value":{"request_id":"req_123","error_code":"VALIDATION_FAILED","message":"Request validation failed.","field_errors":[{"field":"zipcode","message":"zipcode is invalid"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"dd9c6254-f260-4085-b4fb-d76cbf259a02":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string","example":"req_123","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"error_code":{"type":"string","enum":["AUTH_MISSING_API_KEY","AUTH_INVALID_API_KEY","AUTH_EXPIRED_CREDENTIAL","AUTH_REVOKED_CREDENTIAL","AUTH_INSUFFICIENT_SCOPE","VALIDATION_FAILED","RATE_LIMITED","NOT_FOUND","FORBIDDEN","PRODUCTION_ACCESS_DENIED","INTERNAL_ERROR"],"example":"VALIDATION_FAILED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"Request validation failed.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"recovery_action":{"type":"string","example":"Provide the x-ws-api-key header. If this contradicts the public docs, submit feedback through /v1/feedback.","uniqueKey":"recovery_action","typeLabel":"string"},"field_errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","example":"zipcode is invalid","isRequired":true,"uniqueKey":"field_errors.items.[INDEX].message","typeLabel":"string"},"field":{"type":"string","example":"zipcode","uniqueKey":"field_errors.items.[INDEX].field","typeLabel":"string"}},"required":["message"],"uniqueKey":"field_errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"field_errors","typeLabel":"object[]"},"retry_after_seconds":{"type":"number","example":3600,"uniqueKey":"retry_after_seconds","typeLabel":"number"}},"required":["request_id","error_code","message"],"uniqueKey":"","typeLabel":"object"},"example":{"request_id":"req_123","error_code":"AUTH_MISSING_API_KEY","message":"Missing x-ws-api-key header.","recovery_action":"Provide the x-ws-api-key header. If this contradicts the public docs or OpenAPI contract, submit structured feedback through /v1/feedback."},"examples":{"Example":{"title":"Example","value":{"request_id":"req_123","error_code":"AUTH_MISSING_API_KEY","message":"Missing x-ws-api-key header.","recovery_action":"Provide the x-ws-api-key header. If this contradicts the public docs or OpenAPI contract, submit structured feedback through /v1/feedback."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"14dc755e-52f6-4cc5-ba12-66187bcab736":{"x-ws-api-key":{"type":"apiKey","in":"header","name":"x-ws-api-key","description":"WattShift API key","scopes":[]}},"4dad2cca-e3e7-4012-892c-647ebc8967c7":{"x-ws-api-key":{"type":"apiKey","in":"header","name":"x-ws-api-key","description":"WattShift API key","scopes":[]}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-ws-api-key","description":"WattShift API key","scopes":[]},"schema":{"title":"x-ws-api-key","type":"string","description":"WattShift API key","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"x-ws-api-key","name":"x-ws-api-key"}],"title":"x-ws-api-key"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-ws-api-key","description":"WattShift API key","scopes":[]},"schema":{"title":"x-ws-api-key","type":"string","description":"WattShift API key","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"x-ws-api-key","name":"x-ws-api-key"}],"title":"x-ws-api-key"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"wattshift","siteName":"WattShift Documentation","title":"get battery estimated savings - WattShift Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-12T03:03:27.931Z","originalFileLocation":"api-reference/endpoint/homes/get-battery-estimated-savings.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Estimates annual solar+battery savings for a home. Month inputs use calendar month numbers 1-12.\">\u003cmeta data-mint-head name=\"application-name\" content=\"WattShift Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/wattshift/u7xZcUxaTpwLNaCF/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/wattshift/u7xZcUxaTpwLNaCF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/wattshift/u7xZcUxaTpwLNaCF/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/wattshift/u7xZcUxaTpwLNaCF/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/wattshift/u7xZcUxaTpwLNaCF/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/wattshift/u7xZcUxaTpwLNaCF/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/wattshift/u7xZcUxaTpwLNaCF/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/wattshift/u7xZcUxaTpwLNaCF/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/wattshift/u7xZcUxaTpwLNaCF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"get battery estimated savings - WattShift Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Estimates annual solar+battery savings for a home. Month inputs use calendar month numbers 1-12.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"WattShift Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.wattshift.com/api-reference/endpoint/homes/get-battery-estimated-savings\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://wattshift.mintlify.app/_mintlify/api/og/v2?division=homes\u0026amp;title=get+battery+estimated+savings\u0026amp;description=Estimates+annual+solar%2Bbattery+savings+for+a+home.+Month+inputs+use+calendar+month+numbers+1-12.\u0026amp;theme=552286c5fe032f4fa4b2b25d\u0026amp;signature=3050498b6bfff20a839a0a89f6f65b93cd5e2abafb96098801cdeaf5f2d1829d\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"get battery estimated savings - WattShift Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Estimates annual solar+battery savings for a home. Month inputs use calendar month numbers 1-12.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://wattshift.mintlify.app/_mintlify/api/og/v2?division=homes\u0026amp;title=get+battery+estimated+savings\u0026amp;description=Estimates+annual+solar%2Bbattery+savings+for+a+home.+Month+inputs+use+calendar+month+numbers+1-12.\u0026amp;theme=552286c5fe032f4fa4b2b25d\u0026amp;signature=3050498b6bfff20a839a0a89f6f65b93cd5e2abafb96098801cdeaf5f2d1829d\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/wattshift/u7xZcUxaTpwLNaCF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"WattShift Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.wattshift.com/api-reference/endpoint/homes/get-battery-estimated-savings\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/homes/get-battery-estimated-savings.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.wattshift.com/#organization\",\"name\":\"WattShift Documentation\",\"url\":\"https://docs.wattshift.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/wattshift/nRrIEJpPCWJRYPos/images/logo.png?fit=max\u0026auto=format\u0026n=nRrIEJpPCWJRYPos\u0026q=85\u0026s=4f036ac2553148e6902032822b918ff4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.wattshift.com#website\",\"name\":\"WattShift Documentation\",\"url\":\"https://docs.wattshift.com\",\"publisher\":{\"@id\":\"https://docs.wattshift.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.wattshift.com/api-reference/endpoint/homes/get-battery-estimated-savings#webpage\",\"url\":\"https://docs.wattshift.com/api-reference/endpoint/homes/get-battery-estimated-savings\",\"name\":\"get battery estimated savings\",\"description\":\"Estimates annual solar+battery savings for a home. Month inputs use calendar month numbers 1-12.\",\"dateModified\":\"2026-06-12T03:03:27.931Z\",\"isPartOf\":{\"@id\":\"https://docs.wattshift.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.wattshift.com/api-reference/endpoint/homes/get-battery-estimated-savings#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.wattshift.com/api-reference/endpoint/homes/get-battery-estimated-savings#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.wattshift.com/api-reference/endpoint/agent-credentials/request-a-sandbox-only-agent-credential\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"homes\",\"item\":\"https://docs.wattshift.com/api-reference/endpoint/homes/list-homes\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"get battery estimated savings\",\"item\":\"https://docs.wattshift.com/api-reference/endpoint/homes/get-battery-estimated-savings\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.wattshift.com/api-reference/endpoint/homes/get-battery-estimated-savings#apireference\",\"headline\":\"get battery estimated savings\",\"name\":\"get battery estimated savings\",\"description\":\"Estimates annual solar+battery savings for a home. Month inputs use calendar month numbers 1-12.\",\"url\":\"https://docs.wattshift.com/api-reference/endpoint/homes/get-battery-estimated-savings\",\"mainEntityOfPage\":{\"@id\":\"https://docs.wattshift.com/api-reference/endpoint/homes/get-battery-estimated-savings#webpage\"},\"dateModified\":\"2026-06-12T03:03:27.931Z\",\"publisher\":{\"@id\":\"https://docs.wattshift.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.wattshift.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"WattShift Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"WattShift Documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/docs/home/welcome"}]},{"tab":"API Reference","anchors":[{"anchor":"API Reference","icon":"terminal","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Endpoints","pages":[{"group":"agent-credentials","pages":[{"openapi":"api-reference/openapi.json POST /v1/agent-credentials","title":"Request a sandbox-only agent credential","href":"/api-reference/endpoint/agent-credentials/request-a-sandbox-only-agent-credential"},{"openapi":"api-reference/openapi.json POST /v1/agent-credentials/{credentialId}/revoke","title":"Revoke a sandbox agent credential","href":"/api-reference/endpoint/agent-credentials/revoke-a-sandbox-agent-credential"}]},{"group":"onboarding","pages":[{"openapi":"api-reference/openapi.json POST /v1/onboarding/url/generate","title":"generate onboarding url","href":"/api-reference/endpoint/onboarding/generate-onboarding-url"},{"openapi":"api-reference/openapi.json POST /v1/onboarding/session-token/generate","title":"generate session token","href":"/api-reference/endpoint/onboarding/generate-session-token"},{"openapi":"api-reference/openapi.json POST /v1/onboarding/status/get","title":"get onboarding status","href":"/api-reference/endpoint/onboarding/get-onboarding-status"},{"openapi":"api-reference/openapi.json POST /v1/onboarding/eligibility/check","title":"check eligibility for zipcode","href":"/api-reference/endpoint/onboarding/check-eligibility-for-zipcode"}]},{"group":"homes","pages":[{"openapi":"api-reference/openapi.json POST /v1/homes/list","title":"list homes","href":"/api-reference/endpoint/homes/list-homes"},{"openapi":"api-reference/openapi.json POST /v1/homes/{id}/get","title":"find home","href":"/api-reference/endpoint/homes/find-home"},{"openapi":"api-reference/openapi.json POST /v1/homes/{id}/remove","title":"remove home","href":"/api-reference/endpoint/homes/remove-home"},{"openapi":"api-reference/openapi.json POST /v1/homes/{id}/devices/hvac/list","title":"list home hvac devices","href":"/api-reference/endpoint/homes/list-home-hvac-devices"},{"openapi":"api-reference/openapi.json POST /v1/homes/{id}/price_signal","title":"get price signal","href":"/api-reference/endpoint/homes/get-price-signal"},{"openapi":"api-reference/openapi.json POST /v1/homes/{id}/price_signal/open_adr","title":"get price signal open adr","href":"/api-reference/endpoint/homes/get-price-signal-open-adr"},{"openapi":"api-reference/openapi.json POST /v1/homes/{id}/bill/monthly","title":"calculate monthly bill impact","href":"/api-reference/endpoint/homes/calculate-monthly-bill-impact"},{"openapi":"api-reference/openapi.json POST /v1/homes/bill/period/rateplan/{ratePlanId}","title":"calculate period bill using a specific rate plan","href":"/api-reference/endpoint/homes/calculate-period-bill-using-a-specific-rate-plan"},{"openapi":"api-reference/openapi.json POST /v1/homes/bill/period","title":"calculate period bill with inline home context","href":"/api-reference/endpoint/homes/calculate-period-bill-with-inline-home-context"},{"openapi":"api-reference/openapi.json POST /v1/homes/{id}/bill/period","title":"calculate period bill impact","href":"/api-reference/endpoint/homes/calculate-period-bill-impact"},{"openapi":"api-reference/openapi.json POST /v1/homes/{id}/calculate/impact","title":"calculate period bill impact","href":"/api-reference/endpoint/homes/calculate-period-bill-impact-1"},{"openapi":"api-reference/openapi.json POST /v1/homes/{id}/hvac/estimate_savings","title":"get HVAC estimated savings (monthly or annual)","description":null,"href":"/api-reference/endpoint/homes/get-hvac-estimated-savings-monthly-or-annual"},{"openapi":"api-reference/openapi.json POST /v1/homes/{id}/battery/estimate_savings","title":"get battery estimated savings","href":"/api-reference/endpoint/homes/get-battery-estimated-savings"},{"openapi":"api-reference/openapi.json POST /v1/homes/{id}/update","title":"update home","description":null,"href":"/api-reference/endpoint/homes/update-home"},{"openapi":"api-reference/openapi.json POST /v1/homes/create","title":"create home","href":"/api-reference/endpoint/homes/create-home"},{"openapi":"api-reference/openapi.json POST /v1/homes/solar/create","title":"create solar","href":"/api-reference/endpoint/homes/create-solar"},{"openapi":"api-reference/openapi.json POST /v1/homes/bill-upload","title":"[Beta] Onboard a site by uploading utility bill PDFs","href":"/api-reference/endpoint/homes/beta-onboard-a-site-by-uploading-utility-bill-pdfs"},{"openapi":"api-reference/openapi.json POST /v1/homes/bill-upload/{id}/status","title":"[Beta] Get bill upload processing status","href":"/api-reference/endpoint/homes/beta-get-bill-upload-processing-status"}]},{"group":"utility","pages":[{"openapi":"api-reference/openapi.json POST /v1/utility/get","title":"list utilities","href":"/api-reference/endpoint/utility/list-utilities"}]},{"group":"calculate","pages":[{"openapi":"api-reference/openapi.json POST /v1/calculate/impact/rateplan/{ratePlanId}","title":"calculate period bill using a specific rate plan","href":"/api-reference/endpoint/calculate/calculate-period-bill-using-a-specific-rate-plan"},{"openapi":"api-reference/openapi.json POST /v1/calculate/impact","title":"calculate period bill impact from inline context","href":"/api-reference/endpoint/calculate/calculate-period-bill-impact-from-inline-context"}]},{"group":"hvac","pages":[{"openapi":"api-reference/openapi.json POST /v1/devices/hvac/{id}/get","title":"find HVAC","href":"/api-reference/endpoint/hvac/find-hvac"},{"openapi":"api-reference/openapi.json POST /v1/devices/hvac/{id}/remove","title":"remove HVAC","href":"/api-reference/endpoint/hvac/remove-hvac"},{"openapi":"api-reference/openapi.json POST /v1/devices/hvac/{id}/unlink","title":"remove HVAC","href":"/api-reference/endpoint/hvac/remove-hvac-1"},{"openapi":"api-reference/openapi.json POST /v1/devices/hvac/{id}/today-url/generate","title":"url for today view","href":"/api-reference/endpoint/hvac/url-for-today-view"},{"openapi":"api-reference/openapi.json POST /v1/devices/hvac/thermostat_behavior/webhook/set","title":"set webhook thermostat behavior","href":"/api-reference/endpoint/hvac/set-webhook-thermostat-behavior"},{"openapi":"api-reference/openapi.json POST /v1/devices/hvac/{id}/thermostat_behavior/record","title":"record thermostat behavior","href":"/api-reference/endpoint/hvac/record-thermostat-behavior"},{"openapi":"api-reference/openapi.json POST /v1/devices/hvac/{id}/linked","title":"update HVAC","href":"/api-reference/endpoint/hvac/update-hvac"},{"openapi":"api-reference/openapi.json POST /v1/devices/hvac/{id}/user_preferences/set","title":"set user preference","href":"/api-reference/endpoint/hvac/set-user-preference"},{"openapi":"api-reference/openapi.json POST /v1/devices/hvac/{id}/user_preferences/get","title":"get user preference","href":"/api-reference/endpoint/hvac/get-user-preference"},{"openapi":"api-reference/openapi.json POST /v1/devices/hvac/{id}/preview","title":"preview","href":"/api-reference/endpoint/hvac/preview"},{"openapi":"api-reference/openapi.json POST /v1/devices/hvac/{id}/set_point_schedule/get","title":"get set point schedule","href":"/api-reference/endpoint/hvac/get-set-point-schedule"}]},{"group":"feedback","pages":[{"openapi":"api-reference/openapi.json POST /v1/feedback","title":"Submit structured feedback or a question","href":"/api-reference/endpoint/feedback/submit-structured-feedback-or-a-question"}]},{"group":"webhook","pages":[{"openapi":"api-reference/openapi.json POST /v1/webhook/set_point_schedule/set","title":"set webhook for optimized HVAC set-point schedules","href":"/api-reference/endpoint/webhook/set-webhook-for-optimized-hvac-set-point-schedules"},{"openapi":"api-reference/openapi.json POST /v1/webhook/set_point_schedule/trigger","title":"trigger set-point schedule webhook","href":"/api-reference/endpoint/webhook/trigger-set-point-schedule-webhook"},{"openapi":"api-reference/openapi.json POST /v1/webhook/price_signal/set","title":"Set or update the price signal webhook for the organization","href":"/api-reference/endpoint/webhook/set-or-update-the-price-signal-webhook-for-the-organization"},{"openapi":"api-reference/openapi.json POST /v1/webhook/price_signal/trigger","title":"trigger price signal webhook for organization homes","href":"/api-reference/endpoint/webhook/trigger-price-signal-webhook-for-organization-homes"}]},{"group":"agent-credentials","pages":[{"title":"Request a sandbox-only agent credential","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agent-credentials","href":"/api-reference/agent-credentials/request-a-sandbox-only-agent-credential"},{"title":"Revoke a sandbox agent credential","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agent-credentials/{credentialId}/revoke","href":"/api-reference/agent-credentials/revoke-a-sandbox-agent-credential"}]},{"group":"onboarding","pages":[{"title":"generate onboarding url","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/onboarding/url/generate","href":"/api-reference/onboarding/generate-onboarding-url"},{"title":"generate session token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/onboarding/session-token/generate","href":"/api-reference/onboarding/generate-session-token"},{"title":"get onboarding status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/onboarding/status/get","href":"/api-reference/onboarding/get-onboarding-status"},{"title":"check eligibility for zipcode","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/onboarding/eligibility/check","href":"/api-reference/onboarding/check-eligibility-for-zipcode"}]},{"group":"homes","pages":[{"title":"list homes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/list","href":"/api-reference/homes/list-homes"},{"title":"find home","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/get","href":"/api-reference/homes/find-home"},{"title":"remove home","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/remove","href":"/api-reference/homes/remove-home"},{"title":"list home hvac devices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/devices/hvac/list","href":"/api-reference/homes/list-home-hvac-devices"},{"title":"get price signal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/price_signal","href":"/api-reference/homes/get-price-signal"},{"title":"get price signal open adr","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/price_signal/open_adr","href":"/api-reference/homes/get-price-signal-open-adr"},{"title":"calculate monthly bill impact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/bill/monthly","href":"/api-reference/homes/calculate-monthly-bill-impact"},{"title":"calculate period bill using a specific rate plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/bill/period/rateplan/{ratePlanId}","href":"/api-reference/homes/calculate-period-bill-using-a-specific-rate-plan"},{"title":"calculate period bill with inline home context","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/bill/period","href":"/api-reference/homes/calculate-period-bill-with-inline-home-context"},{"title":"calculate period bill impact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/bill/period","href":"/api-reference/homes/calculate-period-bill-impact"},{"title":"calculate period bill impact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/calculate/impact","href":"/api-reference/homes/calculate-period-bill-impact-1"},{"title":"get HVAC estimated savings (monthly or annual)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/hvac/estimate_savings","href":"/api-reference/homes/get-hvac-estimated-savings-monthly-or-annual"},{"title":"get battery estimated savings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/battery/estimate_savings","href":"/api-reference/homes/get-battery-estimated-savings"},{"title":"update home","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/update","href":"/api-reference/homes/update-home"},{"title":"create home","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/create","href":"/api-reference/homes/create-home"},{"title":"create solar","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/solar/create","href":"/api-reference/homes/create-solar"},{"title":"[Beta] Onboard a site by uploading utility bill PDFs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/bill-upload","href":"/api-reference/homes/[beta]-onboard-a-site-by-uploading-utility-bill-pdfs"},{"title":"[Beta] Get bill upload processing status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/bill-upload/{id}/status","href":"/api-reference/homes/[beta]-get-bill-upload-processing-status"}]},{"group":"utility","pages":[{"title":"list utilities","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/utility/get","href":"/api-reference/utility/list-utilities"}]},{"group":"calculate","pages":[{"title":"calculate period bill using a specific rate plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/calculate/impact/rateplan/{ratePlanId}","href":"/api-reference/calculate/calculate-period-bill-using-a-specific-rate-plan"},{"title":"calculate period bill impact from inline context","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/calculate/impact","href":"/api-reference/calculate/calculate-period-bill-impact-from-inline-context"}]},{"group":"hvac","pages":[{"title":"find HVAC","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/{id}/get","href":"/api-reference/hvac/find-hvac"},{"title":"remove HVAC","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/{id}/remove","href":"/api-reference/hvac/remove-hvac"},{"title":"remove HVAC","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/{id}/unlink","href":"/api-reference/hvac/remove-hvac-1"},{"title":"url for today view","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/{id}/today-url/generate","href":"/api-reference/hvac/url-for-today-view"},{"title":"set webhook thermostat behavior","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/thermostat_behavior/webhook/set","href":"/api-reference/hvac/set-webhook-thermostat-behavior"},{"title":"record thermostat behavior","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/{id}/thermostat_behavior/record","href":"/api-reference/hvac/record-thermostat-behavior"},{"title":"update HVAC","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/{id}/linked","href":"/api-reference/hvac/update-hvac"},{"title":"set user preference","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/{id}/user_preferences/set","href":"/api-reference/hvac/set-user-preference"},{"title":"get user preference","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/{id}/user_preferences/get","href":"/api-reference/hvac/get-user-preference"},{"title":"preview","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/{id}/preview","href":"/api-reference/hvac/preview"},{"title":"get set point schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/{id}/set_point_schedule/get","href":"/api-reference/hvac/get-set-point-schedule"}]},{"group":"feedback","pages":[{"title":"Submit structured feedback or a question","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/feedback","href":"/api-reference/feedback/submit-structured-feedback-or-a-question"}]},{"group":"webhook","pages":[{"title":"set webhook for optimized HVAC set-point schedules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook/set_point_schedule/set","href":"/api-reference/webhook/set-webhook-for-optimized-hvac-set-point-schedules"},{"title":"trigger set-point schedule webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook/set_point_schedule/trigger","href":"/api-reference/webhook/trigger-set-point-schedule-webhook"},{"title":"Set or update the price signal webhook for the organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook/price_signal/set","href":"/api-reference/webhook/set-or-update-the-price-signal-webhook-for-the-organization"},{"title":"trigger price signal webhook for organization homes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook/price_signal/trigger","href":"/api-reference/webhook/trigger-price-signal-webhook-for-organization-homes"}]}]}]}],"groups":[{"group":"agent-credentials","pages":[{"title":"Request a sandbox-only agent credential","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agent-credentials","href":"/api-reference/agent-credentials/request-a-sandbox-only-agent-credential"},{"title":"Revoke a sandbox agent credential","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agent-credentials/{credentialId}/revoke","href":"/api-reference/agent-credentials/revoke-a-sandbox-agent-credential"}]},{"group":"onboarding","pages":[{"title":"generate onboarding url","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/onboarding/url/generate","href":"/api-reference/onboarding/generate-onboarding-url"},{"title":"generate session token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/onboarding/session-token/generate","href":"/api-reference/onboarding/generate-session-token"},{"title":"get onboarding status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/onboarding/status/get","href":"/api-reference/onboarding/get-onboarding-status"},{"title":"check eligibility for zipcode","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/onboarding/eligibility/check","href":"/api-reference/onboarding/check-eligibility-for-zipcode"}]},{"group":"homes","pages":[{"title":"list homes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/list","href":"/api-reference/homes/list-homes"},{"title":"find home","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/get","href":"/api-reference/homes/find-home"},{"title":"remove home","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/remove","href":"/api-reference/homes/remove-home"},{"title":"list home hvac devices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/devices/hvac/list","href":"/api-reference/homes/list-home-hvac-devices"},{"title":"get price signal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/price_signal","href":"/api-reference/homes/get-price-signal"},{"title":"get price signal open adr","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/price_signal/open_adr","href":"/api-reference/homes/get-price-signal-open-adr"},{"title":"calculate monthly bill impact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/bill/monthly","href":"/api-reference/homes/calculate-monthly-bill-impact"},{"title":"calculate period bill using a specific rate plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/bill/period/rateplan/{ratePlanId}","href":"/api-reference/homes/calculate-period-bill-using-a-specific-rate-plan"},{"title":"calculate period bill with inline home context","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/bill/period","href":"/api-reference/homes/calculate-period-bill-with-inline-home-context"},{"title":"calculate period bill impact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/bill/period","href":"/api-reference/homes/calculate-period-bill-impact"},{"title":"calculate period bill impact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/calculate/impact","href":"/api-reference/homes/calculate-period-bill-impact-1"},{"title":"get HVAC estimated savings (monthly or annual)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/hvac/estimate_savings","href":"/api-reference/homes/get-hvac-estimated-savings-monthly-or-annual"},{"title":"get battery estimated savings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/battery/estimate_savings","href":"/api-reference/homes/get-battery-estimated-savings"},{"title":"update home","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/{id}/update","href":"/api-reference/homes/update-home"},{"title":"create home","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/create","href":"/api-reference/homes/create-home"},{"title":"create solar","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/solar/create","href":"/api-reference/homes/create-solar"},{"title":"[Beta] Onboard a site by uploading utility bill PDFs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/bill-upload","href":"/api-reference/homes/[beta]-onboard-a-site-by-uploading-utility-bill-pdfs"},{"title":"[Beta] Get bill upload processing status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/homes/bill-upload/{id}/status","href":"/api-reference/homes/[beta]-get-bill-upload-processing-status"}]},{"group":"utility","pages":[{"title":"list utilities","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/utility/get","href":"/api-reference/utility/list-utilities"}]},{"group":"calculate","pages":[{"title":"calculate period bill using a specific rate plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/calculate/impact/rateplan/{ratePlanId}","href":"/api-reference/calculate/calculate-period-bill-using-a-specific-rate-plan"},{"title":"calculate period bill impact from inline context","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/calculate/impact","href":"/api-reference/calculate/calculate-period-bill-impact-from-inline-context"}]},{"group":"hvac","pages":[{"title":"find HVAC","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/{id}/get","href":"/api-reference/hvac/find-hvac"},{"title":"remove HVAC","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/{id}/remove","href":"/api-reference/hvac/remove-hvac"},{"title":"remove HVAC","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/{id}/unlink","href":"/api-reference/hvac/remove-hvac-1"},{"title":"url for today view","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/{id}/today-url/generate","href":"/api-reference/hvac/url-for-today-view"},{"title":"set webhook thermostat behavior","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/thermostat_behavior/webhook/set","href":"/api-reference/hvac/set-webhook-thermostat-behavior"},{"title":"record thermostat behavior","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/{id}/thermostat_behavior/record","href":"/api-reference/hvac/record-thermostat-behavior"},{"title":"update HVAC","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/{id}/linked","href":"/api-reference/hvac/update-hvac"},{"title":"set user preference","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/{id}/user_preferences/set","href":"/api-reference/hvac/set-user-preference"},{"title":"get user preference","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/{id}/user_preferences/get","href":"/api-reference/hvac/get-user-preference"},{"title":"preview","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/{id}/preview","href":"/api-reference/hvac/preview"},{"title":"get set point schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/devices/hvac/{id}/set_point_schedule/get","href":"/api-reference/hvac/get-set-point-schedule"}]},{"group":"feedback","pages":[{"title":"Submit structured feedback or a question","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/feedback","href":"/api-reference/feedback/submit-structured-feedback-or-a-question"}]},{"group":"webhook","pages":[{"title":"set webhook for optimized HVAC set-point schedules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook/set_point_schedule/set","href":"/api-reference/webhook/set-webhook-for-optimized-hvac-set-point-schedules"},{"title":"trigger set-point schedule webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook/set_point_schedule/trigger","href":"/api-reference/webhook/trigger-set-point-schedule-webhook"},{"title":"Set or update the price signal webhook for the organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook/price_signal/set","href":"/api-reference/webhook/set-or-update-the-price-signal-webhook-for-the-organization"},{"title":"trigger price signal webhook for organization homes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook/price_signal/trigger","href":"/api-reference/webhook/trigger-price-signal-webhook-for-organization-homes"}]}]}]},"basePath":"","title":"get battery estimated savings - WattShift Documentation","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}