Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Purukitto/PikaServe
A simple to use Pokemon API endpoint that returns Pokemon Data in JSON format.
https://github.com/Purukitto/PikaServe
complete-pokemon-database database hacktoberfest pokedex pokemon pokemon-api random-pokemon random-retrives rate-limits wiki
Last synced: about 2 months ago
JSON representation
A simple to use Pokemon API endpoint that returns Pokemon Data in JSON format.
- Host: GitHub
- URL: https://github.com/Purukitto/PikaServe
- Owner: Purukitto
- License: gpl-3.0
- Created: 2020-09-07T05:18:14.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T23:46:11.000Z (about 1 year ago)
- Last Synced: 2024-07-28T21:37:41.556Z (about 2 months ago)
- Topics: complete-pokemon-database, database, hacktoberfest, pokedex, pokemon, pokemon-api, random-pokemon, random-retrives, rate-limits, wiki
- Language: JavaScript
- Homepage: https://purukitto.github.io/PikaServe
- Size: 3.51 MB
- Stars: 21
- Watchers: 3
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: Contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome-pokemon - pokemon-API - Beginner friendly API endpoint that returns Pokémon Data in JSON format (https://app.pokemon-api.xyz). (Development Projects)
README
PikaServe is a simple to use, no bull-sh*t API endpoint to query data available in [pokedex-data.json](https://github.com/Purukitto/pokemon-data.json)
~It can be currently queried at https://api.pikaserve.xyz/~ **Server down until further notice**
#### Use self hosting guide (below) to continue using the endpoints
[](https://purukitto.github.io/PikaServe/)
[](https://github.com/Purukitto/PikaServe/issues)
[](https://github.com/Purukitto/PikaServe/blob/master/LICENSE.md)
## API Usage
### Get started by getting a random Pokemon!
Using the language / framework of your choice:
- Load [https://api.pikaserve.xyz/pokemon/random](https://api.pikaserve.xyz/pokemon/random)
- Parse the response body
- Load it's the required parameters (e.g. `body.id` or `body.name.english`)
Please visit the [Wiki](https://purukitto.github.io/PikaServe/) for more information and different endpoints
## Why?
There are hundred's of pokemon APIs already, with 20,000 ways to use and god knows how much incomprehensible data. This projects aim is to be as simple and straightforward to use as possible. I have a self collected, independent and unique database, which means I have complete control on every step on interaction. Simple enough to be used, forked, edited and self-hosted as per personal preferences, I am are sure this API is for someone out there.
### `Active Development Goals`
- [X] POST queries
- [X] Change host and move to custom DNS (v1)
- [X] Wiki
- [X] Add Usage Examples (Needs contribution)
- [X] Node.js
- [X] Python
- [X] Implement basic rate limits (For DDoS protection)
- [X] Implement dark/light theme for website
- [ ] **[WIP]** FrontEnd Panel
- [ ] Show closest match suggestions
- [ ] Develop interactions with the different queries
- [ ] Update [database](https://github.com/Purukitto/pokemon-data.json) to include Gen 8 (Looking for contributors)
## Self host
Why to self host?
- You might want to add or modify some endpoints for your specific use case.
- Biggest advantage will be low latency and you can freely remove the rate limits
### Steps for self hosting
- Download the release .rar from this [link](https://drive.google.com/drive/folders/1uoYEMtLcPNEq_rI7MsCsSzIpu9vO405F?usp=sharing)
##### Download the lastest release or any other specefic release (upwards of v1.1.2). See [Version History](/versionHistory.md) for changes.
- Export the .rar you downloaded using your software of choice
- Open the terminal in the exported folder or navigate to the folder in the terminal or IDE of your choice
- Use `npm install` and wait for the dependencies to install
- Then do `npm start` and wait for the script to run
- Done, now you can query the code on http://localhost:3000/ (http://localhost:3000/pokemon/random)
#### To remove/edit rate limiting on self hosted release
- Open `app.js` with the editor of your choice
- Find the `// RATE LIMITING START` section
- Edit the values to your requirement
- To completely remove the rate limiting, simply comment out code section between `// RATE LIMITING START` and `// RATE LIMITING END`
## Contributing
### How to Contribute?
* Make sure that your changes do not conflict with the core files (changing file directories will require a change in all called paths)
* Follow the original code structure
* Refactoring contributions are welcome, explicitly mention "[Refactor]" in your pull request
* Give a few days to review PRs, code reviews are welcome
See [Contributing.md](/Contributing.md) for more details
## License
[GNU GPLv3](https://github.com/Purukitto/PikaServe/blob/master/LICENSE) © Pulkit Sambhavi Singh (https://github.com/Purukitto/)
##### This project was made for educational purposes, do consider supporting development by contributing or donating if you like the project
##### Pokémon and Pokémon character names are trademarks of Nintendo and The Pokémon Company.