Skip to content

Latest commit

 

History

History
53 lines (46 loc) · 1.68 KB

README.md

File metadata and controls

53 lines (46 loc) · 1.68 KB
Raw

Tekstowo Unofficial API

Unofficial API for https://tekstowo.pl
This API has been designed for both Node.JS and Browserside JS.

Features:

  • Getting the lyrics
  • Search
  • Grabbing song metadata
  • Artist's song list
  • Comments
  • Popular songs list
  • Popular artists list
  • Artist details
  • Missing translations list
  • Missing lyrics list
  • Translation edit history
  • Lyrics edit history

Not planned:

  • User-related functionality (voting, login, submit lyrics, edit meta)
  • Advanced (google-based) search

Installing

Note: this project uses pnpm and you should use it too.
However, you don't need to use pnpm if you don't want to (instead of pnpm install etc use npm install).

  1. Download or clone the repo
  2. cd to the repo
  3. index.js is the main API file. You can require it in your project etc.

Browser only steps

If you want to use the browser version, run:

  1. pnpm install
  2. pnpm run build
  3. Use TekstowoAPI-browser.js from dist/ directory.
  4. Use require("./TekstowoAPI")

Example usage

In test.js Or API.md

Browser only example

window.TekstowoAPI = new (require("./TekstowoAPI"))(1); // 1 for allorigins proxy
await TekstowoAPI.getLyrics("HammerFall", "Last Man Standing");

Stuff used

Please use the API responsibly

Please ensure that you use this API responsibly and for legitimate purposes only. Do not spam the Tekstowo server.

Disclaimer

Please note that this unofficial API is not officially supported by Tekstowo. Use this API at your own risk.