Mirror of geniURL's source code https://github.com/Sv443/geniURL

Sv443 aaa1f07fd1 fixed wrong content-type + readme stuff 3 年之前
.vscode 19ee1deefa lyrics endpoint 3 年之前
src aaa1f07fd1 fixed wrong content-type + readme stuff 3 年之前
.editorconfig 23e612c426 base api done 3 年之前
.env.template e798a686e4 readme stuff 3 年之前
.eslintrc.js 23e612c426 base api done 3 年之前
.gitignore 19ee1deefa lyrics endpoint 3 年之前
LICENSE.txt e798a686e4 readme stuff 3 年之前
README.md aaa1f07fd1 fixed wrong content-type + readme stuff 3 年之前
changelog.md 165f3d5079 bump version, add ?format=xml, add TS types 3 年之前
package-lock.json 165f3d5079 bump version, add ?format=xml, add TS types 3 年之前
package.json 165f3d5079 bump version, add ?format=xml, add TS types 3 年之前

README.md

geniURL

Simple JSON and XML REST API to search for song metadata and the lyrics URL on genius
Obtaining actual lyrics sadly isn't possible yet (ideas are welcome lol)



Base URL:

I host a public instance on this URL:

https://api.sv443.net/geniurl/

Note that this instance is rate limited to 8 requests in 10 seconds.
If you want to host your own and increase the values, look at the top of src/server.js



Routes:

All routes support gzip and deflate compression.


GET /search

This endpoint gives you the top 10 results for a search query specified by search_text
The returned data contains various data like the lyrics website URL, song and thumbnail metadata and more (see below).


Parameters:
?q=search%20query (required)
This parameter should contain both song and artist name(s) if possible (order doesn't matter, separate with a whitespace).
Sometimes the song name alone might be enough but the results may vary.
If the search query contains special characters, they need to be percent/URL-encoded.

?format=json/xml (optional)
Use this parameter to change the response format from the default (json) to xml
The structure of the data closely resembles that of the shown JSON data.


Successful response (click to view)
{
    "error": false,
    "top": {
        "url": "https://genius.com/Artist-1-song-name-lyrics",
        "path": "/Artist-1-song-name-lyrics",
        "meta": {
            "title": "Song Name",
            "fullTitle": "Song Name by Artist 1 (ft. Artist 2)",
            "artists": "Artist 1 (ft. Artist 2)",
            "primaryArtist": {
                "name": "Artist 1",
                "url": "https://genius.com/artists/Artist-1"
            }
        },
        "resources": {
            "thumbnail": "https://images.genius.com/8485557225af0345d2c550af8bae731b.300x300x1.png",
            "image": "https://images.genius.com/13d7b13ef827a9f007a5d24c115b9ebb.1000x1000x1.png"
        },
        "lyricsState": "complete",
        "id": 42069
    },
    "all": [
        "// This array contains 10 objects with the same structure as 'top', sorted best match first",
        "// The first item of this array is exactly the same as 'top'"
    ],
    "timestamp": 1234567890123
}


Errored response (click to view)
{
    "error": true,
    "message": "Something went wrong",
    "timestamp": 1234567890123
}




GET /search/top

This endpoint is the same as /search, but it only gives the top result.
Use this if you are only interested in the top result and want to reduce traffic.


Parameters:
?q=search%20query (required)
This parameter should contain both song and artist name(s) if possible (order doesn't matter, separate with a whitespace).
Sometimes the song name alone might be enough but the results may vary.
If the search query contains special characters, they need to be percent/URL-encoded.

?format=json/xml (optional)
Use this parameter to change the response format from the default (json) to xml
The structure of the data closely resembles that of the shown JSON data.


Successful response (click to view)
{
    "error": false,
    "url": "https://genius.com/Artist-1-song-name-lyrics",
    "path": "/Artist-1-song-name-lyrics",
    "meta": {
        "title": "Song Name",
        "fullTitle": "Song Name by Artist 1 (ft. Artist 2)",
        "artists": "Artist 1 (ft. Artist 2)",
        "primaryArtist": {
            "name": "Artist 1",
            "url": "https://genius.com/artists/Artist-1"
        }
    },
    "resources": {
        "thumbnail": "https://images.genius.com/8485557225af0345d2c550af8bae731b.300x300x1.png",
        "image": "https://images.genius.com/13d7b13ef827a9f007a5d24c115b9ebb.1000x1000x1.png"
    },
    "lyricsState": "complete",
    "id": 42069,
    "timestamp": 1234567890123
}


Errored response (click to view)
{
    "error": true,
    "message": "Something went wrong",
    "timestamp": 1234567890123
}




Made with low effort but still lots of ❤️ by [Sv443](https://sv443.net/) Licensed under the [MIT license](./LICENSE.txt#readme)