# 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](https://github.com/rithvikvibhu/GHLocalApi) [](https://github.com/rithvikvibhu/
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: http://example.com/setup
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
# 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](https://github.com/rithvikvibhu/GHLocalApi) [](https://github.com/rithvikvibhu/GHLocalApi/stargazers) [![GitHub license](https://img.shields.io/github/license/rithvikvibhu/GHLocal
| method | path | what the vendor says it does |
|---|---|---|
GET | /NOTICE.html.gz | Legal Notice All licenses of programs used by Home. Static Files |
POST | /assistant/a11y_mode | Accessibility This controls Accessibility sounds. `hotword_enabled` is for 'Play start sound' and `endpoint_en |
GET | /assistant/alarms | Get Alarms and Timers This gives a list of all active alarms and timers. Both alarms and timers have `id`s wh |
POST | /assistant/alarms/delete | Delete Alarms and Timers This deletes alarms and timers by their id. `ids` is a list of ids to be deleted. Se |
POST | /assistant/alarms/volume | Alarm Volume This gets and sets alarms and timers volume. **Note:** This is not the same as normal volume. |
POST | /assistant/check_ready_status | Check Ready Status **Update:** This seems to have changed now and is no longer possible. The error is also new |
POST | /assistant/notifications | Do Not Disturb This is for the Do Not Disturb option. Sending an empty-body POST returns the current value. Se |
POST | /assistant/set_night_mode_params | Night Mode settings This sets night mode options. To view currently set values, use /setup/eureka_info. If |
POST | /bluetooth/bond | Forget paired device *See note for Bluetooth under `/setup/bluetooth/status`* **For both parts** This is to |
POST | /bluetooth/connect | Pair with Speaker *See note for Bluetooth under `/setup/bluetooth/status`* **For Part 2 only** This pairs wi |
POST | /bluetooth/discovery | Change Discoverability *See note for Bluetooth under `/setup/bluetooth/status`* **For Part 1 only** This ena |
GET | /bluetooth/get_bonded | Get Paired Devices *See note for Bluetooth under `/setup/bluetooth/status`* **For both parts** This gives a |
POST | /bluetooth/scan | Scan for devices *See note for Bluetooth under `/setup/bluetooth/status`* **For Part 2 only** This initiates |
GET | /bluetooth/scan_results | Get Scan Results *See note for Bluetooth under `/setup/bluetooth/status`* **For Part 2 only** This returns a |
GET | /bluetooth/status | Status > **There are 2 parts of Bluetooth.** > > *Part 1*: Devices like phones connect to Home and play audio |
GET | /configured_networks | Get Saved Networks This gets a list of all saved Wi-Fi networks. Each network has `ssid`, `wpa_auth`, `wpa_ci |
POST | /connect_wifi | Connect to Wi-Fi Network **Note:** Not sure how the password is encrypted. Might be using the public certifica |
GET | /eureka_info | Eureka Info This gives most of the device info. The GET parameter `param` is a comma separated list of json ke |
POST | /forget_wifi | Forget Wi-Fi Network This is to forget a saved network by `wpa_id`. Get the `wpa_id` from /setup/configured_ne |
POST | /get_app_device_id | App Device ID This gives "app device id", "certificate" and "signed data". The `app_id` in the request is ma |
GET | /icon.png | Chromecast Icon **Update:** This no longer exists. It's not useful, anyway. A redirect to `http://www.gstatic |
GET | /offer | Offer This gives a token which is used by the Home app to get offers. The offers themselves are not stored on |
POST | /reboot | Reboot and Factory Reset This can simply reboot the device (`params: "now"`) or factory reset the device (`par |
GET | /scan_results | Get Wi-Fi Scan Results This gets a list of all nearby Wi-Fi access points. The list only has the connected AP |
POST | /scan_wifi | Scan for Networks This initiates scanning for Wi-Fi networks. The results can be obtained with `/setup/scan_r |
POST | /set_eureka_info | Set Eureka Info This can set custom values to some options. Only fields to be modified need to be sent, not a |
GET | /supported_locales | Locales Simply returns a list of all supported locales. Device Info |
GET | /supported_timezones | Timezones Simply returns a list of all supported timezones. Device Info |
POST | /test_internet_download_speed | Test Internet Download Speed **Update:** This seems to have been removed. Returns 404 Not Found. This endpoin |
POST | /user_eq/set_equalizer | Set Equalizer Values This can only set new equalizer values. To get already set values, use /setup/eureka_info |
specification origin: https://raw.githubusercontent.com/rithvikvibhu/GHLocalApi/master/GoogleHome.openapi3.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.