{
"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 price signal
Returns a home-context price signal. Omit the body for the default home window, or provide both ISO 8601 startTime and endTime.
{
"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."
}
metadata for the export compensation source used to populate export prices
Show child attributes
{"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.3964","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":{},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/homes/get-price-signal","slug":"/api-reference/endpoint/homes/get-price-signal","pageMetadata":{"openapi":"api-reference/openapi.json POST /v1/homes/{id}/price_signal","title":"get price signal","description":"Returns a home-context price signal. Omit the body for the default home window, or provide both ISO 8601 startTime and endTime.","href":"/api-reference/endpoint/homes/get-price-signal"},"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: \"Returns a home-context price signal. Omit the body for the default home window, or provide both ISO 8601 startTime and endTime.\"\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}/price_signal","title":"get price signal","description":"Returns a home-context price signal. Omit the body for the default home window, or provide both ISO 8601 startTime and endTime.","href":"/api-reference/endpoint/homes/get-price-signal"}}},"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":"Returns a home-context price signal. Omit the body for the default home window, or provide both ISO 8601 startTime and endTime.","operationId":"getHomePriceSignal","parameters":["402a4e48-5659-49e5-a3c0-126390a80e6b","51afa271-4320-42e9-bc6d-ab4dea445227"],"requestBody":"4ce9d2fd-b3c4-497a-917b-002701d5a10a","responses":{"200":"5aba9145-55a2-42db-9be4-7b753a733caf","400":"045708bd-1ce2-4500-99e1-c4f50445a39f","401":"4f8b3c65-f3db-4d3f-8e1d-ac99dc842ee4"},"security":["8419d158-5c24-4e9e-b603-9259c8b8e0da","7fa28a5c-2191-4d6e-98cb-155b7c94f160"],"summary":"get price signal","tags":["homes"],"method":"post","type":"path","servers":[],"path":"/v1/homes/{id}/price_signal","baseUrlOptions":[],"title":"get price signal","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"402a4e48-5659-49e5-a3c0-126390a80e6b":{"name":"x-ws-api-key","in":"header","description":"WattShift API Key","schema":{"type":"string","description":"WattShift API Key","uniqueKey":"","typeLabel":"string"}},"51afa271-4320-42e9-bc6d-ab4dea445227":{"name":"id","required":true,"in":"path","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":false,"description":"Optional home-context signal window. If either startTime or endTime is provided, provide both.","content":{"application/json":{"schema":{"type":"object","properties":{"startTime":{"oneOf":[{"type":"string","uniqueKey":"startTime.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"startTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"startTime","typeLabel":"string | null"},"endTime":{"oneOf":[{"type":"string","uniqueKey":"endTime.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"endTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"endTime","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"startTime":"2025-02-25T16:13:37.902Z","endTime":"2025-02-26T16:13:37.902Z"},"examples":{"Example":{"title":"Example","value":{"startTime":"2025-02-25T16:13:37.902Z","endTime":"2025-02-26T16:13:37.902Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"5aba9145-55a2-42db-9be4-7b753a733caf":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"startTime":{"oneOf":[{"isRequired":true}],"isRequired":true,"uniqueKey":"startTime","typeLabel":"any"},"endTime":{"oneOf":[{"isRequired":true}],"isRequired":true,"uniqueKey":"endTime","typeLabel":"any"},"data":{"type":"array","items":{"type":"object","properties":{"startTime":{"oneOf":[{"isRequired":true}],"isRequired":true,"uniqueKey":"data.items.[INDEX].startTime","typeLabel":"any"},"endTime":{"oneOf":[{"isRequired":true}],"isRequired":true,"uniqueKey":"data.items.[INDEX].endTime","typeLabel":"any"},"price":{"type":"number","isRequired":true,"uniqueKey":"data.items.[INDEX].price","typeLabel":"number"},"import":{"type":"number","isRequired":true,"uniqueKey":"data.items.[INDEX].import","typeLabel":"number"},"export":{"type":"number","isRequired":true,"uniqueKey":"data.items.[INDEX].export","typeLabel":"number"},"confidence":{"type":"number","isRequired":true,"uniqueKey":"data.items.[INDEX].confidence","typeLabel":"number"}},"required":["startTime","endTime","price","import","export","confidence"],"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data","typeLabel":"object[]"},"prices":{"description":"expected price in $/kWh in 15min intervals","type":"array","items":{"type":"number","uniqueKey":"prices.items.[INDEX]","typeLabel":"number"},"isRequired":true,"uniqueKey":"prices","typeLabel":"number[]"},"export":{"description":"export rate in $/kWh in 15min intervals","type":"array","items":{"type":"number","uniqueKey":"export.items.[INDEX]","typeLabel":"number"},"isRequired":true,"uniqueKey":"export","typeLabel":"number[]"},"import":{"description":"import rate in $/kWh in 15min intervals","type":"array","items":{"type":"number","uniqueKey":"import.items.[INDEX]","typeLabel":"number"},"isRequired":true,"uniqueKey":"import","typeLabel":"number[]"},"homeId":{"type":"string","isRequired":true,"uniqueKey":"homeId","typeLabel":"string"},"exportCompensation":{"description":"metadata for the export compensation source used to populate export prices","type":"object","properties":{"dataset":{"type":"string","isRequired":true,"uniqueKey":"exportCompensation.dataset","typeLabel":"string"},"resolver":{"type":"string","isRequired":true,"uniqueKey":"exportCompensation.resolver","typeLabel":"string"},"status":{"type":"string","isRequired":true,"uniqueKey":"exportCompensation.status","typeLabel":"string"},"mode":{"type":"string","uniqueKey":"exportCompensation.mode","typeLabel":"string"},"profileId":{"type":"string","uniqueKey":"exportCompensation.profileId","typeLabel":"string"},"profileVersion":{"type":"string","uniqueKey":"exportCompensation.profileVersion","typeLabel":"string"},"profileIds":{"type":"array","items":{"type":"string","uniqueKey":"exportCompensation.profileIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"exportCompensation.profileIds","typeLabel":"string[]"},"profileVersions":{"type":"array","items":{"type":"string","uniqueKey":"exportCompensation.profileVersions.items.[INDEX]","typeLabel":"string"},"uniqueKey":"exportCompensation.profileVersions","typeLabel":"string[]"},"baseUtility":{"type":"string","uniqueKey":"exportCompensation.baseUtility","typeLabel":"string"},"vintage":{"type":"string","uniqueKey":"exportCompensation.vintage","typeLabel":"string"},"customerClass":{"type":"string","uniqueKey":"exportCompensation.customerClass","typeLabel":"string"},"sourceCoverage":{"type":"string","uniqueKey":"exportCompensation.sourceCoverage","typeLabel":"string"},"intervalCount":{"type":"number","uniqueKey":"exportCompensation.intervalCount","typeLabel":"number"},"missingIntervalCount":{"type":"number","uniqueKey":"exportCompensation.missingIntervalCount","typeLabel":"number"},"warnings":{"type":"array","items":{"type":"string","uniqueKey":"exportCompensation.warnings.items.[INDEX]","typeLabel":"string"},"uniqueKey":"exportCompensation.warnings","typeLabel":"string[]"}},"required":["dataset","resolver","status"],"uniqueKey":"exportCompensation","typeLabel":"object"}},"required":["startTime","endTime","data","prices","export","import","homeId"],"uniqueKey":"","typeLabel":"object"},"example":{"homeId":"ws_home_123456789","startTime":"2025-02-25T16:13:37.902Z","endTime":"2025-02-26T16:13:37.902Z","data":[{"startTime":"2025-02-25T16:13:37.902Z","endTime":"2025-02-26T01:13:37.902Z","price":0.42625,"import":0.42625,"export":0,"confidence":0.95},{"startTime":"2025-02-26T01:13:37.902Z","endTime":"2025-02-26T04:13:37.902Z","price":0.46486,"import":0.46486,"export":0,"confidence":0.95},{"startTime":"2025-02-26T04:13:37.902Z","endTime":"2025-02-26T16:13:37.902Z","price":0.42625,"import":0.42625,"export":0,"confidence":0.95}],"prices":[0.42625,0.46486,0.42625],"export":[0,0,0],"import":[0.42625,0.46486,0.42625]},"examples":{"Example":{"title":"Example","value":{"homeId":"ws_home_123456789","startTime":"2025-02-25T16:13:37.902Z","endTime":"2025-02-26T16:13:37.902Z","data":[{"startTime":"2025-02-25T16:13:37.902Z","endTime":"2025-02-26T01:13:37.902Z","price":0.42625,"import":0.42625,"export":0,"confidence":0.95},{"startTime":"2025-02-26T01:13:37.902Z","endTime":"2025-02-26T04:13:37.902Z","price":0.46486,"import":0.46486,"export":0,"confidence":0.95},{"startTime":"2025-02-26T04:13:37.902Z","endTime":"2025-02-26T16:13:37.902Z","price":0.42625,"import":0.42625,"export":0,"confidence":0.95}],"prices":[0.42625,0.46486,0.42625],"export":[0,0,0],"import":[0.42625,0.46486,0.42625]}}},"exampleType":"examples"}},"exampleType":"examples"},"045708bd-1ce2-4500-99e1-c4f50445a39f":{"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"},"4f8b3c65-f3db-4d3f-8e1d-ac99dc842ee4":{"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":{"8419d158-5c24-4e9e-b603-9259c8b8e0da":{"x-ws-api-key":{"type":"apiKey","in":"header","name":"x-ws-api-key","description":"WattShift API key","scopes":[]}},"7fa28a5c-2191-4d6e-98cb-155b7c94f160":{"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 price signal - WattShift Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-12T03:03:27.933Z","originalFileLocation":"api-reference/endpoint/homes/get-price-signal.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=\"Returns a home-context price signal. Omit the body for the default home window, or provide both ISO 8601 startTime and endTime.\">\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 price signal - WattShift Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a home-context price signal. Omit the body for the default home window, or provide both ISO 8601 startTime and endTime.\">\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-price-signal\">\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+price+signal\u0026amp;description=Returns+a+home-context+price+signal.+Omit+the+body+for+the+default+home+window%2C+or+provide+both+ISO+8601+startTime+and+endTime.\u0026amp;theme=552286c5fe032f4fa4b2b25d\u0026amp;signature=6d653d61e09ea8757f67ab920b8dc4f32ddecf52f0e9be7dc0ed7e52a02804c1\">\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 price signal - WattShift Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a home-context price signal. Omit the body for the default home window, or provide both ISO 8601 startTime and endTime.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://wattshift.mintlify.app/_mintlify/api/og/v2?division=homes\u0026amp;title=get+price+signal\u0026amp;description=Returns+a+home-context+price+signal.+Omit+the+body+for+the+default+home+window%2C+or+provide+both+ISO+8601+startTime+and+endTime.\u0026amp;theme=552286c5fe032f4fa4b2b25d\u0026amp;signature=6d653d61e09ea8757f67ab920b8dc4f32ddecf52f0e9be7dc0ed7e52a02804c1\">\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-price-signal\">\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-price-signal.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-price-signal#webpage\",\"url\":\"https://docs.wattshift.com/api-reference/endpoint/homes/get-price-signal\",\"name\":\"get price signal\",\"description\":\"Returns a home-context price signal. Omit the body for the default home window, or provide both ISO 8601 startTime and endTime.\",\"dateModified\":\"2026-06-12T03:03:27.933Z\",\"isPartOf\":{\"@id\":\"https://docs.wattshift.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.wattshift.com/api-reference/endpoint/homes/get-price-signal#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.wattshift.com/api-reference/endpoint/homes/get-price-signal#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 price signal\",\"item\":\"https://docs.wattshift.com/api-reference/endpoint/homes/get-price-signal\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.wattshift.com/api-reference/endpoint/homes/get-price-signal#apireference\",\"headline\":\"get price signal\",\"name\":\"get price signal\",\"description\":\"Returns a home-context price signal. Omit the body for the default home window, or provide both ISO 8601 startTime and endTime.\",\"url\":\"https://docs.wattshift.com/api-reference/endpoint/homes/get-price-signal\",\"mainEntityOfPage\":{\"@id\":\"https://docs.wattshift.com/api-reference/endpoint/homes/get-price-signal#webpage\"},\"dateModified\":\"2026-06-12T03:03:27.933Z\",\"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","description":null,"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","description":null,"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)","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","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"}]}]}]},"title":"get price signal - WattShift Documentation","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}