Skip to content

Routes

endpoints

Route

Represents a route for an endpoint.

Attributes:

Name Type Description
endpoint str

The endpoint name.
_url str

The URL for the route.
_api_version int

The API version for the route.
method str

The HTTP method for the route.
payload Optional[Dict[str, Any]]

The payload for the route.

Examples:

>>> pokemon = "pikachu"
>>> route = Route(endpoint=f"/pokemon/{pokemon}", method="GET")

from_raw_url classmethod 

from_raw_url(url: str) -> Route

Creates a Route object from a raw PokeAPI URL.

Parameters:

Name Type Description Default
url str

The raw URL to create the Route from.

 required

Returns:

Type Description
Route

The created Route object.
Source code in pokelance/endpoints.py 
@classmethod
def from_raw_url(cls, url: str) -> Route:
    """Creates a Route object from a raw PokeAPI URL.

    Parameters
    ----------
    url: str
        The raw URL to create the Route from.

    Returns
    -------
    Route
        The created Route object.
    """
    match = validate_url(url)
    if not match:
        raise ValueError(f"Invalid URL: {url}")
    category, value, subcategory = match.groups()
    return cls(endpoint=f"/{category}/{value}" + (f"/{subcategory}" if subcategory else ""))

Endpoint

Represents an endpoint for the API.

get_language_endpoints classmethod 

get_language_endpoints() -> Route

Gets the language endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_language_endpoints(cls) -> Route:
    """Gets the language endpoints."""
    return Route(endpoint="/language", payload={"limit": 10000})

get_language classmethod 

get_language(language: str | int) -> Route

Gets a language.

Source code in pokelance/endpoints.py 
@classmethod
def get_language(cls, language: str | int) -> Route:
    """Gets a language."""
    return Route(endpoint=f"/language/{language}")

get_api_metadata classmethod 

get_api_metadata() -> Route

Gets the API metadata.

Source code in pokelance/endpoints.py 
@classmethod
def get_api_metadata(cls) -> Route:
    """Gets the API metadata."""
    return Route(endpoint="/meta")

get_berry_endpoints classmethod 

get_berry_endpoints() -> Route

Get a list of berry endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_berry_endpoints(cls) -> Route:
    """Get a list of berry endpoints."""
    return Route(endpoint="/berry", payload={"limit": 10000})

get_berry classmethod 

get_berry(berry: int | str) -> Route

Get a berry by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_berry(cls, berry: int | str) -> Route:
    """Get a berry by its ID or name."""
    return Route(endpoint=f"/berry/{berry}")

get_berry_firmness_endpoints classmethod 

get_berry_firmness_endpoints() -> Route

Get a list of berry firmness endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_berry_firmness_endpoints(cls) -> Route:
    """Get a list of berry firmness endpoints."""
    return Route(endpoint="/berry-firmness", payload={"limit": 10000})

get_berry_firmness classmethod 

get_berry_firmness(berry_firmness: int | str) -> Route

Get a berry firmness by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_berry_firmness(cls, berry_firmness: int | str) -> Route:
    """Get a berry firmness by its ID or name."""
    return Route(endpoint=f"/berry-firmness/{berry_firmness}")

get_berry_flavor_endpoints classmethod 

get_berry_flavor_endpoints() -> Route

Get a list of berry flavor endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_berry_flavor_endpoints(cls) -> Route:
    """Get a list of berry flavor endpoints."""
    return Route(endpoint="/berry-flavor", payload={"limit": 10000})

get_berry_flavor classmethod 

get_berry_flavor(berry_flavor: int | str) -> Route

Get a berry flavor by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_berry_flavor(cls, berry_flavor: int | str) -> Route:
    """Get a berry flavor by its ID or name."""
    return Route(endpoint=f"/berry-flavor/{berry_flavor}")

get_contest_type_endpoints classmethod 

get_contest_type_endpoints() -> Route

Get a list of contest type endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_contest_type_endpoints(cls) -> Route:
    """Get a list of contest type endpoints."""
    return Route(endpoint="/contest-type", payload={"limit": 10000})

get_contest_type classmethod 

get_contest_type(contest_type: int | str) -> Route

Get a contest type by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_contest_type(cls, contest_type: int | str) -> Route:
    """Get a contest type by its ID or name."""
    return Route(endpoint=f"/contest-type/{contest_type}")

