pokeapi_client

PokeApiClient - the Ruby gem for the PokéAPI

All the Pokémon data you'll ever need in one place, easily accessible through a modern free open-source RESTful API.

What is this?

This is a full RESTful API linked to an extensive database detailing everything about the Pokémon main game series.

We've covered everything from Pokémon to Berry Flavors.

Where do I start?

We have awesome documentation on how to use this API. It takes minutes to get started.

This API will always be publicly available and will never require any extensive setup process to consume.

Created by [Paul Hallett(]https://github.com/phalt) and other PokéAPI contributors* around the world. Pokémon and Pokémon character names are trademarks of Nintendo.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 2.7.0
  • Package version: 2.1.0
  • Generator version: 7.24.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://github.com/oapicf/pokeapi-clients

Installation

Build a gem

To build the Ruby code into a gem:

gem build pokeapi_client.gemspec

Then either install the gem locally:

gem install ./pokeapi_client-2.1.0.gem

(for development, run gem install --dev ./pokeapi_client-2.1.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'pokeapi_client', '~> 2.1.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'pokeapi_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'pokeapi_client'

# Setup authorization
PokeApiClient.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR_USERNAME'
  config.password = 'YOUR_PASSWORD'

  # Configure API key authorization: cookieAuth
  config.api_key['sessionid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['sessionid'] = 'Bearer'
end

api_instance = PokeApiClient::BerriesApi.new
opts = {
  limit: 56, # Integer | Number of results to return per page.
  offset: 56, # Integer | The initial index from which to return the results.
  q: 'q_example' # String | > Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) Case-insensitive query applied on the `name` property. 
}

begin
  #List berry firmness
  result = api_instance.berry_firmness_list(opts)
  p result
rescue PokeApiClient::ApiError => e
  puts "Exception when calling BerriesApi->berry_firmness_list: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://pokeapi.co

Class Method HTTP request Description
PokeApiClient::BerriesApi berry_firmness_list GET /api/v2/berry-firmness/ List berry firmness
PokeApiClient::BerriesApi berry_firmness_retrieve GET /api/v2/berry-firmness/id/ Get berry by firmness
PokeApiClient::BerriesApi berry_flavor_list GET /api/v2/berry-flavor/ List berry flavors
PokeApiClient::BerriesApi berry_flavor_retrieve GET /api/v2/berry-flavor/id/ Get berries by flavor
PokeApiClient::BerriesApi berry_list GET /api/v2/berry/ List berries
PokeApiClient::BerriesApi berry_retrieve GET /api/v2/berry/id/ Get a berry
PokeApiClient::ContestsApi contest_effect_list GET /api/v2/contest-effect/ List contest effects
PokeApiClient::ContestsApi contest_effect_retrieve GET /api/v2/contest-effect/id/ Get contest effect
PokeApiClient::ContestsApi contest_type_list GET /api/v2/contest-type/ List contest types
PokeApiClient::ContestsApi contest_type_retrieve GET /api/v2/contest-type/id/ Get contest type
PokeApiClient::ContestsApi super_contest_effect_list GET /api/v2/super-contest-effect/ List super contest effects
PokeApiClient::ContestsApi super_contest_effect_retrieve GET /api/v2/super-contest-effect/id/ Get super contest effect
PokeApiClient::EncountersApi encounter_condition_list GET /api/v2/encounter-condition/ List encounter conditions
PokeApiClient::EncountersApi encounter_condition_retrieve GET /api/v2/encounter-condition/id/ Get encounter condition
PokeApiClient::EncountersApi encounter_condition_value_list GET /api/v2/encounter-condition-value/ List encounter condition values
PokeApiClient::EncountersApi encounter_condition_value_retrieve GET /api/v2/encounter-condition-value/id/ Get encounter condition value
PokeApiClient::EncountersApi encounter_method_list GET /api/v2/encounter-method/ List encounter methods
PokeApiClient::EncountersApi encounter_method_retrieve GET /api/v2/encounter-method/id/ Get encounter method
PokeApiClient::EvolutionApi evolution_chain_list GET /api/v2/evolution-chain/ List evolution chains
PokeApiClient::EvolutionApi evolution_chain_retrieve GET /api/v2/evolution-chain/id/ Get evolution chain
PokeApiClient::EvolutionApi evolution_trigger_list GET /api/v2/evolution-trigger/ List evolution triggers
PokeApiClient::EvolutionApi evolution_trigger_retrieve GET /api/v2/evolution-trigger/id/ Get evolution trigger
PokeApiClient::GamesApi generation_list GET /api/v2/generation/ List genrations
PokeApiClient::GamesApi generation_retrieve GET /api/v2/generation/id/ Get genration
PokeApiClient::GamesApi pokedex_list GET /api/v2/pokedex/ List pokedex
PokeApiClient::GamesApi pokedex_retrieve GET /api/v2/pokedex/id/ Get pokedex
PokeApiClient::GamesApi version_group_list GET /api/v2/version-group/ List version groups
PokeApiClient::GamesApi version_group_retrieve GET /api/v2/version-group/id/ Get version group
PokeApiClient::GamesApi version_list GET /api/v2/version/ List versions
PokeApiClient::GamesApi version_retrieve GET /api/v2/version/id/ Get version
PokeApiClient::ItemsApi item_attribute_list GET /api/v2/item-attribute/ List item attributes
PokeApiClient::ItemsApi item_attribute_retrieve GET /api/v2/item-attribute/id/ Get item attribute
PokeApiClient::ItemsApi item_category_list GET /api/v2/item-category/ List item categories
PokeApiClient::ItemsApi item_category_retrieve GET /api/v2/item-category/id/ Get item category
PokeApiClient::ItemsApi item_fling_effect_list GET /api/v2/item-fling-effect/ List item fling effects
PokeApiClient::ItemsApi item_fling_effect_retrieve GET /api/v2/item-fling-effect/id/ Get item fling effect
PokeApiClient::ItemsApi item_list GET /api/v2/item/ List items
PokeApiClient::ItemsApi item_pocket_list GET /api/v2/item-pocket/ List item pockets
PokeApiClient::ItemsApi item_pocket_retrieve GET /api/v2/item-pocket/id/ Get item pocket
PokeApiClient::ItemsApi item_retrieve GET /api/v2/item/id/ Get item
PokeApiClient::LocationApi location_area_list GET /api/v2/location-area/ List location areas
PokeApiClient::LocationApi location_area_retrieve GET /api/v2/location-area/id/ Get location area
PokeApiClient::LocationApi location_list GET /api/v2/location/ List locations
PokeApiClient::LocationApi location_retrieve GET /api/v2/location/id/ Get location
PokeApiClient::LocationApi pal_park_area_list GET /api/v2/pal-park-area/ List pal park areas
PokeApiClient::LocationApi pal_park_area_retrieve GET /api/v2/pal-park-area/id/ Get pal park area
PokeApiClient::LocationApi region_list GET /api/v2/region/ List regions
PokeApiClient::LocationApi region_retrieve GET /api/v2/region/id/ Get region
PokeApiClient::MachinesApi machine_list GET /api/v2/machine/ List machines
PokeApiClient::MachinesApi machine_retrieve GET /api/v2/machine/id/ Get machine
PokeApiClient::MovesApi move_ailment_list GET /api/v2/move-ailment/ List move meta ailments
PokeApiClient::MovesApi move_ailment_retrieve GET /api/v2/move-ailment/id/ Get move meta ailment
PokeApiClient::MovesApi move_battle_style_list GET /api/v2/move-battle-style/ List move battle styles
PokeApiClient::MovesApi move_battle_style_retrieve GET /api/v2/move-battle-style/id/ Get move battle style
PokeApiClient::MovesApi move_category_list GET /api/v2/move-category/ List move meta categories
PokeApiClient::MovesApi move_category_retrieve GET /api/v2/move-category/id/ Get move meta category
PokeApiClient::MovesApi move_learn_method_list GET /api/v2/move-learn-method/ List move learn methods
PokeApiClient::MovesApi move_learn_method_retrieve GET /api/v2/move-learn-method/id/ Get move learn method
PokeApiClient::MovesApi move_list GET /api/v2/move/ List moves
PokeApiClient::MovesApi move_retrieve GET /api/v2/move/id/ Get move
PokeApiClient::MovesApi move_target_list GET /api/v2/move-target/ List move targets
PokeApiClient::MovesApi move_target_retrieve GET /api/v2/move-target/id/ Get move target
PokeApiClient::PokemonApi ability_list GET /api/v2/ability/
PokeApiClient::PokemonApi ability_retrieve GET /api/v2/ability/id/
PokeApiClient::PokemonApi characteristic_list GET /api/v2/characteristic/ List charecterictics
PokeApiClient::PokemonApi characteristic_retrieve GET /api/v2/characteristic/id/ Get characteristic
PokeApiClient::PokemonApi egg_group_list GET /api/v2/egg-group/ List egg groups
PokeApiClient::PokemonApi egg_group_retrieve GET /api/v2/egg-group/id/ Get egg group
PokeApiClient::PokemonApi gender_list GET /api/v2/gender/ List genders
PokeApiClient::PokemonApi gender_retrieve GET /api/v2/gender/id/ Get gender
PokeApiClient::PokemonApi growth_rate_list GET /api/v2/growth-rate/ List growth rates
PokeApiClient::PokemonApi growth_rate_retrieve GET /api/v2/growth-rate/id/ Get growth rate
PokeApiClient::PokemonApi move_damage_class_list GET /api/v2/move-damage-class/ List move damage classes
PokeApiClient::PokemonApi move_damage_class_retrieve GET /api/v2/move-damage-class/id/ Get move damage class
PokeApiClient::PokemonApi nature_list GET /api/v2/nature/ List natures
PokeApiClient::PokemonApi nature_retrieve GET /api/v2/nature/id/ Get nature
PokeApiClient::PokemonApi pokeathlon_stat_list GET /api/v2/pokeathlon-stat/ List pokeathlon stats
PokeApiClient::PokemonApi pokeathlon_stat_retrieve GET /api/v2/pokeathlon-stat/id/ Get pokeathlon stat
PokeApiClient::PokemonApi pokemon_color_list GET /api/v2/pokemon-color/ List pokemon colors
PokeApiClient::PokemonApi pokemon_color_retrieve GET /api/v2/pokemon-color/id/ Get pokemon color
PokeApiClient::PokemonApi pokemon_form_list GET /api/v2/pokemon-form/ List pokemon forms
PokeApiClient::PokemonApi pokemon_form_retrieve GET /api/v2/pokemon-form/id/ Get pokemon form
PokeApiClient::PokemonApi pokemon_habitat_list GET /api/v2/pokemon-habitat/ List pokemom habitas
PokeApiClient::PokemonApi pokemon_habitat_retrieve GET /api/v2/pokemon-habitat/id/ Get pokemom habita
PokeApiClient::PokemonApi pokemon_list GET /api/v2/pokemon/ List pokemon
PokeApiClient::PokemonApi pokemon_retrieve GET /api/v2/pokemon/id/ Get pokemon
PokeApiClient::PokemonApi pokemon_shape_list GET /api/v2/pokemon-shape/ List pokemon shapes
PokeApiClient::PokemonApi pokemon_shape_retrieve GET /api/v2/pokemon-shape/id/ Get pokemon shape
PokeApiClient::PokemonApi pokemon_species_list GET /api/v2/pokemon-species/ List pokemon species
PokeApiClient::PokemonApi pokemon_species_retrieve GET /api/v2/pokemon-species/id/ Get pokemon species
PokeApiClient::PokemonApi stat_list GET /api/v2/stat/ List stats
PokeApiClient::PokemonApi stat_retrieve GET /api/v2/stat/id/ Get stat
PokeApiClient::PokemonApi type_list GET /api/v2/type/ List types
PokeApiClient::PokemonApi type_retrieve GET /api/v2/type/id/ Get types
PokeApiClient::UtilityApi language_list GET /api/v2/language/ List languages
PokeApiClient::UtilityApi language_retrieve GET /api/v2/language/id/ Get language

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

basicAuth

  • Type: HTTP basic authentication

cookieAuth

  • Type: API key
  • API key parameter name: sessionid
  • Location: