pylyrical_api

README!!!

pylyrical_api will be SHUT DOWN at Monday, 22 July 2024 at 20:00 UTC. The source code will still be available and updated. That means, you can (and should) self-host it. Why is pylyrical_api shutting down? I need this server slot to host a different project, and unfortunately i cannot have more than one project running, otherwise i will hit the free limit usage.

Update: I no longer have access to the account where pylyrical_api is hosted (cannot login to the account), I can only push commits. So, pylyrical_api will not be shut down I guess...

Try it out

Usage

• Endpoint: /lyrics
• Acceptable parameters: q
• Example: /lyrics?q=how+do+i+make+you+love+me+the+weeknd

Responses

Responses are always in JSON. The following status codes are HTTP status codes.

1. 200
• {"artists": "", "lyrics": "", "source": "", "status": 200, "title": "", "cover_image": ""} Note: cover_image is null if backend could not scrape the cover image.
2. 400
• {"exception": "NoParameter", "message": "Missing parameter 'q'.", "status": 400}
3. 404
• {"exception": "NoResults", "message": "'' did not give any results, Please try a different term.", "status": 404}
4. 500
• {"exception": "ScrapeError", "message": "", "status": 500}
5. 502
• {"exception": "RequestConnectionError", "message": "", "status": 502}

Exceptions/Errors

1. NoParameter: Occurs when no parameter was given.
• Returns status code 400.
2. NoResults: Occurs when no results were found.
• Returns status code 404.
3. ScrapeError: Occurs when pylyrical cannot scrape lyrics from genius.com
• Returns status code 500.
4. RequestConnectionError: Occurs when pylyrical cannot send a request to genius.com
• Returns status code 502.