get_contest_effect_endpoints classmethod 

get_contest_effect_endpoints() -> Route

Get a list of contest effect endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_contest_effect_endpoints(cls) -> Route:
    """Get a list of contest effect endpoints."""
    return Route(endpoint="/contest-effect", payload={"limit": 10000})

get_contest_effect classmethod 

get_contest_effect(contest_effect: int) -> Route

Get a contest effect by its ID.

Source code in pokelance/endpoints.py 
@classmethod
def get_contest_effect(cls, contest_effect: int) -> Route:
    """Get a contest effect by its ID."""
    return Route(endpoint=f"/contest-effect/{contest_effect}")

get_super_contest_effect_endpoints classmethod 

get_super_contest_effect_endpoints() -> Route

Get a list of super contest effect endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_super_contest_effect_endpoints(cls) -> Route:
    """Get a list of super contest effect endpoints."""
    return Route(endpoint="/super-contest-effect", payload={"limit": 10000})

get_super_contest_effect classmethod 

get_super_contest_effect(
    super_contest_effect: int,
) -> Route

Get a super contest effect by its ID.

Source code in pokelance/endpoints.py 
@classmethod
def get_super_contest_effect(cls, super_contest_effect: int) -> Route:
    """Get a super contest effect by its ID."""
    return Route(endpoint=f"/super-contest-effect/{super_contest_effect}")

get_encounter_method_endpoints classmethod 

get_encounter_method_endpoints() -> Route

Get a list of encounter method endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_encounter_method_endpoints(cls) -> Route:
    """Get a list of encounter method endpoints."""
    return Route(endpoint="/encounter-method", payload={"limit": 10000})

get_encounter_method classmethod 

get_encounter_method(encounter_method: int | str) -> Route

Get an encounter method by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_encounter_method(cls, encounter_method: int | str) -> Route:
    """Get an encounter method by its ID or name."""
    return Route(endpoint=f"/encounter-method/{encounter_method}")

get_encounter_condition_endpoints classmethod 

get_encounter_condition_endpoints() -> Route

Get a list of encounter condition endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_encounter_condition_endpoints(cls) -> Route:
    """Get a list of encounter condition endpoints."""
    return Route(endpoint="/encounter-condition", payload={"limit": 10000})

get_encounter_condition classmethod 

get_encounter_condition(
    encounter_condition: int | str,
) -> Route

Get an encounter condition by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_encounter_condition(cls, encounter_condition: int | str) -> Route:
    """Get an encounter condition by its ID or name."""
    return Route(endpoint=f"/encounter-condition/{encounter_condition}")

get_encounter_condition_value_endpoints classmethod 

get_encounter_condition_value_endpoints() -> Route

Get a list of encounter condition value endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_encounter_condition_value_endpoints(cls) -> Route:
    """Get a list of encounter condition value endpoints."""
    return Route(endpoint="/encounter-condition-value", payload={"limit": 10000})

get_encounter_condition_value classmethod 

get_encounter_condition_value(
    encounter_condition_value: int | str,
) -> Route

Get an encounter condition value by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_encounter_condition_value(cls, encounter_condition_value: int | str) -> Route:
    """Get an encounter condition value by its ID or name."""
    return Route(endpoint=f"/encounter-condition-value/{encounter_condition_value}")

get_evolution_chain_endpoints classmethod 

get_evolution_chain_endpoints() -> Route

Get a list of evolution chain endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_evolution_chain_endpoints(cls) -> Route:
    """Get a list of evolution chain endpoints."""
    return Route(endpoint="/evolution-chain", payload={"limit": 10000})

get_evolution_chain classmethod 

get_evolution_chain(evolution_chain: int) -> Route

Get an evolution chain by its ID.

Source code in pokelance/endpoints.py 
@classmethod
def get_evolution_chain(cls, evolution_chain: int) -> Route:
    """Get an evolution chain by its ID."""
    return Route(endpoint=f"/evolution-chain/{evolution_chain}")

get_evolution_trigger_endpoints classmethod 

get_evolution_trigger_endpoints() -> Route

Get a list of evolution trigger endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_evolution_trigger_endpoints(cls) -> Route:
    """Get a list of evolution trigger endpoints."""
    return Route(endpoint="/evolution-trigger", payload={"limit": 10000})

