Xplorer API

The Xplorer API feeds Xplorer with data about planets, galaxies, and planetary systems.

This API contains information about confirmed and unconfirmed planets. The data is open source, meaning that anyone can contribute to the data in case there is something that is not correct or needs to be improved.

Table of Contents

• Usage
• Using the JSON files directly
• Using the API directly from the NPM package
• API Content
• Images
• Contributing
• License

Usage

The easiest way to use the API is to use the Xplorer API directly.

Example

curl https://api.xplorerapp.net/planets.json

Using the JSON files directly

The JSON files are available in the public directory.

Feel free to use the JSON files directly in your projects so you don't depend on any external API.

The downside of using the JSON files directly is that you will need to update the data manually.

Using the API directly from the NPM package

Installation

npm install xplorer-static-api

Using the package

import { planets, galaxies, planetarySystems } from 'xplorer-static-api';

console.log({ planets, galaxies, planetarySystems });

API Content

The API contains the following data:

• Planets: Information about confirmed and unconfirmed planets.
• Galaxies: Information about galaxies.
• Planetary Systems: Information about planetary systems.

Images

All the planets have an image associated with them. You can find the images in the public/images directory.

If you are using the JSON directly, you might need to download the images and serve them from your server as well.

Contributing

If you want to contribute to the data, you can do so by submitting a pull request to the repository. The easiest way to contribute is to edit the JSON files directly using the GitHub interface.

Examples of contributions include:

• Adding new planets, galaxies, or planetary systems.
• Fixing incorrect data.
• Adding images for planets.

If you are not sure but want to contribute, feel free to open an issue to discuss your ideas.

Do you want to help with code? See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

Please leave a ⭐️ if you like this project! There is no better way to show your appreciation. 🚀