API archive entry · source-reported

Google Home

# Google Home Local API This is an unofficial documentation of the local API used by the Home app to communicate with GH devices. GitHub Repo ![GitHub stars](https://github.com/rithvikvibhu/GHLocalApi/stargazers) ![GitHub license](https://github.com/rithvikvibhu/GHLocalApi/blob/master/LICENSE.md) ## Getting Started Requests must be made over HTTPS, port 8443, so the base URL for these endpoints is: `https:// :8443/setup/` Get the IP of Google Home from the Google Home app (Device Settings -> End of the list) or from your router. GET requests are simple, in the browser kind. POST requests need to set the header (when there's a body): `content-type: application/json` ## Authentication Since June 2019, most requests (with exceptions like `/setup/eureka_info`) need a local authorization token. There are 3 kinds of tokens involved here: ### Local Authorization Token This token must be sent in all requests in the header `cast-local-authorization-token`. It is short-lived (~1 day) and may change unexpectedly (with a sync, change in homegraph, etc.) ##### Get this token - With access to an android device, get this token directly by either method. - Without a device, or to integrate it with

Provider / source website

Plan the first integration safely

The access fields below come from the connected directory. Their likely implementation impact is explained without assuming provider-specific behavior.

Authentication

OAuth is reported. Confirm flows, scopes, consent, token lifetime, and refresh rules.

Transport

HTTPS is not confirmed. Do not send credentials or production data until secure transport is verified.

Browser access

CORS is unknown. Treat direct browser access as unconfirmed and test before choosing a client-only architecture.

First-request sequence

  1. Identify the current base URL, version, and endpoint for the use case.
  2. Confirm how credentials are issued and where they may be stored.
  3. Test success, invalid input, throttling, unavailable data, and timeouts.
  4. Record response fields, pagination, caching, and error shapes.
  5. Add monitoring, retries with backoff, and an appropriate fallback.

Questions to resolve before production

Pricing and quotas

Confirm current plans, free-tier limits, overages, and request ceilings.

Endpoint coverage

Check that the operations and response fields match the intended workload.

Reliability

Look for uptime history, a status page, support routes, and service commitments.

Data and privacy

Review retention, licensing, regional processing, and compliance requirements.

Versioning

Confirm the active version, change policy, deprecation window, and migration guidance.

Developer experience

Validate SDKs, examples, error formats, pagination, and test environments.

Source reference

APIs.guru OpenAPI Directory

This page separates source-reported facts from questions that need live provider verification.