get_evolution_trigger classmethod 

get_evolution_trigger(
    evolution_trigger: int | str,
) -> Route

Get an evolution trigger by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_evolution_trigger(cls, evolution_trigger: int | str) -> Route:
    """Get an evolution trigger by its ID or name."""
    return Route(endpoint=f"/evolution-trigger/{evolution_trigger}")

get_generation_endpoints classmethod 

get_generation_endpoints() -> Route

Get a list of generation endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_generation_endpoints(cls) -> Route:
    """Get a list of generation endpoints."""
    return Route(endpoint="/generation", payload={"limit": 10000})

get_generation classmethod 

get_generation(generation: int | str) -> Route

Get a generation by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_generation(cls, generation: int | str) -> Route:
    """Get a generation by its ID or name."""
    return Route(endpoint=f"/generation/{generation}")

get_pokedex_endpoints classmethod 

get_pokedex_endpoints() -> Route

Get a list of pokedex endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_pokedex_endpoints(cls) -> Route:
    """Get a list of pokedex endpoints."""
    return Route(endpoint="/pokedex", payload={"limit": 10000})

get_pokedex classmethod 

get_pokedex(pokedex: int | str) -> Route

Get a pokedex by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_pokedex(cls, pokedex: int | str) -> Route:
    """Get a pokedex by its ID or name."""
    return Route(endpoint=f"/pokedex/{pokedex}")

get_version_endpoints classmethod 

get_version_endpoints() -> Route

Get a list of version endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_version_endpoints(cls) -> Route:
    """Get a list of version endpoints."""
    return Route(endpoint="/version", payload={"limit": 10000})

get_version classmethod 

get_version(version: int | str) -> Route

Get a version by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_version(cls, version: int | str) -> Route:
    """Get a version by its ID or name."""
    return Route(endpoint=f"/version/{version}")

get_version_group_endpoints classmethod 

get_version_group_endpoints() -> Route

Get a list of version group endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_version_group_endpoints(cls) -> Route:
    """Get a list of version group endpoints."""
    return Route(endpoint="/version-group", payload={"limit": 10000})

get_version_group classmethod 

get_version_group(version_group: int | str) -> Route

Get a version group by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_version_group(cls, version_group: int | str) -> Route:
    """Get a version group by its ID or name."""
    return Route(endpoint=f"/version-group/{version_group}")

get_currency_endpoints classmethod 

get_currency_endpoints() -> Route

Get a list of currency endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_currency_endpoints(cls) -> Route:
    """Get a list of currency endpoints."""
    return Route(endpoint="/currency", payload={"limit": 10000})

get_currency classmethod 

get_currency(currency: int | str) -> Route

Get a currency by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_currency(cls, currency: int | str) -> Route:
    """Get a currency by its ID or name."""
    return Route(endpoint=f"/currency/{currency}")

get_item_endpoints classmethod 

get_item_endpoints() -> Route

Get a list of item endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_item_endpoints(cls) -> Route:
    """Get a list of item endpoints."""
    return Route(endpoint="/item", payload={"limit": 10000})

get_item classmethod 

get_item(item: int | str) -> Route

Get an item by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_item(cls, item: int | str) -> Route:
    """Get an item by its ID or name."""
    return Route(endpoint=f"/item/{item}")

get_item_attribute_endpoints classmethod 

get_item_attribute_endpoints() -> Route

Get a list of item attribute endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_item_attribute_endpoints(cls) -> Route:
    """Get a list of item attribute endpoints."""
    return Route(endpoint="/item-attribute", payload={"limit": 10000})

get_item_attribute classmethod 

get_item_attribute(item_attribute: int | str) -> Route

Get an item attribute by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_item_attribute(cls, item_attribute: int | str) -> Route:
    """Get an item attribute by its ID or name."""
    return Route(endpoint=f"/item-attribute/{item_attribute}")

get_item_category_endpoints classmethod 

get_item_category_endpoints() -> Route

Get a list of item category endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_item_category_endpoints(cls) -> Route:
    """Get a list of item category endpoints."""
    return Route(endpoint="/item-category", payload={"limit": 10000})

get_item_category classmethod 

get_item_category(item_category: int | str) -> Route

Get an item category by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_item_category(cls, item_category: int | str) -> Route:
    """Get an item category by its ID or name."""
    return Route(endpoint=f"/item-category/{item_category}")

