Skip to content

Pokédex Meta Resource#

Get Pokédex API Information#

GET /info

Returns basic information about the Pokédex API containing the base URL, resources URL, available versions, etc.

Note

This endpoint doesn’t work with versioning. You should access this endpoint directly from the base URL.

Example Request#

1
2
3
curl -i -X GET \
  -H "User-Agent: BastionDiscordBot (https://bastionbot.org, v6.3)" \
  https://pokeapi.bastionbot.org/info

Example Response#

1
2
3
4
5
6
7
8
9
{
  "title": "Pokédex API",
  "baseURL": "https://pokeapi.bastionbot.org",
  "resourcesURL": "https://pokeres.bastionbot.org",
  "versions": [
    "/v1"
  ],
  "author": "Sankarsan Kampa"
}
Pokédex API Info Structure
Field Type Description
title string The name the API
baseURL string The base URL of the Pokédex API for requesting resources
resourcesURL string The base URL of the image (and other) resources required by the Pokédex API
versions array of strings Available versions of the Pokédex API
author string The author/developer of the Pokédex API

Get Pokédex API Statistics#

GET /stats

Returns basic statistics of the Pokédex API containing the total number of API calls, number of API calls since last restart and uptime of the API server.

Note

This endpoint doesn’t work with versioning. You should access this endpoint directly from the base URL.

Example Request#

1
2
3
curl -i -X GET \
  -H "User-Agent: BastionDiscordBot (https://bastionbot.org, v6.3)" \
  https://pokeapi.bastionbot.org/stats

Example Response#

1
2
3
4
5
{
  "total_hits": "1337",
  "session_hits": "201",
  "uptime": 658
}
Pokédex API Stats Structure
Field Type Description
total_hits string Total number of API calls made to Pokédex API. *Note that this is not accurate because currently the API is hosted in Heroku, which restarts frequently. I'll host the API in a dedicated server if I get enough resources to do so. So, if you like this project, please consider donating via [PayPal](https://paypal.me/snkrsnkampa).*
session_hits string Number of API calls made to Pokédex API since last restart
uptime number Number of seconds elapsed since Pokédex API server was booted