IslesWikiNot officially affiliated with Isles

API reference

Search

Names that match: the exact name first, then names that start with the text, then the rest. Use it to find a key.

Authorization

AuthorizationOptional

Works without a key. Send one to use its own limit: Authorization: Bearer iwk_… or X-API-Key: iwk_…. See Authentication.

Counted: 60 calls a minute per address without a key.

Request

Query parameters

qstringRequired
The text to look for: at least 2 characters.
limitintegerOptionalDefault: 20
How many to return, 1 to 100.

Response

200 OK: The matches, best first.

The example answer is beside it, from the catalogue as it is now.

Errors

  • 400bad_requestq is shorter than 2 characters, or limit is out of range.
  • 401bad_keyAn API key was sent that is unknown or revoked. Leave it out to use the free limit.
  • 429rate_limitedMore calls in a minute than the limit (60 per address without a key, or the key's own). Wait for Retry-After seconds.
  • 503unavailableThe catalogue could not be loaded. Rare; try again in a minute.