Package selection guidance compiled from public package information, community data, and project usage.
A Dart library that provides partial integration with the Spotify Web API, enabling Flutter applications to interact with Spotify's music and audio services. While incomplete, it offers foundational functionality for accessing user data, playlists, tracks, and search features. Designed for developers building music-centric apps, it supports multiple platforms including Android, iOS, Web, macOS, Windows, and Linux. The library is actively maintained and open-source, allowing community contributions. It serves as a starting point for deeper Spotify integration in Flutter projects.
Use cases
Music app development
User playlist management
Track and artist search
Spotify authentication flow
Audio content discovery
Key features
Partial Spotify Web API support
Cross-platform compatibility
Open-source and community-driven
Authentication integration
Basic data retrieval for tracks and playlists
Suitable for
Flutter developers building music apps
Projects requiring Spotify data access
Cross-platform audio applications
Beginners exploring Spotify APIs
Considerations
Incomplete feature set
Requires manual handling of missing endpoints
Limited documentation
Dependent on external API changes
Not suitable for production without additional validation
Original README
Original README snapshot from the linked source repository. Visit the repository for the latest content.
spotify-dart
A Dart library for interfacing with the Spotify API.
Note: Related Artists, Audio Features, Audio Analysis, Featured Playlists, Category Playlists and Recommendation endpoints are deprecated by Spotify but still available in this library.
Quick Start
Simple Example (Client Credentials)
import'package:spotify/spotify.dart';
voidmain() async {
final credentials = SpotifyApiCredentials(clientId, clientSecret);
final spotify = SpotifyApi(credentials);
// Get artist infofinal artist = await spotify.artists.get('0OdUWJ0sBjDrqHygGUXeCF');
print(artist.name); // 'Band of Horses'// Search for tracksvar search = await spotify.search.get('metallica').first(2);
print(search.first.items); // List of albums, artists, tracks, etc.
}
Working with Pagination
Many endpoints return paginated results:
// Get all tracks from an albumvar tracks = await spotify.albums.getTracks(albumId).all();
// Get first N itemsvar featured = await spotify.playlists.featured.first(5);
// Stream through pagesawaitfor (var page in spotify.playlists.getUsersPlaylists(userId).stream()) {
print(page.items);
}
Authorization
This library supports multiple authorization flows:
Client Credentials Flow - For accessing public data (artists, albums, tracks, etc.)
Authorization Code Grant - For accessing user data and controlling playback
PKCE Support - Enhanced security for public clients
For detailed information on authorization flows, OAuth scopes, and advanced usage, see the wiki.
PKCE (Public Client) Authentication
For mobile apps and single-page applications that cannot securely store client secrets, use PKCE:
// Generate a secure code verifierfinal verifier = SpotifyApi.generateCodeVerifier();
// Create PKCE credentials (no client secret needed!)final credentials = SpotifyApiCredentials.pkce(
'your-client-id',
codeVerifier: verifier,
);
// Complete OAuth flowfinal grant = SpotifyApi.authorizationCodeGrant(credentials);
final authUri = grant.getAuthorizationUrl(redirectUri, scopes: scopes);
// ... redirect user, get authorization codefinal client = await grant.handleAuthorizationResponse(params);
final spotify = SpotifyApi.fromClient(client);
// Save credentials for later (including codeVerifier!)final creds = await spotify.getCredentials();
// Store creds.codeVerifier along with other credential fields// Restore laterfinal spotify = awaitSpotifyApi.asyncFromCredentials(restoredCreds);
See example/example_pkce.dart for a complete working example.
Features and bugs
Please file feature requests and bugs at the issue tracker.
Contributing
Contributions are welcome! Here's how to work on this project:
Run dart run build_runner build to generate serializers
Run dart run build_runner watch to continuously rebuild when files change
Code Quality
Before committing, ensure your code passes:
Formatting: dart format .
Analysis: dart analyze
Running Tests
Run the test suite:
dart test
Running Examples
To run the basic example:
dart run example/example.dart
You'll need to modify the file to include your Spotify client ID and secret.
For the authenticated example (accessing user data, playback control) run:
dart run example/example_auth.dart
This example will prompt you for a redirect URL and guide you through the OAuth flow to access features like currently playing tracks and available devices.