get_item_fling_effect_endpoints classmethod 

get_item_fling_effect_endpoints() -> Route

Get a list of item fling effect endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_item_fling_effect_endpoints(cls) -> Route:
    """Get a list of item fling effect endpoints."""
    return Route(endpoint="/item-fling-effect", payload={"limit": 10000})

get_item_fling_effect classmethod 

get_item_fling_effect(
    item_fling_effect: int | str,
) -> Route

Get an item fling effect by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_item_fling_effect(cls, item_fling_effect: int | str) -> Route:
    """Get an item fling effect by its ID or name."""
    return Route(endpoint=f"/item-fling-effect/{item_fling_effect}")

get_item_pocket_endpoints classmethod 

get_item_pocket_endpoints() -> Route

Get a list of item pocket endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_item_pocket_endpoints(cls) -> Route:
    """Get a list of item pocket endpoints."""
    return Route(endpoint="/item-pocket", payload={"limit": 10000})

get_item_pocket classmethod 

get_item_pocket(item_pocket: int | str) -> Route

Get an item pocket by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_item_pocket(cls, item_pocket: int | str) -> Route:
    """Get an item pocket by its ID or name."""
    return Route(endpoint=f"/item-pocket/{item_pocket}")

get_location_endpoints classmethod 

get_location_endpoints() -> Route

Get a list of location endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_location_endpoints(cls) -> Route:
    """Get a list of location endpoints."""
    return Route(endpoint="/location", payload={"limit": 10000})

get_location classmethod 

get_location(location: int | str) -> Route

Get a location by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_location(cls, location: int | str) -> Route:
    """Get a location by its ID or name."""
    return Route(endpoint=f"/location/{location}")

get_location_area_endpoints classmethod 

get_location_area_endpoints() -> Route

Get a list of location area endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_location_area_endpoints(cls) -> Route:
    """Get a list of location area endpoints."""
    return Route(endpoint="/location-area", payload={"limit": 10000})

get_location_area classmethod 

get_location_area(location_area: int | str) -> Route

Get a location area by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_location_area(cls, location_area: int | str) -> Route:
    """Get a location area by its ID or name."""
    return Route(endpoint=f"/location-area/{location_area}")

get_pal_park_area_endpoints classmethod 

get_pal_park_area_endpoints() -> Route

Get a list of pal park area endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_pal_park_area_endpoints(cls) -> Route:
    """Get a list of pal park area endpoints."""
    return Route(endpoint="/pal-park-area", payload={"limit": 10000})

get_pal_park_area classmethod 

get_pal_park_area(pal_park_area: int | str) -> Route

Get a pal park area by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_pal_park_area(cls, pal_park_area: int | str) -> Route:
    """Get a pal park area by its ID or name."""
    return Route(endpoint=f"/pal-park-area/{pal_park_area}")

get_region_endpoints classmethod 

get_region_endpoints() -> Route

Get a list of region endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_region_endpoints(cls) -> Route:
    """Get a list of region endpoints."""
    return Route(endpoint="/region", payload={"limit": 10000})

get_region classmethod 

get_region(region: int | str) -> Route

Get a region by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_region(cls, region: int | str) -> Route:
    """Get a region by its ID or name."""
    return Route(endpoint=f"/region/{region}")

get_machine_endpoints classmethod 

get_machine_endpoints() -> Route

Get a list of machine endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_machine_endpoints(cls) -> Route:
    """Get a list of machine endpoints."""
    return Route(endpoint="/machine", payload={"limit": 10000})

get_machine classmethod 

get_machine(machine: int) -> Route

Get a machine by its ID.

Source code in pokelance/endpoints.py 
@classmethod
def get_machine(cls, machine: int) -> Route:
    """Get a machine by its ID."""
    return Route(endpoint=f"/machine/{machine}")

get_move_endpoints classmethod 

get_move_endpoints() -> Route

Get a list of move endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_move_endpoints(cls) -> Route:
    """Get a list of move endpoints."""
    return Route(endpoint="/move", payload={"limit": 10000})

get_move classmethod 

get_move(move: int | str) -> Route

Get a move by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_move(cls, move: int | str) -> Route:
    """Get a move by its ID or name."""
    return Route(endpoint=f"/move/{move}")

