Lightweight and working API for fetching synchronized lyrics, powered by QQ Music.
# Search for a song
queries = CreQQ().search('BLUE Billie Eilish')
# Get the metadata of the first song
metadata = queries[0].get_metadata()
# Print the 2nd line of the lyrics
print(metadata.lyrics[1].raw)
# Output:
# [00:11.26]I try to live in black and white but I'm so blueDownload the file creqq.py and import it.
from creqq import CreQQNote
This library uses the dependency requests.
GET https://creqq-api.vercel.app/<SEARCH-QUERY>/<SEARCH-INDEX>Search Query
This is the search query for searching the song lyrics. It is recommended to also include the artist name for precise result.h
Search Index
When searching, it can return a bunch of songs. Search index is used to select which song to return. It is zero by default and can be undefined.
offset is the offset start of the lyrics by seconds. If the offset is 2 seconds, then you need to manually adjust the lyrics.
total is the total amount of songs that has been retrieved when searching.
index is the number of which song index is returned. It is basically search index but with +1.
timestamp is the milliseconds timestamp of a lyric line.
GET https://creqq-api.vercel.app/i%20can%20see%20you%20taylor
{
"title": "I Can See You (Taylor's Version|From The Vault)",
"artist": "Taylor Swift",
"offset": 0,
"total": 10,
"index": 0,
"lyrics": [{
"timestamp": 16470,
"text": "You brush past me in the hallway"
}, "..."],
"success": true
}INCOMPLETE_PARAM occurs if no parameter is provided.
GET https://creqq-api.vercel.app/
{
"error": "INCOMPLETE_PARAM"
"success": false
}INVALID_PARAM occurs if the search index is not a valid number.
GET https://creqq-api.vercel.app/i%20can%20see%20you%20taylor/not-a-number
{
"error": "INVALID_PARAM"
"success": false
}NOT_FOUND occurs when either the search query doesn't return a single song, or the index is out of bounds.
GET https://creqq-api.vercel.app/gajsjsjauwhsja
{
"error": "NOT_FOUND"
"success": false
}NO_METADATA_FOUND occurs when a song exists but doesn't have a lyrics.
Note
The metadata includes all the data including the title and the artist.
GET https://creqq-api.vercel.app/i%20can%20see%20you%20taylor/3
{
"error": "NO_METADATA_FOUND"
"success": false
}INTERNAL_ERROR occurs when the process raised an error.
{
"error": "INTERNAL_ERROR",
"message": "...",
"traceback": "...",
"success": false
}This class includes 3 subclasses and 1 method.
This method searches for songs by the keyword. This will return a list of CreQQ.Track instances. Searched songs can be either the actual song, or a suggestion one. The maximum size of the list is strictly 10.
queries = CreQQ().search('BLUE Billie Eilish')
# Returns a list of CreQQ.Track instancesThis subclass includes 1 method, and 3 properties–the track title, album name, and the artist name.
print(queries[0].title)
# "BLUE"
print(queries[0].artist)
# "Billie Eilish"
print(queries[0].album)
# "HIT ME HARD AND SOFT"This method will return the metadata of the track.
metadata = queries[0].get_metadata()
# Returns an instance of CreQQ.MetadataThis subclass is just like the CreQQ.Track class, but with additional properties–the lyrics and the offset value (in seconds).
Note
Properties of CreQQ.Track and CreQQ.Metadata (title, artist, album) can be different. Tracks are inherited from the API's information while metadata are inherited from the Lyrics' information.
print(metadata.title)
# "BLUE"
print(metadata.artist)
# "Billie Eilish"
print(metadata.album)
# "HIT ME HARD AND SOFT"
print(metadata.offset)
# 0.0
lyrics = metadata.lyrics
# Returns a list of CreQQ.Lyric instancesmetadata.lyrics is a lyrically-ordered list of CreQQ.Lyric instances.
This subclass is a single line of the track's lyrics including 3 properties–the timestamp (in milliseconds), text, and its raw value.
print(lyrics[1].text)
# "I try to live in black and white but I'm so blue"
print(lyrics[1].timestamp)
# 11260
print(lyrics[1].raw)
# "[00:11.26]I try to live in black and white but I'm so blue"