ListenBrainz Integration

ListenBrainz Integration

Display your currently playing music on your OshiSocial profile with ListenBrainz integration. This federated feature shows what you’re listening to in real-time.

What is ListenBrainz?

ListenBrainz is an open-source music listening tracker that integrates with OshiSocial (powered by Sharkey fediverse software) to display your “now playing” music on your profile. This creates a dynamic music tile that updates automatically as you listen.

Note

This feature is federated but requires compatible fediverse software to display properly on other instances.

Quick Setup Guide

Create Your ListenBrainz Account

Visit listenbrainz.org and click “Create Account”

Caution

Remember your username! You’ll need it to connect ListenBrainz to OshiSocial.

Connect to OshiSocial

Navigate to Settings → Profile on OshiSocial and place your username here.

Enter your ListenBrainz username from Step 1 in the designated field

Connect Your Music Service

Choose one of the integration methods below based on your preferred music platform

Music Service Integrations

Choose the integration method that matches how you listen to music:

Spotify

Spotify Integration (Recommended)

The easiest and most reliable integration for Spotify users.

Open Music Service Settings

Go to your ListenBrainz Music Service settings

Choose Integration Level

Select “Record listening history” for the best experience

Tip

This option provides the most complete integration with real-time updates

Start Playing Music

Begin playing music on Spotify. It may take a few songs before the tile appears on your profile.

Browser Extension

Web Scrobbler (Universal)

Works with YouTube, SoundCloud, Spotify Web, Apple Music Web, and more.

Caution

Always review browser extension permissions before installing. The Web Scrobbler is open-source and you can review its code on GitHub.

Install Web Scrobbler

Download from the Web Scrobbler GitHub page

Configure Extension

After installation, configure which music services to track

Authenticate ListenBrainz

When prompted, authenticate with your ListenBrainz account

Apple Music

Apple Music Integration

Requires an active Apple Music subscription.

Note

Apple Music integration requires re-authentication every 6 months due to Apple’s security policies.

Access Music Services

Visit your ListenBrainz Music Service settings

Connect Apple Music

Follow the Apple Music connection prompts

Grant Permissions

Authorize ListenBrainz to access your Apple Music listening data

Other Options

Alternative Integration Methods

ListenBrainz Native Player

Use the built-in player on ListenBrainz website. Interface differs from mainstream platforms but works without additional setup.

Developer API

Advanced users can integrate custom music sources using the ListenBrainz API documentation.

Caution

SoundCloud Integration: Currently broken as of August 2024. Check ListenBrainz updates for restoration status.

Troubleshooting

Music not showing on profile

• Verify your ListenBrainz username is correctly entered in OshiSocial settings
• Check that your music service is actively sending data to ListenBrainz
• Some tracks may take 2-3 songs to start displaying
• Ensure your profile visibility settings allow the music tile to show

Integration stopped working

• Re-authenticate your music service on ListenBrainz
• For Apple Music: Re-authentication required every 6 months
• Check if browser extensions need updating
• Verify ListenBrainz service status

Music tile not visible to others

The music tile feature requires compatible fediverse software. Users on instances running Sharkey, Misskey, or compatible forks will see your music. Mastodon and some other platforms may not display this feature.

Tips for Best Experience

Single Setup

In most cases, only one integration method is needed unless you use multiple music platforms regularly.

Privacy Consideration

Your listening history becomes public. Consider what you’re comfortable sharing before enabling.

Federation Limits

This feature works best within Sharkey/Misskey-compatible instances.

Performance

The music tile updates in near real-time without affecting your profile’s loading speed.

Platform Compatibility

Platform	Integration Method	Reliability
Spotify	Direct Integration	⭐⭐⭐⭐⭐ Excellent
YouTube	Web Scrobbler	⭐⭐⭐⭐ Very Good
Apple Music	Direct or Extension	⭐⭐⭐ Good (needs re-auth)
SoundCloud	Currently Broken	❌ Unavailable
Local Files	Developer API	⭐⭐ Requires setup

Note

This feature enhances your OshiSocial profile with dynamic music presence, making your profile more engaging and personal while connecting with others through shared musical interests.