wynncraft-python
A wrapper for the Wynncraft API, with local caching.
Install
Requires at least python 3.6
pip install wynncraftInformation
- All information returned in JSON format.
- For incorrect inputs
ValueErrorwill be raised. -
How does caching works?
Only thewynncraft.cache.*functions will cache the response. If it called, it looks up the cache. If finds a valid cached response and returns it, otherwise it will make a new request, and caches it.
A cached response is not valid if:- there isn't a response for that request in cache or
- cached response is older than CACHE_TIME
Constants
| Constant | Type | Descrpition | Default Value |
|---|---|---|---|
API_KEY |
String | Your API key. (Not required, but recommended) | "" |
CACHE_TIME |
Nubmer | How long does a cached response can be used. | 300 |
TIMEOUT |
Number | Specifies a timeout in seconds for http request. | 10 |
RL_ENABLE |
Boolean | Enables the rate limiter. | True |
Functions
Guild
wynncraft.Guild.list()wynncraft.Guild.stats("Wynncraft")Ingredient
wynncraft.Ingredient.get("apple")wynncraft.Ingredient.list()# Valid queries: name, tier, level, skills, sprite, identifications, itemOnlyIDs, consumableOnlyIDs
wynncraft.Ingredient.search(query, arg)# Same as Ingredient.search("name", arg)
wynncraft.Ingredient.search_name(arg)# Same as Ingredient.search("tier", arg)
wynncraft.Ingredient.search_tier(arg)# Same as Ingredient.search("level", arg)
wynncraft.Ingredient.search_level(arg)# Same as Ingredient.search("skills", arg)
wynncraft.Ingredient.search_skills(arg)# Same as Ingredient.search("sprite", arg)
wynncraft.Ingredient.search_sprite(arg)# Same as Ingredient.search("identifications", arg)
wynncraft.Ingredient.search_identifications(arg)# Same as Ingredient.search("itemOnlyIDs", arg)
wynncraft.Ingredient.search_item_only_ids(arg)# Same as Ingredient.search("consumableOnlyIDs", arg)
wynncraft.Ingredient.search_consumable_only_ids(arg)Item
# Valid categories: all, boots, bow, bracelet, chestplate, dagger, helmet, leggings, necklace, ring, spear, wand
wynncraft.Item.database_category(all)wynncraft.Item.database_search("Idol")Leaderboard
wynncraft.Leaderboard.guild(timeframe)wynncraft.Leaderboard.player(timeframe)wynncraft.Leaderboard.pvp(timeframe)Network
wynncraft.Network.server_list()wynncraft.Network.player_sum()Player
wynncraft.Player.stats("Salted")wynncraft.Player.uuid("Salted")Recipe
wynncraft.Recipe.get("Boots-1-3")wynncraft.Recipe.list()# Valid queries: type, skill, level, durability, healthOrDamage, duration, basicDuration
wynncraft.Recipe.search(query, arg)# Same as Recipe.search("type", arg)
wynncraft.Recipe.search_type(arg)# Same as Recipe.search("skill", arg)
wynncraft.Recipe.search_skill(arg)# Same as Recipe.search("level", arg)
wynncraft.Recipe.search_level(arg)# Same as Recipe.search("durability", arg)
wynncraft.Recipe.search_durability(arg)# Same as Recipe.search("healthOrDamage", arg)
wynncraft.Recipe.search_health_or_damage(arg)# Same as Recipe.search("duration", arg)
wynncraft.Recipe.search_duration(arg)# Same as Recipe.search("basicDuration", arg)
wynncraft.Recipe.search_basic_duration(arg)Search
wynncraft.Search.name("Salted")Territory
wynncraft.Territory.list()
