Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rithvikvibhu/GHLocalApi

(Unofficial) Google Home local API documentation.
https://github.com/rithvikvibhu/GHLocalApi

api-documentation google-home iot openapi3 redoc

Last synced: about 1 hour ago
JSON representation

(Unofficial) Google Home local API documentation.

Awesome Lists containing this project

README

        

# [Google Home Local API Documentation](https://rithvikvibhu.github.io/GHLocalApi/)

**Updated on: 2020-06-28**

Available here: https://rithvikvibhu.github.io/GHLocalApi/

[![GitHub stars](https://img.shields.io/github/stars/rithvikvibhu/GHLocalApi)](https://github.com/rithvikvibhu/GHLocalApi/stargazers) [![GitHub license](https://img.shields.io/github/license/rithvikvibhu/GHLocalApi)](https://github.com/rithvikvibhu/GHLocalApi/blob/master/LICENSE.md) [![Build Status](https://travis-ci.org/rithvikvibhu/GHLocalApi.svg?branch=master)](https://travis-ci.org/rithvikvibhu/GHLocalApi)

Documentation for Google Home's local API, specs in [OpenAPI 3.0](https://swagger.io/specification/). Rendered with [Redoc](https://github.com/Redocly/redoc).

Travis CI generates the static website with Redoc.

- `npm run build` generates the static site in the 'dist' folder (Make sure the folder exists).
- `npm run serve` serves the page with a web server.

## Contributing

The Open API spec is exported from Apimatic. Instead of submitting pull requests with changes to this file, please create an issue with the changes instead.

## Credits

Huge thanks to

- [@Lohouse](https://github.com/Lohouse) for finding and posting an initial list of API endpoints [on Reddit r/googlehome](https://www.reddit.com/r/googlehome/comments/7qg6ef/use_the_api_on_your_google_home_to_view_things/)
- [@Leatherface75](https://github.com/Leatherface75), [@Drakulix](https://github.com/Drakulix), [@magicse](https://github.com/magicse), [@XoMEX](https://github.com/XoMEX), [@AngeloD2022](https://github.com/AngeloD2022) and everyone on [this issue](https://github.com/rithvikvibhu/GHLocalApi/issues/39) for helping RE the authentication system.
- [@simon-weber](https://github.com/simon-weber) for the [`gpsoauth`](https://github.com/simon-weber/gpsoauth) library
- All contributors who've reported inconsistencies and PR'd fixes