Sign in
guild

Get guild by prefix

<Note> This endpoint is cached for <Badge intent="success" minimal>2 minutes</Badge> in the <Badge intent="warning" minimal>USER</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>GUILD</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits). </Note> <Info> Prefix lookups can return `300 MultipleObjectsReturned` with a multi-selector response when more than one guild matches the query. </Info> Prefix queries are useful when your input is a guild tag rather than a full guild name.

Use the identifier query parameter with either username or uuid to control how guild members are identified in the response.

get/guild/prefix/{query}

Path parameters

querystring required

Query parameters

identifier'username' | 'uuid'

Switches player descriptor between either their username or their uuid.

Response

Guild detail.

uuidstring uuid required
namestring required
prefixstring required
levelinteger required
xpPercentinteger required
territoriesinteger required
warsinteger required
raidsinteger required
createdstring date-time required
onlineinteger required
seasonRanksGuildSeasonRanks required
rankingRankMap required

Map of leaderboard type/name to rank position. See GET /leaderboards/types for possible types.

Changes