ListenBrainz
API Documentation
ListenBrainz API
Reference
Core
Playlists
Recordings
Statistics
Metadata
Social
Recommendations
Art
Miscellaneous
Rate limiting
Usage Examples
Prerequisites
Examples
Submitting Listens
Getting Listen History
Lookup MBIDs
Love/hate feedback
Latest Import
JSON Documentation
Submission JSON
Fetching listen JSON
Payload JSON details
Client Metadata examples
BrainzPlayer on the ListenBrainz website playing a video from YouTube
BrainzPlayer on the ListenBrainz website playing a video from Spotify
Using Otter for Funkwhale on android, and submitting with Simple Scrobbler
Rhythmbox player listening to Jamendo
Listening to a recording from Bandcamp and submitting with the browser extension WebScrobbler
Client Libraries
Haskell
Go
Rust
.NET
Python
Java
Last.FM Compatible API for ListenBrainz
AudioScrobbler API v1.2
Last.FM API
For development
For users
Data Dumps
Dump mirrors
File Descriptions
listenbrainz-public-dump.tar.xz
listenbrainz-listens-dump.tar.xz
listenbrainz-listens-dump-spark.tar.xz
Structure of the listens dump
Incremental dumps (BETA)
Developer Documentation
Server development
Set up ListenBrainz Server development environment
Clone listenbrainz-server
Install docker
Register a MusicBrainz application
Update config.py
Initialize ListenBrainz containers
Initialize ListenBrainz databases
Run the magic script
Listenbrainz containers
Test your changes with unit tests
Lint your code
Using develop.sh
Spark development
Set up the webserver
Create listenbrainz_spark/config.py
Initialize ListenBrainz Spark containers
Bring containers up
Import data into the spark environment
Working with request_consumer
Test your changes with unit tests
Architecture
Services
Listen Flow
Frontend Rendering
Spark Architecture
Developing request_consumer
Start the webserver
Start the spark containers
Start the spark reader
MBID Mapping
Database tables
Fuzzy lookups
MBID Mapper
Scripts
ListenBrainz
./develop.sh manage
Dump Manager
./develop.sh manage dump
ListenBrainz Spark
python spark_manage.py
./develop.sh manage spark
Maintainer Documentation
Production Deployment
Cron
Building Docker Images
Production Images
Test Images
Using Github Actions
Using docker/push.sh script
Data Dumps
Check FTP Dumps age script
Logs
Manually triggering dumps
MBID Mapping
Containers
Data sources
Debugging lookups
Debugging Spotify Reader
Updating Production Database Schema
Pull Requests Policy
ListenBrainz
»
Index
Edit on GitHub
Index
Symbols
|
A
|
D
|
L
|
M
|
P
|
R
|
W
Symbols
--alpha
./develop.sh-manage-spark-request_model command line option
--contribution
./develop.sh-manage-spark-request_similar_artists command line option
./develop.sh-manage-spark-request_similar_recordings command line option
--create-db
./develop.sh-manage-init_db command line option
./develop.sh-manage-init_ts_db command line option
--database
./develop.sh-manage-spark-request_fresh_releases command line option
./develop.sh-manage-spark-request_user_stats command line option
--days
./develop.sh-manage-spark-request_candidate_sets command line option
./develop.sh-manage-spark-request_dataframes command line option
./develop.sh-manage-spark-request_fresh_releases command line option
./develop.sh-manage-spark-request_missing_mb_data command line option
./develop.sh-manage-spark-request_similar_artists command line option
./develop.sh-manage-spark-request_similar_recordings command line option
--db
./develop.sh-manage-dump-create_full command line option
--debug
./develop.sh-manage-run_websockets command line option
--dump-id
./develop.sh-manage-dump-create_full command line option
./develop.sh-manage-dump-create_incremental command line option
--entity
./develop.sh-manage-spark-request_sitewide_stats command line option
./develop.sh-manage-spark-request_user_stats command line option
--force
./develop.sh-manage-init_db command line option
./develop.sh-manage-init_ts_db command line option
--host
./develop.sh-manage-run_websockets command line option
--html
./develop.sh-manage-spark-request_candidate_sets command line option
--id
./develop.sh-manage-spark-request_import_full command line option
./develop.sh-manage-spark-request_import_incremental command line option
--itr
./develop.sh-manage-spark-request_model command line option
--job-type
./develop.sh-manage-spark-request_dataframes command line option
--limit
./develop.sh-manage-spark-request_similar_artists command line option
./develop.sh-manage-spark-request_similar_recordings command line option
--listen
./develop.sh-manage-dump-create_full command line option
--listen-archive
./develop.sh-manage-dump-import_dump command line option
--listens-threshold
./develop.sh-manage-spark-request_dataframes command line option
--lmbda
./develop.sh-manage-spark-request_model command line option
--location
./develop.sh-manage-dump-create_feedback command line option
./develop.sh-manage-dump-create_full command line option
./develop.sh-manage-dump-create_incremental command line option
./develop.sh-manage-dump-create_mbcanonical command line option
--max-num-users
./develop.sh-manage-spark-request_similar_users command line option
--no-db
./develop.sh-manage-dump-create_full command line option
--no-listen
./develop.sh-manage-dump-create_full command line option
--no-spark
./develop.sh-manage-dump-create_full command line option
--no-stats
./develop.sh-manage-dump-create_full command line option
--no-timescale
./develop.sh-manage-dump-create_full command line option
--port
./develop.sh-manage-run_websockets command line option
--private-archive
./develop.sh-manage-dump-import_dump command line option
--private-timescale-archive
./develop.sh-manage-dump-import_dump command line option
--public-archive
./develop.sh-manage-dump-import_dump command line option
--public-timescale-archive
./develop.sh-manage-dump-import_dump command line option
--range
./develop.sh-manage-spark-request_sitewide_stats command line option
./develop.sh-manage-spark-request_user_stats command line option
--rank
./develop.sh-manage-spark-request_model command line option
--raw
./develop.sh-manage-spark-request_recommendations command line option
--session
./develop.sh-manage-spark-request_similar_artists command line option
./develop.sh-manage-spark-request_similar_recordings command line option
--similar
./develop.sh-manage-spark-request_candidate_sets command line option
./develop.sh-manage-spark-request_recommendations command line option
--skip
./develop.sh-manage-spark-request_similar_artists command line option
./develop.sh-manage-spark-request_similar_recordings command line option
--spark
./develop.sh-manage-dump-create_full command line option
--stats
./develop.sh-manage-dump-create_full command line option
--threads
./develop.sh-manage-dump-create_feedback command line option
./develop.sh-manage-dump-create_full command line option
./develop.sh-manage-dump-create_incremental command line option
./develop.sh-manage-dump-import_dump command line option
--threshold
./develop.sh-manage-spark-request_similar_artists command line option
./develop.sh-manage-spark-request_similar_recordings command line option
--timescale
./develop.sh-manage-dump-create_full command line option
--token
./develop.sh-manage-submit-release command line option
--top
./develop.sh-manage-spark-request_candidate_sets command line option
./develop.sh-manage-spark-request_recommendations command line option
--type
./develop.sh-manage-spark-request_sitewide_stats command line option
./develop.sh-manage-spark-request_user_stats command line option
--use-lb-conn
./develop.sh-manage-dump-create_mbcanonical command line option
--use-mb-conn
./develop.sh-manage-dump-create_mbcanonical command line option
--use-transformed-listencounts
./develop.sh-manage-spark-request_model command line option
--user
./develop.sh-manage-submit-release command line option
--user-name
./develop.sh-manage-spark-request_candidate_sets command line option
./develop.sh-manage-spark-request_recommendations command line option
--year
./develop.sh-manage-notify_yim_users command line option
./develop.sh-manage-spark-request_year_in_music command line option
./develop.sh-manage-spark-request_yim_artist_map command line option
./develop.sh-manage-spark-request_yim_day_of_week command line option
./develop.sh-manage-spark-request_yim_listen_count command line option
./develop.sh-manage-spark-request_yim_listening_time command line option
./develop.sh-manage-spark-request_yim_listens_per_day command line option
./develop.sh-manage-spark-request_yim_most_listened_year command line option
./develop.sh-manage-spark-request_yim_new_artists_discovered command line option
./develop.sh-manage-spark-request_yim_new_release_stats command line option
./develop.sh-manage-spark-request_yim_playlists command line option
./develop.sh-manage-spark-request_yim_similar_users command line option
./develop.sh-manage-spark-request_yim_top_stats command line option
-d
./develop.sh-manage-run_websockets command line option
-f
./develop.sh-manage-init_db command line option
./develop.sh-manage-init_ts_db command line option
-h
./develop.sh-manage-run_websockets command line option
-l
./develop.sh-manage-dump-create_feedback command line option
./develop.sh-manage-dump-create_full command line option
./develop.sh-manage-dump-create_incremental command line option
./develop.sh-manage-dump-create_mbcanonical command line option
./develop.sh-manage-dump-import_dump command line option
-p
./develop.sh-manage-run_websockets command line option
-pr
./develop.sh-manage-dump-import_dump command line option
-pu
./develop.sh-manage-dump-import_dump command line option
-t
./develop.sh-manage-dump-create_feedback command line option
./develop.sh-manage-dump-create_full command line option
./develop.sh-manage-dump-create_incremental command line option
./develop.sh-manage-dump-import_dump command line option
./develop.sh-manage-submit-release command line option
-u
./develop.sh-manage-submit-release command line option
./develop.sh-manage-dump-create_feedback command line option
--location
--threads
-l
-t
./develop.sh-manage-dump-create_full command line option
--db
--dump-id
--listen
--location
--no-db
--no-listen
--no-spark
--no-stats
--no-timescale
--spark
--stats
--threads
--timescale
-l
-t
./develop.sh-manage-dump-create_incremental command line option
--dump-id
--location
--threads
-l
-t
./develop.sh-manage-dump-create_mbcanonical command line option
--location
--use-lb-conn
--use-mb-conn
-l
./develop.sh-manage-dump-delete_old_dumps command line option
LOCATION
./develop.sh-manage-dump-import_dump command line option
--listen-archive
--private-archive
--private-timescale-archive
--public-archive
--public-timescale-archive
--threads
-l
-pr
-pu
-t
./develop.sh-manage-init_db command line option
--create-db
--force
-f
./develop.sh-manage-init_ts_db command line option
--create-db
--force
-f
./develop.sh-manage-notify_yim_users command line option
--year
./develop.sh-manage-run_websockets command line option
--debug
--host
--port
-d
-h
-p
./develop.sh-manage-set_rate_limits command line option
PER_IP_LIMIT
PER_TOKEN_LIMIT
WINDOW_SIZE
./develop.sh-manage-spark-request_candidate_sets command line option
--days
--html
--similar
--top
--user-name
./develop.sh-manage-spark-request_dataframes command line option
--days
--job-type
--listens-threshold
./develop.sh-manage-spark-request_fresh_releases command line option
--database
--days
./develop.sh-manage-spark-request_import_full command line option
--id
./develop.sh-manage-spark-request_import_incremental command line option
--id
./develop.sh-manage-spark-request_missing_mb_data command line option
--days
./develop.sh-manage-spark-request_model command line option
--alpha
--itr
--lmbda
--rank
--use-transformed-listencounts
./develop.sh-manage-spark-request_recommendations command line option
--raw
--similar
--top
--user-name
./develop.sh-manage-spark-request_similar_artists command line option
--contribution
--days
--limit
--session
--skip
--threshold
./develop.sh-manage-spark-request_similar_recordings command line option
--contribution
--days
--limit
--session
--skip
--threshold
./develop.sh-manage-spark-request_similar_users command line option
--max-num-users
./develop.sh-manage-spark-request_sitewide_stats command line option
--entity
--range
--type
./develop.sh-manage-spark-request_user_stats command line option
--database
--entity
--range
--type
./develop.sh-manage-spark-request_year_in_music command line option
--year
./develop.sh-manage-spark-request_yim_artist_map command line option
--year
./develop.sh-manage-spark-request_yim_day_of_week command line option
--year
./develop.sh-manage-spark-request_yim_listen_count command line option
--year
./develop.sh-manage-spark-request_yim_listening_time command line option
--year
./develop.sh-manage-spark-request_yim_listens_per_day command line option
--year
./develop.sh-manage-spark-request_yim_most_listened_year command line option
--year
./develop.sh-manage-spark-request_yim_new_artists_discovered command line option
--year
./develop.sh-manage-spark-request_yim_new_release_stats command line option
--year
./develop.sh-manage-spark-request_yim_playlists command line option
--year
./develop.sh-manage-spark-request_yim_similar_users command line option
--year
./develop.sh-manage-spark-request_yim_top_stats command line option
--year
./develop.sh-manage-submit-release command line option
--token
--user
-t
-u
RELEASEMBID
A
ALLOWED_STATISTICS_RANGE (in module data.model.common_stat)
,
[1]
D
DEFAULT_ITEMS_PER_GET (in module listenbrainz.webserver.views.api_tools)
L
LISTEN_MINIMUM_TS (in module listenbrainz.listenstore)
LOCATION
./develop.sh-manage-dump-delete_old_dumps command line option
M
MAX_DIMENSION (in module listenbrainz.art.cover_art_generator)
MAX_DURATION_LIMIT (in module listenbrainz.webserver.views.api_tools)
MAX_DURATION_MS_LIMIT (in module listenbrainz.webserver.views.api_tools)
MAX_IMAGE_SIZE (in module listenbrainz.art.cover_art_generator)
MAX_ITEMS_PER_GET (in module listenbrainz.webserver.views.api_tools)
MAX_LISTEN_PAYLOAD_SIZE (in module listenbrainz.webserver.views.api_tools)
MAX_LISTEN_SIZE (in module listenbrainz.webserver.views.api_tools)
MAX_LISTENS_PER_REQUEST (in module listenbrainz.webserver.views.api_tools)
MAX_TAG_SIZE (in module listenbrainz.webserver.views.api_tools)
MAX_TAGS_PER_LISTEN (in module listenbrainz.webserver.views.api_tools)
MIN_DIMENSION (in module listenbrainz.art.cover_art_generator)
MIN_IMAGE_SIZE (in module listenbrainz.art.cover_art_generator)
P
PER_IP_LIMIT
./develop.sh-manage-set_rate_limits command line option
PER_TOKEN_LIMIT
./develop.sh-manage-set_rate_limits command line option
R
RELEASEMBID
./develop.sh-manage-submit-release command line option
W
WINDOW_SIZE
./develop.sh-manage-set_rate_limits command line option
Read the Docs
v: latest
Versions
latest
stable
production
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds