The Corkus Client#

Corkus is the most important class that you will be working with. From it you can access all Corkus Endpoints and make requests from them.

class corkus.Corkus#

Represents a API client used for accessing wynncraft resources.

A number of options can be passed to the Corkus. For full lust of configuration options see: Configuring Corkus.

async start(api_key=None)#

Initialize this Corkus instance. Client needs to be initialized to make any API calls.

Return type:

None

property player#

General statistics of wynncraft players.

Return type:

PlayerEndpoint

property guild#

Information about server guilds.

Return type:

GuildEndpoint

property network#

Wynncraft Network specific routes like list of all players.

Return type:

NetworkEndpoint

property territory#

Information about teritories.

Return type:

TerritoryEndpoint

property search#

Search for guild and players.

Return type:

SearchEndpoint

property item#

Regular (not crafted) items database.

Return type:

ItemEndpoint

property recipe#

Crafted items statistics and recipes.

Return type:

RecipeEndpoint

property ingredient#

Information about ingredients.

Return type:

IngredientEndpoint

property leaderboard#

Leaderboards of best players and guilds.

Return type:

LeaderboardEndpoint

property rate_limit#

Current ratelimit information for this Corkus instance.

Return type:

RateLimit

async close()#

End the corkus client when it’s not needed anymore.

Return type:

None