Check Speed against a regulation
check_speedCompute final Speed from EVs, nature, boosts, and Choice Scarf, then compare against a Regulation roster to identify outspeed, tie, and slower matchups.
Instructions
Compute one Pokémon’s final Speed and, given a Regulation Set, rank it against that roster at its fastest (252 EV, +Spe nature) and uninvested reference speeds. Speed only: for damage use calculate_damage or calculate_matchups, and to find the Speed EVs that beat a target use optimize_evs. Applies boosts.spe (-6..+6) and Choice Scarf ×1.5; other items are reported as Speed-neutral, and regulation is optional. Returns finalSpeed, modifiers, and outspeeds/conditional/losesTo counts with up to 15 threats each. Read-only and offline; unknown names return an isError.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| evs | No | EVs keyed by stat id; only `spe` (0-252) changes the result, e.g. { spe: 252 }. | |
| ivs | No | IVs keyed by stat id; only `spe` (0-31) changes the result, and it defaults to 31. | |
| item | No | Held item, e.g. "Choice Scarf"; only Choice Scarf multiplies Speed (×1.5), other items are listed as speed-neutral. | |
| level | No | Level 1-100; default 50, matching VGC play. | |
| boosts | No | Stat stages; only `spe` (-6..+6) is applied, e.g. { spe: 1 } for a +1 Speed stage. | |
| nature | No | Nature name, e.g. "Jolly", "Timid"; default Serious (neutral Speed). | |
| species | Yes | Species or form name, e.g. "Dragapult", "Ogerpon-Wellspring". | |
| regulation | No | Regulation Set name or id from `list_regulations` to compare against, e.g. "Regulation Set G"; omit to get the raw Speed only. | |
| championsPoints | No | The same Speed investment in Pokémon Champions stat points, e.g. { spe: 32 } for a maxed Speed stat; give this or `evs`, not both. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| evSpe | Yes | Speed EVs invested, 0-252. | |
| ivSpe | Yes | Speed IV used, 0-31. | |
| level | Yes | Level the Speed was computed at, 1-100. | |
| nature | Yes | Nature applied Speed, e.g. "Jolly" for +Spe; Serious when the call omitted one. | |
| baseSpe | Yes | The species’ base Speed stat, before level, IVs, EVs, nature, item, and boosts. | |
| species | Yes | Canonical species name the Speed belongs to, e.g. "Dragapult". | |
| modifiers | Yes | Human-readable list of everything that changed the Speed stat, e.g. ["Speed stage +1", "Choice Scarf x1.5"]; a speed-neutral item is noted here too, and the list is empty when nothing applied. | |
| comparison | No | Present only when `regulation` was supplied: how this Speed places against that roster, whose threat lists are each capped at 15 entries. | |
| finalSpeed | Yes | The final Speed stat after level, IVs, EVs, nature, Speed stage, and item; this is the number turn order compares. |