Franklin Whole Home

Franklin Whole Home (FranklinWH Energy Storage Inc.) builds whole-home energy management and storage hardware for residential solar: the aPower lithium iron phosphate AC battery, the aGate energy management and controller unit, and the FranklinWH mobile app, together forming an ecosystem that coordinates solar, battery, grid, generator and EV power sources for backup, self-consumption, time-of-use arbitrage and off-grid operation. Founded in 2019 and headquartered in the San Francisco Bay Area, the company designs and manufactures nearly all of its own components and sells through a certified installer and distributor channel. FranklinWH publishes a partner API - a unified developer access platform for authorised third-party owners, financiers, installers and service providers to read device and site data, monitor system performance, receive operational alerts and perform approved remote device control.

Franklin Whole Home publishes 12 APIs on the APIs.io network, including Authentication API, Device Data API, Devices API, and 9 more. Tagged areas include Company, Energy, Energy Storage, Home Energy Management, and Solar.

Franklin Whole Home’s developer surface includes API reference, engineering blog, support, documentation, signup flow, authentication, sandbox, and 19 more developer resources.

🌐 Visit website 📡 Source on GitHub

26.8/100 thin ▬ flat Agent 29/100 agent ready saas Full breakdown ↓
scored 2026-09-08 · rubric v0.20.0

1 APIs

Company Energy Energy StorageHome Energy ManagementSolar Batteries Internet of Things Smart Home Electric Vehicles CleantechDevice Telemetry

Kin Score

Kin Score How this is scored →
scored 2026-09-08 · rubric v0.20.0

Composite quality — 26.8/100 · thin

Contract Quality 2.7 / 19

Developer Ergonomics 5.6 / 15

Access Clarity 5.1 / 15

Operational Transparency 0.0 / 10

Contract Governance 0.4 / 9

Discoverability 5.1 / 8

Regulatory Posture 5.1 / 15

Create-or-Update Ergonomics 0.0 / 10

Agent readiness — 29/100 · agent ready

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 0 / 6

MCP Server 0 / 12

Machine-Readable Auth 10 / 10

Idempotency 0 / 9

Stable Error Semantics 8 / 8

Request/Response Examples 7 / 7

Rate-Limit Signaling 7 / 7

Typed Event Surface 0 / 6

Agent Skills 5 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 0 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 0 / 6

Agentic Commerce Well-Known Document 0 / 5

Regulatory Posture applies to this provider. Its tags matched the Energy & Utilities regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.

The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from github.com/api-evangelist/franklin-whole-home: open an issue to ask a question, or submit a pull request to add artifacts. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

APIs 12

Individual APIs this provider publishes, each with its own machine-readable definition.

Franklin Whole Home Authentication API

Token issuance for the FranklinWH partner API.

Franklin Whole Home Device Data API

Power, energy, telemetry, inventory and historical load data.

Franklin Whole Home Devices API

Device inventory, device information and device parameters.

Franklin Whole Home Grid Events API

Grid-event scheduling and query.

Franklin Whole Home Groups API

Device grouping and bulk settings applied by group.

Franklin Whole Home Modification Records API

Audit log of setting changes.

Franklin Whole Home Sites API

Site records — query, list, modify and delete.

Franklin Whole Home Sunrun API

Sunrun-specific operations on the /api-sunrun namespace.

Franklin Whole Home Sunrun Sites API

Sunrun site asset inventory.

Franklin Whole Home Sunrun System Setup API

Sunrun energy-management and aPower switch control.

Franklin Whole Home System Settings API

Time-of-use profiles, aPower switch control and smart-circuit settings.

Franklin Whole Home Warnings and Events API

Historical device warnings and backup (outage) events.

Scroll for all 12

Pricing Plans 1

Published pricing tiers and plan structures.

Franklin Whole Home Plans Pricing

0 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Franklin Whole Home Rate Limits

0 limits

RATE LIMITS

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Franklin Whole Home Authentication

apiKey · 1 scheme

SECURITY

Franklin Whole Home Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Franklin Whole Home Agentic Access

38 operations · 19 acting

AGENTIC

Resources

Get Started 3

Portal, sign-up, and the first successful call

DeveloperPortal

DeveloperPortal

SignUp

SignUp

Sandbox

Sandbox

