MOBILE APP DEEPLINK
Using the mxmt.ch short links is the recommended approach to deeplink the content inside the app. The link will open the Musixmatch app directly to the lyrics page if the app is already installed and in case the app is not installed yet it goes to the Musixmatch website where the user can download the app
Musixmatch web pages contain applinks uri to open the same content inside the app.
Supported by
| iOS | YES |
| Android | YES |
| Windows Phone | YES |
| Windows Store | YES |
Examples
Samples of Musixmatch pages with applinks meta.
Requests
Lyrics page for for Somebody That I Used to Know
Album page for "Video Mirrors" by Gotye
Artist page for Gotye
LINK TO INSTALL THE APP
Link to install the app, both for mobile platforms (iOS,Android) and Desktop (Windows, Mac, Linux)
OPEN LYRICS BY TRACK ID
Opens a lyrics by track id
Resource Path
| /track_id | The id of the track to open |
Supported by
| iOS | YES |
| Android | YES |
| Windows Phone | YES |
| Windows Store | YES |
Examples
Show the lyrics for Somebody That I Used to Know
Requests
New protocol sample
Legacy protocol sample - Deprecated, not supported anymore
Resource ending with /
OPEN AN ARTIST
Opens the artist in the musixmatch app using the artist id or metadata for a song in his discography (to disambiguate artists with the same name)
Resource Path
| /artist_id | The id of the artist to open |
Parameters
| q_track | The song title. Can be omitted |
| q_artist | The song artist |
| q_album | The song album. Can be omitted |
Supported by
| iOS | NO |
| Android | NO |
| Windows Phone | NO |
| Windows Store | NO |
Examples
Show the artist Gotye within the app
Requests
New protocol sample, by artist id
Legacy protocol sample, by artist id (Deprecated, not supported anymore)
Legacy protocol sample, by artist id
mxm://artist?q_track=Somebody%20That%20I%20Used%20to%20Know&q_artist=Gotye
OPEN AN ALBUM
Opens the album in the musixmatch app using the album id
Resource Path
| /album_id | The id of the album to open |
Supported by
| iOS | NO |
| Android | NO |
| Windows Phone | NO |
| Windows Store | NO |
Examples
Show the album "Video Mirrors" by Gotye
Requests
New protocol sample, by album id
Legacy protocol sample, by album id (Deprecated, not supported anymore)
MATCH A SONG
Matches metadata with musiXmatch song, and displays the lyrics for singing along
Parameters
| q_track | The song title |
| q_artist | The song artist |
| q_album | The song album. Can be omitted |
| position | Seek to this position (seconds) |
| duration | Song duration in seconds. Improves matching |
| start_time | ISO 8601 with milliseconds (e.g. 2014-05-16T09:55:28.392Z ) datetime, of when the song was at position "position". Optional; only required if you want to synchronize the lyrics with a song being played on the same device |
Supported by
| iOS | YES |
| Android | YES |
| Windows Phone | YES. String & from parameters |
| Windows Store | YES |
Examples
Show the app player view, with lyrics in sync if a position and a duration si provided
Requests
Opens the lyrics for What"s Up by 4 Non Blondes
mxm://match/?q_track=what%27s%20up&q_artist=4 non blondesOpens the same song as above, starting the synchronized lyrics at second 60.5
mxm://match/?q_track=what%27s%20up&q_artist=4 non blondes&q_album=&position=60.5&duration=292Opens the same page as above, as it was at position 60.5, 0 seconds ago. The app will do the required position correction once opened.
Opens ""Blues for Jean Charles Menezez", as it was at position 77. The app will do the required position correction once opened.
OPEN A VIEW WITHIN THE APP
Main views of the app can be opened using a deep link
Resource Path
| /view_name | The name of the view to show. Home view and last view don't need a resource |
Supported by
| iOS | YES |
| Android | YES |
| Windows Phone | YES. String & from parameters |
| Windows Store | YES |
Examples
Opens the main view of the app
Requests
Opens the Store page (legacy protocol - deprecated)
Opens the Store page (new protocol)
Opens the player view (legacy protocol - deprecated)
Opens the player view (new protocol)
Opens the MusicID view (legacy protocol - deprecated)
Opens the MusicID view (new protocol)
Opens the home (legacy protocol - deprecated)
Opens the home (new protocol)
Just reopens the mxm app at the latest view (legacy protocol - deprecated)
Just reopens the mxm app at the latest view (new protocol)
Open the playlist view
mxm://view/playlist?user=[userid]&playlist=[playlistid]&source=[playersource]Opens the view of the user’s favorite lyrics
Opens the view of the user’s identified lyrics
TEXT SEARCH
Open the search view of the app with the specified search parameters
Parameters
| q | Search in lyrics text, title and artist name |
| q_track | The song title |
| q_artist | The song artist |
| q_lyrics | Search in the lyrics text |
Supported by
| iOS | YES |
| Android | YES |
| Windows Phone | YES. String & from parameters |
| Windows Store | YES |
Examples
Opens the search window searching with different search parameters
Requests
Searches "Saint Peter" within lyrics by "Coldplay" (new protocol)