Skip to content

Connect your player ​

Pear Desktop owns your playback and music queue. PearConnect uses the player's local API to search and add songs.

You can also use the separate PearConnect Player preview, with verified queue additions, appearance settings, web widgets and SponsorBlock controls.

Enable the API Server ​

Open Pear Desktop and enable its API Server plugin. Keep the server on localhost. PearConnect's default player address is:

text
http://127.0.0.1:26538

If your player uses another local port, open Connections → Pear Desktop, update Player API address, and select Save & reconnect.

Authorize PearConnect ​

  1. Keep Pear Desktop open.
  2. In PearConnect, select Authorize PearConnect from the setup guide or Connections.
  3. Approve the request in Pear Desktop.
  4. Wait for PearConnect to show Connected.

The desktop app saves the returned credential using the operating system's encryption facilities. You don't need to copy a bearer token from a terminal.

Client ID and bearer token are different ​

Client ID is a short name for the requesting application, such as ytmd-stream-bot. The player's authorization endpoint returns an accessToken after approval. That returned token belongs in an Authorization: Bearer … header for API requests; it does not belong in the Client ID field or in an /auth/… URL.

Use Authorize PearConnect for the supported setup. Do not paste credentials into shared bridge scripts, screenshots, issues or chat. A script that uses the same TikFinity commands alongside PearConnect can submit the same request twice, with separate cooldowns and counters. Run one request handler for that route.

Test the connection ​

Use Test player connection on Overview or Test player in Connections. This checks player reachability without changing playback.

An idle player can be connected without reporting a track. Connected means the player is reachable. From beta.4, Enqueue confirmed means a before/after queue check observed a new occurrence of the selected video ID. Neither alone proves audible playback. See accepted command, missing queue entry if an API call returns successfully but the song does not appear.

Connection states ​

StateWhat to do
Authorization neededEnable the API Server and authorize PearConnect.
Awaiting approvalCheck Pear Desktop for the authorization prompt.
Authorization expiredAuthorize again.
DisconnectedOpen the player and verify its API address and port.
ConnectedRun your safe test, then enable requests when ready.
Dry runPlayer calls are disabled for this session.

Changing the player address clears its saved credential. Authorize the new address before enabling requests.

Two different connections ​

The default player API port is 26538. PearConnect's Advanced webhook defaults to 7280. TikFinity's Simple event WebSocket defaults to 21213. These are separate services and aren't interchangeable.

For source-based authorization, see CLI & headless. If authorization keeps failing, follow Troubleshooting.

Independent community software · MIT licensed