{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Home Batteries","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"home-batteries","__idx":0},"children":["Home Batteries"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Home Battery product consists of the following APIs:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Home Battery Make ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/home_battery_makes"]},": list and retrieve manufacturers we support."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Home Battery Model ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/home_battery_models"]},": list and retrieve models, optionally filtered by make."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Home Battery Onboarding ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/home_battery_onboarding"]},": kick off the OAuth flow that connects a user's home battery account to ev.energy."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The typical flow for connecting a user's home battery is:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/home_battery_makes"]}," endpoint to discover supported manufacturers.",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Each make exposes an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onboarding_url"]}," when a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["preferred_integration_provider"]}," is configured. Use this URL to send the user straight into the onboarding flow primed to that make."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Makes whose ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["preferred_integration_provider"]}," is null cannot be onboarded automatically and return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onboarding_url: null"]},"."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Optionally use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/home_battery_models"]}," endpoint with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?make_id=..."]}," to look up a specific model.",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Each model also exposes an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onboarding_url"]}," for finer-grained priming via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["model_id"]},"."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Direct the user to the resolved ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onboarding_url"]},".",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["When using Client Credentials, append a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["user_id=..."]}," query parameter so the home battery is created for the correct user — otherwise the request returns a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},"."]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once onboarding completes successfully the user's connected home battery becomes visible to the rest of the ev.energy platform and is taken into account during smart charging."]}]},"headings":[{"value":"Home Batteries","id":"home-batteries","depth":1}],"frontmatter":{"title":"Home Batteries","seo":{"title":"Home Batteries"}},"lastModified":"2026-05-07T09:06:19.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/home_batteries","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}