RecipeEndpoint

class corkus.endpoints.RecipeEndpoint

async list_all(timeout=None)

List all available recipes.

Parameters:

timeout (Optional[int]) – Optionally override default timeout.

Return type:

List[PartialRecipe]

async get()

Attention

This functionality is not yet implemented intro Corkus.py and will raise NotImplementedError.

Return type:

Recipe

async get_by_id(recipe_id, timeout=None)

Get information about recipe by id like Food-13-15 or Wand-63-65.

Parameters:

timeout (Optional[int]) – Optionally override default timeout.

Return type:

Recipe

async search_by_type(type, timeout=None)

Search for the ingredients using type (Recipe.type).

Parameters:

• name – Type of returned recipes.

• timeout (Optional[int]) – Optionally override default timeout.

Return type:

List[Recipe]

async search_by_profession(profession, timeout=None)

Search for the ingredients using profession (Recipe.profession).

Parameters:

• profession (ProfessionType) – Required profession for returned recipes.

• timeout (Optional[int]) – Optionally override default timeout.

Return type:

List[Recipe]

async search_by_level(symbol, *, min=None, max=None, timeout=None)

This is a Complex search route. See more: Search Routes.

Search for the recipes using their Recipe.level.

Parameters:

• symbol (LogicSymbol) – Logic symbol to be used on this query.

• min (Optional[int]) – Minimum level.

• max (Optional[int]) – Maximum level.

• timeout (Optional[int]) – Optionally override default timeout.

Return type:

List[Recipe]

async search_by_durability(symbol, *, min=None, max=None, timeout=None)

This is a Complex search route. See more: Search Routes.

Search for the recipes using their Recipe.durability.

Parameters:

• symbol (LogicSymbol) – Logic symbol to be used on this query.

• min (Optional[int]) – Minimum durability identification.

• max (Optional[int]) – Maximum durability identification.

• timeout (Optional[int]) – Optionally override default timeout.

Return type:

List[Recipe]

async search_by_health_or_damage(symbol, *, min=None, max=None, timeout=None)

This is a Complex search route. See more: Search Routes.

Search for the recipes using their Recipe.health_or_damage.

Parameters:

• symbol (LogicSymbol) – Logic symbol to be used on this query.

• min (Optional[int]) – Minimum health or damage identification.

• max (Optional[int]) – Maximum health or damage identification.

• timeout (Optional[int]) – Optionally override default timeout.

Return type:

List[Recipe]

async search_by_duration(symbol, *, min=None, max=None, timeout=None)

This is a Complex search route. See more: Search Routes.

Search for the recipes using their Recipe.duration.

Parameters:

• symbol (LogicSymbol) – Logic symbol to be used on this query.

• min (Optional[int]) – Minimum duration identification.

• max (Optional[int]) – Maximum duration identification.

• timeout (Optional[int]) – Optionally override default timeout.

Return type:

List[Recipe]