giodelabarrera / pokedex-api

Pokédex REST API

Pokédex API

Pokédex REST API serving the characters of pokemon.

Getting started

Installation

npm i

Run server

npm start

Now you can make requests to http://localhost:3030

Alternative port

You can start server on other ports with the environment variable:

PORT=3034 npm start

Endpoints

GET /pokemon

Name	Type	Description	Default
query	string	Word to search (Number or Name)
types	string[]	Types
sort	string	Sort	highest_number
limit	number	Number limit for results	12
offset	number	Results page index.	0

Example

/pokemon?query=char&types[]=Fire&sort=lowest_number&limit=12&offset=0

{
  "total": 5,
  "results": [
    {
      "id": 4,
      "name": {
        "english": "Charmander",
        "japanese": "ヒトカゲ",
        "chinese": "小火龙",
        "french": "Salamèche"
      },
      "type": ["Fire"],
      "base": {
        "HP": 39,
        "Attack": 52,
        "Defense": 43,
        "Sp. Attack": 60,
        "Sp. Defense": 50,
        "Speed": 65
      }
    }
  ]
}

GET /pokemon/{id or name}

Example

/pokemon/pikachu or /pokemon/25

{
  "id": 25,
  "name": {
    "english": "Pikachu",
    "japanese": "ピカチュウ",
    "chinese": "皮卡丘",
    "french": "Pikachu"
  },
  "type": ["Electric"],
  "base": {
    "HP": 35,
    "Attack": 55,
    "Defense": 40,
    "Sp. Attack": 50,
    "Sp. Defense": 50,
    "Speed": 90
  }
}

License

MIT © Giorgio de la Barrera