wynncraft-python

A simple wrapper for the Wynncraft API, with caching.

Install

Requires at least python 3.6

pip install wynncraft

Information

• All information returned in JSON format.
• For incorrect inputs ValueError is raised.
• To disable caching, set CACHE_TIME to 0

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 is usable.	300
RATE_LIMITER	Boolean	Enables the rate limiter.	True
REGEX_CHECK	Boolean	Checks the syntax of the argument.	True
TIMEOUT	Number	Specifies a timeout in seconds for http request.	10

Functions

Guild

• list

wynncraft.Guild.list()

• stats

wynncraft.Guild.stats("Wynncraft")

Ingredient

• get

wynncraft.Ingredient.get("apple")

• list

wynncraft.Ingredient.list()

• search

# Valid queries: name, tier, level, skills, sprite, identifications, itemOnlyIDs, consumableOnlyIDs
wynncraft.Ingredient.search(query, arg)

• search_name

# Same as Ingredient.search("name", arg)
wynncraft.Ingredient.search_name(arg)

• search_tier

# Same as Ingredient.search("tier", arg)
wynncraft.Ingredient.search_tier(arg)

• search_level

# Same as Ingredient.search("level", arg)
wynncraft.Ingredient.search_level(arg)

• search_skills

# Same as Ingredient.search("skills", arg)
wynncraft.Ingredient.search_skills(arg)

• search_sprite

# Same as Ingredient.search("sprite", arg)
wynncraft.Ingredient.search_sprite(arg)

• search_identifications

# Same as Ingredient.search("identifications", arg)
wynncraft.Ingredient.search_identifications(arg)

• search_item_only_ids

# Same as Ingredient.search("itemOnlyIDs", arg)
wynncraft.Ingredient.search_item_only_ids(arg)

• search_consumable_only_ids

# Same as Ingredient.search("consumableOnlyIDs", arg)
wynncraft.Ingredient.search_consumable_only_ids(arg)

Item

• database_category

# Valid categories: all, boots, bow, bracelet, chestplate, dagger, helmet, leggings, necklace, ring, spear, wand
wynncraft.Item.database_category(all)

• database_search

wynncraft.Item.database_search("Idol")

Leaderboard

• guild

wynncraft.Leaderboard.guild(timeframe)

• player

wynncraft.Leaderboard.player(timeframe)

• pvp

wynncraft.Leaderboard.pvp(timeframe)

Network

• server_list

wynncraft.Network.server_list()

• player_sum

wynncraft.Network.player_sum()

Player

• stats

wynncraft.Player.stats("Salted")

• uuid

wynncraft.Player.uuid("Salted")

Recipe

• get

wynncraft.Recipe.get("Boots-1-3")

• list

wynncraft.Recipe.list()

• search

# Valid queries: type, skill, level, durability, healthOrDamage, duration, basicDuration
wynncraft.Recipe.search(query, arg)

• search_type

# Same as Recipe.search("type", arg)
wynncraft.Recipe.search_type(arg)

• search_skill

# Same as Recipe.search("skill", arg)
wynncraft.Recipe.search_skill(arg)

• search_level

# Same as Recipe.search("level", arg)
wynncraft.Recipe.search_level(arg)

• search_durability

# Same as Recipe.search("durability", arg)
wynncraft.Recipe.search_durability(arg)

• search_health_or_damage

# Same as Recipe.search("healthOrDamage", arg)
wynncraft.Recipe.search_health_or_damage(arg)

• search_duration

# Same as Recipe.search("duration", arg)
wynncraft.Recipe.search_duration(arg)

• search_basic_duration

# Same as Recipe.search("basicDuration", arg)
wynncraft.Recipe.search_basic_duration(arg)

Search

• name

wynncraft.Search.name("Salted")

Territory

• list

wynncraft.Territory.list()

Extra

Wynncraft v3 API endpoints

After official documentation, these will be moved to the appropriate classes. Undocumented, subject to name change or removal. These return lists not dicts.

• latest_news

wynncraft.Extra.latest_news()

• latest_tweets

wynncraft.Extra.latest_tweets()

Wynntils API endpoints (not official)

Undocumented, subject to name change or removal.

• gathering_spots

wynncraft.Extra.gathering_spots()

• server_list

wynncraft.Extra.server_list()

For more documentation see the Wynncraft API documentation.