Get-PokePokemonSpecies

SYNOPSIS

Gets pokemon species from PokeAPI

SYNTAX

index_ByAll (Default)

Get-PokePokemonSpecies [-offset <Int32>] [-limit <Int32>] [-allPages] [<CommonParameters>]

index_ById

Get-PokePokemonSpecies -id <Int32> [<CommonParameters>]

index_ByName

Get-PokePokemonSpecies -name <String> [<CommonParameters>]

DESCRIPTION

The Get-PokePokemonSpecies cmdlet gets pokemon species from PokeAPI

A Pokemon Species forms the basis for at least one Pokemon. Attributes of a Pokemon species are shared across all varieties of Pokemon within the species.

A good example is Wormadam; Wormadam is the species which can be found in three different varieties, Wormadam-Trash, Wormadam-Sandy and Wormadam-Plant.

EXAMPLES

EXAMPLE 1

Get-PokePokemonSpecies

Gets the first 20 pokemon species sorted by id

EXAMPLE 2

Get-PokePokemonSpecies -id 1

Gets the pokemon species with the defined id

EXAMPLE 3

Get-PokePokemonSpecies -name ditto

Gets the pokemon species with the defined name

EXAMPLE 4

Get-PokePokemonSpecies -offset 151 -limit 100

Gets the first 100 resources starting at resources with an id over 151

PARAMETERS

-id

Defines id of the resource

Type: Int32
Parameter Sets: index_ById
Aliases:

Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-name

Defines name of the resource

Type: String
Parameter Sets: index_ByName
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-offset

Defines the page number to return

By default only 20 resources are returned

Type: Int32
Parameter Sets: index_ByAll
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-limit

Defines the amount of resources to return with each page

By default only 20 resources are returned

Type: Int32
Parameter Sets: index_ByAll
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-allPages

Returns all resources from an endpoint

As of 2024-02, there is no cap on how many resources can be returned using the limit parameter. There is currently no real use for this parameter and it was included simply to account if pagination is introduced.

Type: SwitchParameter
Parameter Sets: index_ByAll
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

n/a

RELATED LINKS

https://celerium.github.io/PokeAPI-PowerShellWrapper/site/pokemon/Get-PokePokemonSpecies.html