Inofficial client for the Musixmatch API Development on https://codeberg.org/ThetaDev/musixmatch-inofficial
Find a file
ThetaDev 9faa2cd6b8
All checks were successful
CI / Test (push) Successful in 50s
Release / Release (push) Successful in 53s
chore(release): release musixmatch-inofficial v0.1.0
2024-03-23 02:48:48 +01:00
.gitea/workflows ci: add workflows 2024-03-23 02:43:18 +01:00
cli fix: move package attributes to workspace 2024-03-23 02:48:27 +01:00
src fix: improved response parsing and errors 2024-02-06 13:16:30 +01:00
testfiles feat: add subtitle translation 2022-10-07 12:19:50 +02:00
tests test: update tests 2024-03-23 02:33:31 +01:00
.editorconfig Initial commit 2022-09-30 23:39:07 +02:00
.env.example fix: testfile paths 2023-04-23 15:04:20 +02:00
.gitignore Initial commit 2022-09-30 23:39:07 +02:00
.pre-commit-config.yaml feat: add all request TLS options 2023-05-08 17:23:52 +02:00
Cargo.toml fix: move package attributes to workspace 2024-03-23 02:48:27 +01:00
CHANGELOG.md chore(release): release musixmatch-inofficial v0.1.0 2024-03-23 02:48:48 +01:00
cliff.toml chore: add git-cliff 2024-03-23 02:36:33 +01:00
Justfile chore: update dependencies 2024-03-23 02:35:46 +01:00
LICENSE Initial commit 2022-09-30 23:39:07 +02:00
README.md feat: allow usage without credentials 2024-02-03 17:20:24 +01:00

Musixmatch-Inofficial

This is an inofficial client for the Musixmatch API that uses the key embedded in the Musixmatch Android app.

It allows you to obtain synchronized lyrics in different formats (LRC, DFXP, JSON) for almost any song.

The Musixmatch API required a free account on https://www.musixmatch.com to be used. However, as of 2024, this requirement was removed and the API can be used anonymously. The client still allows you to supply credentials if Musixmatch decided to close the API down again.

Song lyrics are copyrighted works (just like books, poems and the songs themselves).

Musixmatch does allow its users to obtains song lyrics for private use (e.g. to enrich their music collection). But it does not allow you to publish their lyrics or use them commercially.

You will get in trouble if you use this client to create a public lyrics site/app. If you want to use Musixmatch data for this purpose, you will have to give them money (see their commercial plans) and use their official API.

Development info

The test suite reads Musixmatch credentials from the MUSIXMATCH_EMAIL and MUSIXMATCH_PASSWORD environment variables.

To make local development easier, I have included dotenvy to read the credentials from an .env file. Copy the .env.example file in the root directory, rename it to .env and fill in your credentials.