Documentation 2

Reference material describing how the API behaves

APIReference

APIReference

Documentation

Documentation

Agent Surfaces 4

MCP servers, agent skills, and machine-readable catalogs

X-MCPServerCandidate

AgentSkill

LLMsTxt

AgenticAccess

Design & Contract 5

Pagination, idempotency, versioning, errors, and events

Conventions

ErrorCatalog

Lifecycle

Conformance

DataModel

Build 1

SDKs, sample code, and the tooling you integrate with

Packages

Packages

Access & Security 2

Authentication, authorization, and security posture

Authentication

Authentication

DomainSecurity

DomainSecurity

Operate 3

Status, limits, changes, and where to get help

Support

Support

HelpCenter

HelpCenter

RateLimits

RateLimits

Commercial 3

Pricing, plans, and the legal terms of use

TermsOfService

TermsOfService

PrivacyPolicy

PrivacyPolicy

Plans

Plans

Company 2

The organization behind the API

Website

Website

Blog

Blog

Other 1

Properties that don't map to a standard resource type

Overlay

Overlay

Source (apis.yml)

aid: franklin-whole-home
name: Franklin Whole Home
description: 'Franklin Whole Home (FranklinWH Energy Storage Inc.) builds whole-home energy management and storage hardware
  for residential solar: the aPower lithium iron phosphate AC battery, the aGate energy management and controller unit, and
  the FranklinWH mobile app, together forming an ecosystem that coordinates solar, battery, grid, generator and EV power sources
  for backup, self-consumption, time-of-use arbitrage and off-grid operation. Founded in 2019 and headquartered in the San
  Francisco Bay Area, the company designs and manufactures nearly all of its own components and sells through a certified
  installer and distributor channel. FranklinWH publishes a partner API - a unified developer access platform for authorised
  third-party owners, financiers, installers and service providers to read device and site data, monitor system performance,
  receive operational alerts and perform approved remote device control.'
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: true
  label: Hosted service · you call their endpoint
  confidence: high
  source:
  - openapi
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: unknown
  onboarding: unknown
  trial: false
  try_now: false
  public: false
  label: Unknown
  confidence: low
  source:
  - authentication
  - rate-limits
  - security
  - sandbox
  generated: '2026-09-03'
  method: derived
image: https://www.franklinwh.com/icoLogo1.png
url: https://raw.githubusercontent.com/api-evangelist/franklin-whole-home/refs/heads/main/apis.yml
x-type: company
x-source: harvest:secondary-market
x-tier: profiled
x-tier-reason: enrichment-pipeline
specificationVersion: '0.23'
created: '2026-08-16'
modified: '2026-08-16'
tags:
- Company
- Energy
- Energy Storage
- Home Energy Management
- Solar
- Batteries
- Internet of Things
- Smart Home
- Electric Vehicles
- Cleantech
- Device Telemetry
apis:
- aid: franklin-whole-home:franklin-whole-home-authentication-api
  name: Franklin Whole Home Authentication API
  description: Token issuance for the FranklinWH partner API.
  humanURL: https://api.franklinwh.com/
  baseURL: https://test-api.franklinwh.com
  tags:
  - Authentication
  properties:
  - type: OpenAPI
    url: openapi/franklin-whole-home-authentication-api-openapi.yml
  - type: Documentation
    url: https://api.franklinwh.com/
  - type: Announcement
    url: https://www.franklinwh.com/blog/introducing-the-franklinwh-api
- aid: franklin-whole-home:franklin-whole-home-device-data-api
  name: Franklin Whole Home Device Data API
  description: Power, energy, telemetry, inventory and historical load data.
  humanURL: https://api.franklinwh.com/
  baseURL: https://test-api.franklinwh.com
  tags:
  - Device Data
  properties:
  - type: OpenAPI
    url: openapi/franklin-whole-home-device-data-api-openapi.yml
  - type: Documentation
    url: https://api.franklinwh.com/
  - type: Announcement
    url: https://www.franklinwh.com/blog/introducing-the-franklinwh-api
