Bose Unofficial API

Work in progress. This is not an official API, nor affiliated with Bose.

Development setup

poetry install
poetry run start

Usage

The following parameter are used in the application

IP Address of the Bose device
Username of the Bose App
Password of the Bose App
JWT Token (session token based on username+password)

Either use username and password or JWT token. Both can be provided which would be recommended. Not providing a JWT will result in a new login each time the application is started. Not providing the username/password will make the application stop working after the token expires (1 year).

Variables can be provided in 3 ways

Run parameters --ip, --user, --pass, --jwt
Environment variables BOSE_IP_ADDRESS, BOSE_USERNAME, BOSE_PASSWORD, BOSE_JWT_TOKEN
Through a .env file in the root of the project (see .env.example)

Use poetry run start to start the application.

Supported devices and functions

This API has been tested with the following devices and functions:

Bose Portable Home Speaker (codename: TAYLOR)
- get_system_info
- get_system_capabilities
- get_system_power_control
- set_system_power_control
- get_now_playing
- get_audio_volume
- ❌ get_audio_format
- ❌ get_remote
- ❌ get_audio_mode
- ❌ get_audio_surround
- get_wifi_status
Bose Soundbar 700 (codename: GINGER_CHEEVERS)
- get_system_info
- get_system_power_control
- set_system_power_control
- get_now_playing
- get_audio_volume
- get_audio_format
- get_remote
- get_audio_mode
- get_audio_surround
- get_wifi_status

This may work on the following devices (please report if working):

Bose NC 700 Headphones (codename: GOODYEAR)
Bose Home Speaker 500 (codename: EDDIE)
Bose Smart Soundbar 300 (codename: SAN_DIEGO)
Bose Smart Soundbar 500 (codename: PROFESSOR)
Bose Smart Soundbar 550 (codename: MALCOLM_CLUB)
Bose Smart Soundbar 600 (codename: MALCOLM)
Bose Smart Soundbar 900 (codename: ANGUS)
Bose Home Speaker 300 (codename: FLIPPER)
Bose Home Speaker 450 (codename: EDDIE_CLUB)
Bose L1 Pro (codename: FERRARI)
Bose L1 Pro (codename: LOTUS)
Bose L1 Pro (codename: MCLAREN)
Bose Zakim (codename: ZAKIM)

Workings

When connected to wifi, the devices will open a secured websocket port on 8082. (wss://<device_ip>:8082)

Endpoints