IslesWikiNot officially affiliated with Isles

Getting started

Authentication

No route needs a key. A key raises your limit above the free one, to what was agreed for it.

Sending a key

Put it in either header; both do the same:

Two waysshell
curl "https://isleswiki.net/api/v1/items" \
  -H "Authorization: Bearer iwk_YOUR_KEY"

curl "https://isleswiki.net/api/v1/items" \
  -H "X-API-Key: iwk_YOUR_KEY"

Key format

A key is iwk_ and 32 letters, digits, - and _. Only a fingerprint of it is kept, so a lost key cannot be looked up again: ask for a new one.

Keep it on a server

Anyone can read the code of a web page, so a key used in a browser is a key given away. Call the API from your server or bot, or leave the key out in the browser and use the free limit.

Getting a key

Keys are made by hand: ask the wiki's owner on Discord and say what you are building and about how many calls a minute it needs. Without a key you have 60 calls a minute per address, which is plenty for most uses.

When a key is refused

  • 401bad_keyThe key is unknown or was revoked. It is refused rather than quietly treated as no key, so you notice. Leave it out to use the free limit.
  • 429rate_limitedThe key's own limit is used up for now; the answer says when to try again.

A revoked key stops working at once. The upload route is the exception to all this: it takes the sync service's upload token, not an API key.