🔎

    Endpoints

    Swagger Doc

    Access Tokens

    EndpointDescription
    POST /v1/access_tokensCreates a new access token
    POST /v1/access_tokens/deleteRequests an access token deletion
    DELETE /v1/access_tokensDeletes an access token

    HM Moves

    EndpointDescription
    GET /v1/hms/movesGets a list of HM moves
    GET /v1/hms/moves/:hm_idGets a HM move
    POST /v1/hms/moves/:hm_idUpdates a HM move

    HM Names

    EndpointDescription
    GET /v1/hms/namesGets a list of HM names
    GET /v1/hms/names/:hm_idGets a HM name

    Icons

    EndpointDescription
    GET /v1/icons/:icon_idGets an icon

    Imgs

    EndpointDescription
    GET /v1/imgs/game_boyGets the Game Boy image
    GET /v1/imgs/pokemon_logoGets the Pokémon logo
    POST /v1/imgs/pokemon_logoUpdates the Pokémon logo
    GET /v1/imgs/town_mapGets the town map

    Item Names

    EndpointDescription
    GET /v1/items/namesGets a list of item names
    GET /v1/items/names/:item_idGets an item's name
    POST /v1/items/names/:item_idUpdates an item's name

    Map Pics

    EndpointDescription
    GET /v1/maps/pics/:map_idGets a map pic

    Map Pokémon

    EndpointDescription
    GET /v1/maps/pokemonGets a list of map Pokémon
    GET /v1/maps/pokemon/:map_idGets a map's Pokémon
    POST /v1/maps/pokemon/:map_idUpdates a map's Pokémon

    Mart Items

    EndpointDescription
    GET /v1/mart/itemsGets a list of mart items
    GET /v1/mart/items/:mart_idGets a mart's items
    POST /v1/mart/items/:mart_idUpdates a mart's items

    Move Names

    EndpointDescription
    GET /v1/moves/namesGets a list of move names
    GET /v1/moves/names/:move_idGets a move name
    POST /v1/moves/names/:move_idUpdates a move name

    Move Stats

    EndpointDescription
    GET /v1/moves/statsGets a list of move stats
    GET /v1/moves/stats/:move_idGets a move's stats
    POST /v1/moves/stats/:move_idUpdates a move's stats

    Player Names

    EndpointDescription
    GET /v1/player_namesGets default player names
    POST /v1/player_namesUpdates default player names

    Pokédex Entries

    EndpointDescription
    GET /v1/pokedex/entriesGets a list of Pokédex entries
    GET /v1/pokedex/entries/:pokedex_idGets a Pokédex entry
    POST /v1/pokedex/entries/:pokedex_idUpdates a Pokédex entry

    Pokédex Texts

    EndpointDescription
    GET /v1/pokedex/textsGets a list of Pokédex texts
    GET /v1/pokedex/texts/:pokedex_idGets a Pokédex text
    POST /v1/pokedex/texts/:pokedex_idUpdates a Pokédex text

    Pokémon Cries

    EndpointDescription
    GET /v1/pokemon/criesGets a list of Pokémon cries
    GET /v1/pokemon/cries/:pokedex_idGets a Pokémon's cry
    POST /v1/pokemon/cries/:pokedex_idUpdates a Pokémon's cry

    Pokémon Evolutions

    EndpointDescription
    GET /v1/pokemon/evolutionsGets a list of Pokémon evolutions
    GET /v1/pokemon/evolutions/:pokedex_idGets a Pokémon's evolutions
    POST /v1/pokemon/evolutions/:pokedex_idUpdates a Pokémon's evolutions

    Pokémon Icons

    EndpointDescription
    GET /v1/pokemon/iconsGets a list of Pokémon icons
    GET /v1/pokemon/icons/:pokedex_idGets a Pokémon's icon
    POST /v1/pokemon/icons/:pokedex_idUpdates a Pokémon's icon

    Pokémon Learnset

    EndpointDescription
    GET /v1/pokemon/learnsetsGets a list of Pokémon learnsets
    GET /v1/pokemon/learnsets/:pokedex_idGets a Pokémon's learnset
    POST /v1/pokemon/learnsets/:pokedex_idUpdates a Pokémon's learnset

    Pokémon Machines

    EndpointDescription
    GET /v1/pokemon/machinesGets a list of Pokémon machines
    GET /v1/pokemon/machines/:pokedex_idGets a Pokémon's machines
    POST /v1/pokemon/machines/:pokedex_idUpdates a Pokémon's machines

    Pokémon Moveset

    EndpointDescription
    GET /v1/pokemon/movesetsGets a list of Pokémon movesets
    GET /v1/pokemon/movesets/:pokedex_idGets a Pokémon's moveset
    POST /v1/pokemon/movesets/:pokedex_idUpdates a Pokémon's moveset

    Pokémon Names

    EndpointDescription
    GET /v1/pokemon/namesGets a list of Pokémon name
    GET /v1/pokemon/names/:pokedex_idGets a Pokémon's name
    POST /v1/pokemon/names/:pokedex_idUpdates a Pokémon's name

    Pokémon Pics

    EndpointDescription
    GET /v1/pokemon/pics/:pokedex_idGets a Pokémon's pic
    POST /v1/pokemon/pics/:pokedex_idUpdates a Pokémon's pic

    Pokémon Stats

    EndpointDescription
    GET /v1/pokemon/statsGets a list of Pokémon stats
    GET /v1/pokemon/stats/:pokedex_idGets a Pokémon's stats
    POST /v1/pokemon/stats/:pokedex_idUpdates a Pokémon's stats

    ROM Patches

    EndpointDescription
    GET /v1/roms/patchesGets a list of ROM patches
    GET /v1/roms/patches/:patch_idGets a ROM patch
    DELETE /v1/roms/patches/:patch_idDeletes a ROM patch

    ROMs

    EndpointDescription
    POST /v1/romsUpload a ROM
    GET /v1/romsGet ROM
    DELETE /v1/romsDelete ROM

    SAV Player Names

    EndpointDescription
    GET /v1/savs/player_namesGets saved player name
    POST /v1/savs/player_namesUpdates saved player name

    SAVs

    EndpointDescription
    POST /v1/savsUpload a SAV
    GET /v1/savsGet SAV
    DELETE /v1/savsDelete SAV

    Status

    EndpointDescription
    GET /statusGet API status

    TM Moves

    EndpointDescription
    GET /v1/tms/movesGets a list of TM moves
    GET /v1/tms/moves/:tm_idGets a TM's move
    POST /v1/tms/moves/:tm_idUpdates a TM's move

    TM Names

    EndpointDescription
    GET /v1/tms/namesGets a list of TM names
    GET /v1/tms/names/:tm_idGets a TM name

    TM Prices

    EndpointDescription
    GET /v1/tms/pricesGets a list of TM prices
    GET /v1/tms/prices/:tm_idGets a TM's price
    POST /v1/tms/prices/:tm_idUpdates a TM's price

    Trades

    EndpointDescription
    GET /v1/tradesGets a list of trades
    GET /v1/trades/:trade_idGets a trade
    POST /v1/trades/:trade_idUpdates a trade

    Trainer Names

    EndpointDescription
    GET /v1/trainers/namesGets a list of trainer names
    GET /v1/trainers/names/:trainer_idGets a trainer's name
    POST /v1/trainers/names/:trainer_idUpdates a trainer's name

    Trainer Parties

    EndpointDescription
    GET /v1/trainers/partiesGets a list of trainer parties
    GET /v1/trainers/parties/:trainer_idGets a trainer's parties
    POST /v1/trainers/parties/:trainer_idUpdates a trainer's parties

    Trainer Pics

    EndpointDescription
    GET /v1/trainers/pics/:trainer_idGets a trainer's pic
    POST /v1/trainers/pics/:trainer_idUpdates a trainer's pic

    Trainer Rewards

    EndpointDescription
    GET /v1/trainers/rewardsGets a list of trainer rewards
    GET /v1/trainers/rewards/:trainer_idGets a trainer's reward
    POST /v1/trainers/rewards/:trainer_idUpdates a trainer's reward

    Type Effects

    EndpointDescription
    GET /v1/types/effectsGets a list of type effects
    GET /v1/types/effects/:type_effect_idGets a type effect
    POST /v1/types/effects/:type_effect_idUpdates a type effect

    Type Names

    EndpointDescription
    GET /v1/types/namesGets a list of type names
    GET /v1/types/names/:type_idGets a type name
    POST /v1/types/names/:type_idUpdates a type name