/tooltip/{type}/{id}

The hover card for one item, NPC, quest or object page, for the embeddable tooltip script

GEThttps://everloot.app/api/tooltip/{type}/{id}

What https://everloot.app/tooltips.js shows when a visitor hovers a link to an Everloot page: title, icon and lines as plain text, the page URL, and the licence. One entity per request, not a bulk feed. Open to any website (CORS *, GET only) and cached by the CDN for an hour. Only things players reported (3 installs) are answered; the item card adds the game files' tooltip text and icon, labelled unconfirmed with their build. Anything else is a 404.

Access#

Open to anyone, no key. Data: both, labelled per row.

Path parameters#

typeone of: item, npc, quest, objectrequired: item, npc, quest or object.
idintegerrequired: The game's id, a positive whole number.

Responses#

200tooltipResponse: The card.
404apiError: Unknown type, bad id, or nothing players have reported about it.
503apiError: Storage is unavailable. The answer is unrecorded, not empty.

Response fields#

The top-level fields of a successful answer. Full shapes are on Schemas and in the OpenAPI document.

okexactly truerequired: No description.
typeone of: item, npc, quest, objectrequired: No description.
idinteger, 1 to 9007199254740991required: No description.
titlestringrequired: The agreed name, or "Item 123" style when no name has 3 installs behind it.
colorstring, or nullrequired: Title colour (item quality), or null.
iconstring, or nullrequired: An icon from the game files asset folder, or null.
linesarray of stringrequired: The card's lines, in order. A value the game files do not give is shown as [?].
partialbooleanrequired: A line holds a [?] for a value the game files do not give yet.
urlstringrequired: The page this card is for.
attributionobjectrequired: No description.
gameDataobject, or nullrequired: No description.

{ "ok": true, "type": "item", "id": 0, "title": "string", "color": "string", "icon": "https://everloot.app", "lines": [ "string" ], "partial": true, "url": "https://everloot.app", "attribution": { "licence": "string", "licenceUrl": "https://everloot.app", "credit": "string", "source": "https://everloot.app", "terms": "https://everloot.app" }, "gameData": { "label": "string", "build": "string", "extractedAt": "string", "credit": "string" } }