- aid: franklin-whole-home:franklin-whole-home-devices-api
  name: Franklin Whole Home Devices API
  description: Device inventory, device information and device parameters.
  humanURL: https://api.franklinwh.com/
  baseURL: https://test-api.franklinwh.com
  tags:
  - Devices
  properties:
  - type: OpenAPI
    url: openapi/franklin-whole-home-devices-api-openapi.yml
  - type: Documentation
    url: https://api.franklinwh.com/
  - type: Announcement
    url: https://www.franklinwh.com/blog/introducing-the-franklinwh-api
- aid: franklin-whole-home:franklin-whole-home-grid-events-api
  name: Franklin Whole Home Grid Events API
  description: Grid-event scheduling and query.
  humanURL: https://api.franklinwh.com/
  baseURL: https://test-api.franklinwh.com
  tags:
  - Grid Events
  properties:
  - type: OpenAPI
    url: openapi/franklin-whole-home-grid-events-api-openapi.yml
  - type: Documentation
    url: https://api.franklinwh.com/
  - type: Announcement
    url: https://www.franklinwh.com/blog/introducing-the-franklinwh-api
- aid: franklin-whole-home:franklin-whole-home-groups-api
  name: Franklin Whole Home Groups API
  description: Device grouping and bulk settings applied by group.
  humanURL: https://api.franklinwh.com/
  baseURL: https://test-api.franklinwh.com
  tags:
  - Group
  tags_raw:
  - Groups
  properties:
  - type: OpenAPI
    url: openapi/franklin-whole-home-groups-api-openapi.yml
  - type: Documentation
    url: https://api.franklinwh.com/
  - type: Announcement
    url: https://www.franklinwh.com/blog/introducing-the-franklinwh-api
- aid: franklin-whole-home:franklin-whole-home-modification-records-api
  name: Franklin Whole Home Modification Records API
  description: Audit log of setting changes.
  humanURL: https://api.franklinwh.com/
  baseURL: https://test-api.franklinwh.com
  tags:
  - Modification Records
  properties:
  - type: OpenAPI
    url: openapi/franklin-whole-home-modification-records-api-openapi.yml
  - type: Documentation
    url: https://api.franklinwh.com/
  - type: Announcement
    url: https://www.franklinwh.com/blog/introducing-the-franklinwh-api
- aid: franklin-whole-home:franklin-whole-home-sites-api
  name: Franklin Whole Home Sites API
  description: Site records — query, list, modify and delete.
  humanURL: https://api.franklinwh.com/
  baseURL: https://test-api.franklinwh.com
  tags:
  - Sites
  properties:
  - type: OpenAPI
    url: openapi/franklin-whole-home-sites-api-openapi.yml
  - type: Documentation
    url: https://api.franklinwh.com/
  - type: Announcement
    url: https://www.franklinwh.com/blog/introducing-the-franklinwh-api
- aid: franklin-whole-home:franklin-whole-home-sunrun-api
  name: Franklin Whole Home Sunrun API
  description: Sunrun-specific operations on the /api-sunrun namespace.
  humanURL: https://api.franklinwh.com/
  baseURL: https://test-api.franklinwh.com
  tags:
  - Sunrun
  properties:
  - type: OpenAPI
    url: openapi/franklin-whole-home-sunrun-api-openapi.yml
  - type: Documentation
    url: https://api.franklinwh.com/
  - type: Announcement
    url: https://www.franklinwh.com/blog/introducing-the-franklinwh-api
- aid: franklin-whole-home:franklin-whole-home-sunrun-sites-api
  name: Franklin Whole Home Sunrun Sites API
  description: Sunrun site asset inventory.
  humanURL: https://api.franklinwh.com/
  baseURL: https://test-api.franklinwh.com
  tags:
  - Sunrun Sites
  properties:
  - type: OpenAPI
    url: openapi/franklin-whole-home-sunrun-sites-api-openapi.yml
  - type: Documentation
    url: https://api.franklinwh.com/
  - type: Announcement
    url: https://www.franklinwh.com/blog/introducing-the-franklinwh-api
- aid: franklin-whole-home:franklin-whole-home-sunrun-system-setup-api
  name: Franklin Whole Home Sunrun System Setup API
  description: Sunrun energy-management and aPower switch control.
  humanURL: https://api.franklinwh.com/
  baseURL: https://test-api.franklinwh.com
  tags:
  - Sunrun System Setup
  properties:
  - type: OpenAPI
    url: openapi/franklin-whole-home-sunrun-system-setup-api-openapi.yml
  - type: Documentation
    url: https://api.franklinwh.com/
  - type: Announcement
    url: https://www.franklinwh.com/blog/introducing-the-franklinwh-api
