How to Automate Spotify Listening Reports using the API

1import os
2import base64
3import json
4import requests
5from datetime import datetime
6from collections import Counter
7
8CLIENT_ID = os.environ['SPOTIFY_CLIENT_ID']
9CLIENT_SECRET = os.environ['SPOTIFY_CLIENT_SECRET']
10REFRESH_TOKEN = os.environ['SPOTIFY_REFRESH_TOKEN']
11OUTPUT_DIR = os.environ.get('REPORT_OUTPUT_DIR', '.')
12
13def get_token():
14    creds = base64.b64encode(f"{CLIENT_ID}:{CLIENT_SECRET}".encode()).decode()
15    r = requests.post('https://accounts.spotify.com/api/token',
16        headers={'Authorization': f'Basic {creds}'},
17        data={'grant_type': 'refresh_token', 'refresh_token': REFRESH_TOKEN})
18    r.raise_for_status()
19    return r.json()['access_token']
20
21def api_get(token, path, params=None):
22    r = requests.get(f'https://api.spotify.com/v1{path}',
23        headers={'Authorization': f'Bearer {token}'}, params=params)
24    if r.status_code == 429:
25        import time
26        time.sleep(int(r.headers.get('Retry-After', 5)))
27        return api_get(token, path, params)
28    r.raise_for_status()
29    return r.json()
30
31def main():
32    token = get_token()
33    time_ranges = ['short_term', 'medium_term', 'long_term']
34    labels = {'short_term': '~4 weeks', 'medium_term': '~6 months', 'long_term': 'all time'}
35
36    # Fetch top tracks and artists for all time ranges
37    top_tracks = {}
38    top_artists = {}
39    for tr in time_ranges:
40        top_tracks[tr] = api_get(token, '/me/top/tracks', {'time_range': tr, 'limit': 50})['items']
41        top_artists[tr] = api_get(token, '/me/top/artists', {'time_range': tr, 'limit': 50})['items']
42        print(f'{labels[tr]}: {len(top_tracks[tr])} tracks, {len(top_artists[tr])} artists')
43
44    # Fetch recently played
45    recent = api_get(token, '/me/player/recently-played', {'limit': 50})['items']
46    print(f'Recently played: {len(recent)} tracks')
47
48    # Aggregate genres from short-term artists
49    genre_counts = Counter()
50    for artist in top_artists['short_term']:
51        genre_counts.update(artist['genres'])
52
53    # Build report
54    report = {
55        'generated_at': datetime.now().isoformat(),
56        'period': datetime.now().strftime('%Y-%m'),
57        'top_tracks': {
58            tr: [{'rank': i+1, 'name': t['name'],
59                  'artist': ', '.join(a['name'] for a in t['artists']),
60                  'album': t['album']['name'],
61                  'popularity': t['popularity'],
62                  'url': t['external_urls']['spotify']}
63                 for i, t in enumerate(tracks[:20])]
64            for tr, tracks in top_tracks.items()
65        },
66        'top_artists_this_month': [
67            {'rank': i+1, 'name': a['name'],
68             'genres': a['genres'][:3],
69             'url': a['external_urls']['spotify']}
70            for i, a in enumerate(top_artists['short_term'][:20])
71        ],
72        'top_genres_this_month': dict(genre_counts.most_common(15)),
73        'recent_plays': [
74            {'track': item['track']['name'],
75             'artist': ', '.join(a['name'] for a in item['track']['artists']),
76             'played_at': item['played_at']}
77            for item in recent[:20]
78        ],
79        'stats': {
80            'total_recent_plays': len(recent),
81            'unique_recent_tracks': len({i['track']['id'] for i in recent})
82        },
83        'note': 'Audio features (tempo/energy/danceability/valence) unavailable for apps created after Nov 27, 2024'
84    }
85
86    # Save to file
87    filename = f'{OUTPUT_DIR}/listening_report_{report["period"]}.json'
88    with open(filename, 'w') as f:
89        json.dump(report, f, indent=2)
90    print(f'\nReport saved to {filename}')
91
92if __name__ == '__main__':
93    main()