get_move_ailment_endpoints classmethod 

get_move_ailment_endpoints() -> Route

Get a list of move ailment endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_move_ailment_endpoints(cls) -> Route:
    """Get a list of move ailment endpoints."""
    return Route(endpoint="/move-ailment", payload={"limit": 10000})

get_move_ailment classmethod 

get_move_ailment(move_ailment: int | str) -> Route

Get a move ailment by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_move_ailment(cls, move_ailment: int | str) -> Route:
    """Get a move ailment by its ID or name."""
    return Route(endpoint=f"/move-ailment/{move_ailment}")

get_move_battle_style_endpoints classmethod 

get_move_battle_style_endpoints() -> Route

Get a list of move battle style endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_move_battle_style_endpoints(cls) -> Route:
    """Get a list of move battle style endpoints."""
    return Route(endpoint="/move-battle-style", payload={"limit": 10000})

get_move_battle_style classmethod 

get_move_battle_style(
    move_battle_style: int | str,
) -> Route

Get a move battle style by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_move_battle_style(cls, move_battle_style: int | str) -> Route:
    """Get a move battle style by its ID or name."""
    return Route(endpoint=f"/move-battle-style/{move_battle_style}")

get_move_category_endpoints classmethod 

get_move_category_endpoints() -> Route

Get a list of move category endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_move_category_endpoints(cls) -> Route:
    """Get a list of move category endpoints."""
    return Route(endpoint="/move-category", payload={"limit": 10000})

get_move_category classmethod 

get_move_category(move_category: int | str) -> Route

Get a move category by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_move_category(cls, move_category: int | str) -> Route:
    """Get a move category by its ID or name."""
    return Route(endpoint=f"/move-category/{move_category}")

get_move_damage_class_endpoints classmethod 

get_move_damage_class_endpoints() -> Route

Get a list of move damage class endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_move_damage_class_endpoints(cls) -> Route:
    """Get a list of move damage class endpoints."""
    return Route(endpoint="/move-damage-class", payload={"limit": 10000})

get_move_damage_class classmethod 

get_move_damage_class(
    move_damage_class: int | str,
) -> Route

Get a move damage class by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_move_damage_class(cls, move_damage_class: int | str) -> Route:
    """Get a move damage class by its ID or name."""
    return Route(endpoint=f"/move-damage-class/{move_damage_class}")

get_move_learn_method_endpoints classmethod 

get_move_learn_method_endpoints() -> Route

Get a list of move learn method endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_move_learn_method_endpoints(cls) -> Route:
    """Get a list of move learn method endpoints."""
    return Route(endpoint="/move-learn-method", payload={"limit": 10000})

get_move_learn_method classmethod 

get_move_learn_method(
    move_learn_method: int | str,
) -> Route

Get a move learn method by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_move_learn_method(cls, move_learn_method: int | str) -> Route:
    """Get a move learn method by its ID or name."""
    return Route(endpoint=f"/move-learn-method/{move_learn_method}")

get_move_target_endpoints classmethod 

get_move_target_endpoints() -> Route

Get a list of move target endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_move_target_endpoints(cls) -> Route:
    """Get a list of move target endpoints."""
    return Route(endpoint="/move-target", payload={"limit": 10000})

get_move_target classmethod 

get_move_target(move_target: int | str) -> Route

Get a move target by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_move_target(cls, move_target: int | str) -> Route:
    """Get a move target by its ID or name."""
    return Route(endpoint=f"/move-target/{move_target}")

get_ability_endpoints classmethod 

get_ability_endpoints() -> Route

Get a list of ability endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_ability_endpoints(cls) -> Route:
    """Get a list of ability endpoints."""
    return Route(endpoint="/ability", payload={"limit": 10000})

get_ability classmethod 

get_ability(ability: int | str) -> Route

Get an ability by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_ability(cls, ability: int | str) -> Route:
    """Get an ability by its ID or name."""
    return Route(endpoint=f"/ability/{ability}")

get_characteristic_endpoints classmethod 

get_characteristic_endpoints() -> Route

Get a list of characteristic endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_characteristic_endpoints(cls) -> Route:
    """Get a list of characteristic endpoints."""
    return Route(endpoint="/characteristic", payload={"limit": 10000})

get_characteristic classmethod 

