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

poetry install
poetry run start

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.

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)

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

The following functions are available (checked if implemented):

• /system/info (GET request, get_system_info())
• /system/capabilities (GET request, get_system_capabilities())
• /system/power/control (GET&POST request, get_system_power_control(), set_system_power_control(power: 'ON' | 'OFF'))
• /content/nowPlaying (GET, get_now_playing())
• /audio/volume (GET, get_audio_volume())
• /audio/format (GET, get_audio_format())
• /remote (GET, get_remote())
• /audio/mode (GET, get_audio_mode())
• /audio/surround (GET, get_audio_surround())
• /network/wifi/status (GET, get_wifi_status())
• /content/playbackRequest
• /homekit/info
• /cloudSync (Req type pq2)
• /audio/zone
• /content/transportControl (Req type pq2)
• /accessories
• /accessories/playTones
• /system/sources
• /system/sources/status
• /system/productSettings
• /clock
• /system/reset
• /bluetooth/sink/pairable
• /bluetooth/sink/status
• /system/update/status
• /system/update/start
• /bluetooth/sink/list
• /bluetooth/sink/connect
• /bluetooth/sink/disconnect
• /bluetooth/sink/connectionStatus
• /bluetooth/sink/remove
• /system/activated
• /system/challenge
• /system/setup
• /adaptiq
• /network/status
• /bluetooth/sink/macAddr
• /remote/integration
• /remote/integration/brandList
• /remote/integration/tvBrand
• /remote/integration/directEntry
• /voice/settings
• /voice/setup/start
• /cec
• /content/nowPlaying/shuffle
• /content/nowPlaying/repeat
• /content/nowPlaying/rating
• /content/nowPlaying/favorite
• /subscription
• /audio/dualMonoSelect
• /audio/avSync
• /audio/rebroadcastLatency/mode
• /audio/mountOrientation
• /audio/eqSelect
• /system/power/timeouts
• /system/power/macro
• /system/power/mode/opticalAutoWake
• /audio/bass
• /audio/height
• /audio/treble
• /audio/center
• /audio/subwooferGain
• /ui/lcd/brightness
• /system/battery
• /bluetooth/source/list
• /bluetooth/source/status
• /bluetooth/source/pair
• /bluetooth/source/pairStatus
• /bluetooth/source/connect
• /bluetooth/source/scan
• /bluetooth/source/scanResult
• /bluetooth/source/stopScan
• /bluetooth/source/connectionStatus
• /bluetooth/source/disconnect
• /bluetooth/source/remove
• /bluetooth/source/volume
• /ui/ttsPrompt/supportedLanguages
• /device/configuredDevices
• /device/configure
• /device/setup
• /device/assumed/TVs
• /device/assumed/sources
• /cast/setup
• /cast/settings
• /cast/teardown