- aid: franklin-whole-home:franklin-whole-home-system-settings-api
  name: Franklin Whole Home System Settings API
  description: Time-of-use profiles, aPower switch control and smart-circuit settings.
  humanURL: https://api.franklinwh.com/
  baseURL: https://test-api.franklinwh.com
  tags:
  - System Settings
  properties:
  - type: OpenAPI
    url: openapi/franklin-whole-home-system-settings-api-openapi.yml
  - type: Documentation
    url: https://api.franklinwh.com/
  - type: Announcement
    url: https://www.franklinwh.com/blog/introducing-the-franklinwh-api
- aid: franklin-whole-home:franklin-whole-home-warnings-and-events-api
  name: Franklin Whole Home Warnings and Events API
  description: Historical device warnings and backup (outage) events.
  humanURL: https://api.franklinwh.com/
  baseURL: https://test-api.franklinwh.com
  tags:
  - Warnings and Events
  properties:
  - type: OpenAPI
    url: openapi/franklin-whole-home-warnings-and-events-api-openapi.yml
  - type: Documentation
    url: https://api.franklinwh.com/
  - type: Announcement
    url: https://www.franklinwh.com/blog/introducing-the-franklinwh-api
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
- FN: APIs.json
  email: info@apis.io
common:
- type: Overlay
  url: overlays/franklin-whole-home-openapi-overlay.yaml
- type: Website
  url: https://www.franklinwh.com/
- type: DeveloperPortal
  url: https://api.franklinwh.com/
- type: APIReference
  url: https://api.franklinwh.com/
- type: Blog
  url: https://www.franklinwh.com/blog/
- type: Support
  url: https://www.franklinwh.com/support/contact/
- type: HelpCenter
  url: https://www.franklinwh.com/support/articles/faq/
- type: Documentation
  url: https://www.franklinwh.com/support/documents/
- type: SignUp
  url: https://www.franklinwh.com/apply?role=installer
- type: TermsOfService
  url: https://www.franklinwh.com/terms-of-use/
- type: PrivacyPolicy
  url: https://www.franklinwh.com/policy/
- type: Authentication
  url: authentication/franklin-whole-home-authentication.yml
- type: Conventions
  url: conventions/franklin-whole-home-conventions.yml
- type: ErrorCatalog
  url: errors/franklin-whole-home-problem-types.yml
- type: Lifecycle
  url: lifecycle/franklin-whole-home-lifecycle.yml
- type: Conformance
  url: conformance/franklin-whole-home-conformance.yml
- type: DataModel
  url: data-model/franklin-whole-home-data-model.yml
- type: Sandbox
  url: sandbox/franklin-whole-home-sandbox.yml
- type: Packages
  url: packages/franklin-whole-home-packages.yml
- type: X-MCPServerCandidate
  url: mcp/franklin-whole-home-mcp.yml
  note: 'Renamed from MCPServer 2026-09-03 (roadmap#247): the manifest self-describes as status: candidate — a tool list derived
    from the published API contracts, not an existing server. The scorer already read the manifest and reported mcp_server
    correctly; the MCPServer type was crediting the artifact-type surfaces with a server that does not exist.'
- type: AgentSkill
  url: skills/_index.yml
- type: LLMsTxt
  url: llms/franklin-whole-home-llms.txt
- type: RateLimits
  url: rate-limits/franklin-whole-home-rate-limits.yml
- type: Plans
  url: plans/franklin-whole-home-plans-pricing.yml
- type: DomainSecurity
  url: security/franklin-whole-home-domain-security.yml
- type: AgenticAccess
  url: agentic-access/franklin-whole-home-agentic-access.yml
x-enrichment:
  date: '2026-08-16'
  status: enriched
  artifacts_added: 21
  pass: local-v1

Work with this as data

Every provider here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This provider

curl "https://apis.io/api/v1/providers/franklin-whole-home"

All providers

curl "https://apis.io/api/v1/providers?limit=25"

Every operation they expose

curl "https://apis.io/api/v1/providers/franklin-whole-home/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/franklin-whole-home/evidence"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.