IslesWikiNot officially affiliated with Isles

API reference

List the map's places

What the site's world map shows everyone: waystones, bosses, shrines, skill stations, gathering spots, trees, ores, crops, fishing spots, bestiary mobs, collectibles and the names of areas and regions. Each place has its block, its region, its icon and its wiki page (full URLs); kinds lists the kinds as the map's filters do, with how many of each the answer holds. The version is a hash of the answer, not the catalogue's: it moves when a place is added, moved, changed or taken off the map.

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

showstringOptional
Which kinds: kind ids separated by commas ("waystone,boss"), "all" or "none", as the site's map address takes them. Every kind when left out.
regionstringOptionalDefault: all
One region's places ("region-1", "region-2"), or "all". A place with no region is in every one.
nearstringOptional
Only the places within r blocks of a point, nearest first: "x,z,r" (whole numbers, r up to 5000).

Response

200 OK: The places, their kinds and the regions. Fields: data.

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

Errors

  • 400bad_requestA region that doesn't exist, or near not in the form x,z,r.
  • 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 map's places could not be read. Rare; try again in a minute.

Notes

Polling

Send the ETag back as If-None-Match: the answer is a 304 with no body until a place changes. Once a minute is plenty.

Icons

An icon is the place's own when it has one (a place added on the site can), else its kind's. Most are the game's pixel art: draw a 16 or 32 px icon without smoothing, a bigger one (a weapon's render, a bestiary picture) smoothed.