get_characteristic(characteristic: int) -> Route

Get a characteristic by its ID.

Source code in pokelance/endpoints.py 
@classmethod
def get_characteristic(cls, characteristic: int) -> Route:
    """Get a characteristic by its ID."""
    return Route(endpoint=f"/characteristic/{characteristic}")

get_egg_group_endpoints classmethod 

get_egg_group_endpoints() -> Route

Get a list of egg group endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_egg_group_endpoints(cls) -> Route:
    """Get a list of egg group endpoints."""
    return Route(endpoint="/egg-group", payload={"limit": 10000})

get_egg_group classmethod 

get_egg_group(egg_group: int | str) -> Route

Get an egg group by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_egg_group(cls, egg_group: int | str) -> Route:
    """Get an egg group by its ID or name."""
    return Route(endpoint=f"/egg-group/{egg_group}")

get_gender_endpoints classmethod 

get_gender_endpoints() -> Route

Get a list of gender endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_gender_endpoints(cls) -> Route:
    """Get a list of gender endpoints."""
    return Route(endpoint="/gender", payload={"limit": 10000})

get_gender classmethod 

get_gender(gender: int | str) -> Route

Get a gender by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_gender(cls, gender: int | str) -> Route:
    """Get a gender by its ID or name."""
    return Route(endpoint=f"/gender/{gender}")

get_growth_rate_endpoints classmethod 

get_growth_rate_endpoints() -> Route

Get a list of growth rate endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_growth_rate_endpoints(cls) -> Route:
    """Get a list of growth rate endpoints."""
    return Route(endpoint="/growth-rate", payload={"limit": 10000})

get_growth_rate classmethod 

get_growth_rate(growth_rate: int | str) -> Route

Get a growth rate by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_growth_rate(cls, growth_rate: int | str) -> Route:
    """Get a growth rate by its ID or name."""
    return Route(endpoint=f"/growth-rate/{growth_rate}")

get_nature_endpoints classmethod 

get_nature_endpoints() -> Route

Get a list of nature endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_nature_endpoints(cls) -> Route:
    """Get a list of nature endpoints."""
    return Route(endpoint="/nature", payload={"limit": 10000})

get_nature classmethod 

get_nature(nature: int | str) -> Route

Get a nature by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_nature(cls, nature: int | str) -> Route:
    """Get a nature by its ID or name."""
    return Route(endpoint=f"/nature/{nature}")

get_location_area_encounter_endpoints classmethod 

get_location_area_encounter_endpoints() -> Route

Get a list of location area encounter endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_location_area_encounter_endpoints(cls) -> Route:
    """Get a list of location area encounter endpoints."""
    return Route(endpoint="/pokemon", payload={"limit": 10000})

get_location_area_encounter classmethod 

get_location_area_encounter(name: int | str) -> Route

Get a location area encounter by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_location_area_encounter(cls, name: int | str) -> Route:
    """Get a location area encounter by its ID or name."""
    return Route(endpoint=f"/pokemon/{name}/encounters")

get_pokeathlon_stat_endpoints classmethod 

get_pokeathlon_stat_endpoints() -> Route

Get a list of pokeathlon stat endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_pokeathlon_stat_endpoints(cls) -> Route:
    """Get a list of pokeathlon stat endpoints."""
    return Route(endpoint="/pokeathlon-stat", payload={"limit": 10000})

get_pokeathlon_stat classmethod 

get_pokeathlon_stat(pokeathlon_stat: int | str) -> Route

Get a pokeathlon stat by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_pokeathlon_stat(cls, pokeathlon_stat: int | str) -> Route:
    """Get a pokeathlon stat by its ID or name."""
    return Route(endpoint=f"/pokeathlon-stat/{pokeathlon_stat}")

get_pokemon_endpoints classmethod 

get_pokemon_endpoints() -> Route

Get a list of pokemon endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_pokemon_endpoints(cls) -> Route:
    """Get a list of pokemon endpoints."""
    return Route(endpoint="/pokemon", payload={"limit": 10000})

get_pokemon classmethod 

get_pokemon(pokemon: int | str) -> Route

Get a pokemon by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_pokemon(cls, pokemon: int | str) -> Route:
    """Get a pokemon by its ID or name."""
    return Route(endpoint=f"/pokemon/{pokemon}")

