Hypixel

Returns Hypixel's guild payload unchanged, wrapped in a guild field. Look up a guild by id, by player (a member's UUID or username), or by name (the guild's name). Set max_cache_age (for example 5m, 1h, or a number of seconds) to serve the latest stored guild within that age instead of calling Hypixel, and to fall back to it when Hypixel is unreachable; such responses set stale to true. Requires the Hypixel permission or an Admin key.

get/v3/hypixel/guild

Request

  • Base URL: https://api.urchin.gg
  • URL: https://api.urchin.gg/v3/hypixel/guild
  • Auth: API key in header X-API-Key

Query parameters

idstring

Guild id

playerstring

A member's UUID or username

namestring

Guild name

max_cache_agestring

Accept the latest stored guild up to this age (e.g. 5m, 1h, 30s)

Response

Raw Hypixel guild payload

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.