Skip to content

Pokemon-3D-api/api-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 

Pokémon 3D API — Server Engine

Welcome to the core RESTful engine for the Pokémon 3D API. This repository handles the backend logic and JSON delivery that powers 3D Pokémon integration in modern web applications.

Looking for the 3D Models? Visit the Assets Repository for raw files and model counts.

See it in action! Live App 1 Live App 2


Table of Contents


Features

  • Access a JSON API for retrieving optimized Pokémon 3D model URLs.
  • Seamless integration with Google's <model-viewer>.
  • High-performance metadata delivery with Node-Cache.

Using the API

To fetch data, consult the Postman.

JSON Response Structure

The API returns an array of Pokémon objects. Each object contains an id and an array of forms.

{
  "pokemon": [
    {
      "id": 1,
      "forms": [
        {
          "name": "Bulbasaur",
          "model": "https://raw.githubusercontent.com/Pokemon-3D-api/assets/refs/heads/main/heads/main/models/opt/regular/1.glb",
          "formName": "regular"
        },
        {
          "name": "Shiny Bulbasaur",
          "model": "https://raw.githubusercontent.com/Pokemon-3D-api/assets/refs/heads/main/models/opt/shiny/1.glb",
          "formName": "shiny"
        }
      ]
    },
  // ... more Pokémon objects
]

API Endpoint

https://pokemon-3d-api.onrender.com/v1/pokemon

Example Usage (JavaScript)

fetch('https://pokemon-3d-api.onrender.com/v1/pokemon')
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

Note About APIs

While there are many Pokémon APIs available that provide Pokémon data (e.g., stats, types, moves, etc.), most of these APIs do not offer 3D models of Pokémon. This is primarily due to the significant storage and bandwidth requirements for hosting and serving 3D models, as well as potential licensing issues. Existing APIs like PokéAPI are excellent resources for general Pokémon information, but they do not include 3D models.

Credits

Check Credits for a list of contributors and resources used in this project. This project is a community-driven effort to provide a comprehensive and accessible 3D model database for Pokémon. We appreciate the contributions of everyone who has helped make this project a reality. If you have any questions or would like to contribute, please don't hesitate to reach out. We're always happy to help and appreciate any assistance you can provide. Thank you for your interest in this project!

License

This project is open source and available under the License for all versions up to GitHub Tag

Legal Notice

For more information about the legal considerations related to this project, please see the Copyright file.

The Pokémon3D project community

Join our Discord: Join us on Discord

Don't just clone 🤖 it, also star 🌟 it!