get_pokemon_color_endpoints classmethod 

get_pokemon_color_endpoints() -> Route

Get a list of pokemon color endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_pokemon_color_endpoints(cls) -> Route:
    """Get a list of pokemon color endpoints."""
    return Route(endpoint="/pokemon-color", payload={"limit": 10000})

get_pokemon_color classmethod 

get_pokemon_color(pokemon_color: int | str) -> Route

Get a pokemon color by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_pokemon_color(cls, pokemon_color: int | str) -> Route:
    """Get a pokemon color by its ID or name."""
    return Route(endpoint=f"/pokemon-color/{pokemon_color}")

get_pokemon_form_endpoints classmethod 

get_pokemon_form_endpoints() -> Route

Get a list of pokemon form endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_pokemon_form_endpoints(cls) -> Route:
    """Get a list of pokemon form endpoints."""
    return Route(endpoint="/pokemon-form", payload={"limit": 10000})

get_pokemon_form classmethod 

get_pokemon_form(pokemon_form: int | str) -> Route

Get a pokemon form by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_pokemon_form(cls, pokemon_form: int | str) -> Route:
    """Get a pokemon form by its ID or name."""
    return Route(endpoint=f"/pokemon-form/{pokemon_form}")

get_pokemon_habitat_endpoints classmethod 

get_pokemon_habitat_endpoints() -> Route

Get a list of pokemon habitat endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_pokemon_habitat_endpoints(cls) -> Route:
    """Get a list of pokemon habitat endpoints."""
    return Route(endpoint="/pokemon-habitat", payload={"limit": 10000})

get_pokemon_habitat classmethod 

get_pokemon_habitat(pokemon_habitat: int | str) -> Route

Get a pokemon habitat by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_pokemon_habitat(cls, pokemon_habitat: int | str) -> Route:
    """Get a pokemon habitat by its ID or name."""
    return Route(endpoint=f"/pokemon-habitat/{pokemon_habitat}")

get_pokemon_shape_endpoints classmethod 

get_pokemon_shape_endpoints() -> Route

Get a list of pokemon shape endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_pokemon_shape_endpoints(cls) -> Route:
    """Get a list of pokemon shape endpoints."""
    return Route(endpoint="/pokemon-shape", payload={"limit": 10000})

get_pokemon_shape classmethod 

get_pokemon_shape(pokemon_shape: int | str) -> Route

Get a pokemon shape by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_pokemon_shape(cls, pokemon_shape: int | str) -> Route:
    """Get a pokemon shape by its ID or name."""
    return Route(endpoint=f"/pokemon-shape/{pokemon_shape}")

get_pokemon_species_endpoints classmethod 

get_pokemon_species_endpoints() -> Route

Get a list of pokemon species endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_pokemon_species_endpoints(cls) -> Route:
    """Get a list of pokemon species endpoints."""
    return Route(endpoint="/pokemon-species", payload={"limit": 10000})

get_pokemon_species classmethod 

get_pokemon_species(pokemon_species: int | str) -> Route

Get a pokemon species by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_pokemon_species(cls, pokemon_species: int | str) -> Route:
    """Get a pokemon species by its ID or name."""
    return Route(endpoint=f"/pokemon-species/{pokemon_species}")

get_stat_endpoints classmethod 

get_stat_endpoints() -> Route

Get a list of stat endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_stat_endpoints(cls) -> Route:
    """Get a list of stat endpoints."""
    return Route(endpoint="/stat", payload={"limit": 10000})

get_stat classmethod 

get_stat(stat: int | str) -> Route

Get a stat by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_stat(cls, stat: int | str) -> Route:
    """Get a stat by its ID or name."""
    return Route(endpoint=f"/stat/{stat}")

get_type_endpoints classmethod 

get_type_endpoints() -> Route

Get a list of type endpoints.

Source code in pokelance/endpoints.py 
@classmethod
def get_type_endpoints(cls) -> Route:
    """Get a list of type endpoints."""
    return Route(endpoint="/type", payload={"limit": 10000})

get_type classmethod 

get_type(type_: int | str) -> Route

Get a type by its ID or name.

Source code in pokelance/endpoints.py 
@classmethod
def get_type(cls, type_: int | str) -> Route:
    """Get a type by its ID or name."""
    return Route(endpoint=f"/type/{type_}")

Comments