Endpoints

This guide will assist you in setting up the Bootprint API. We’ll cover how to get started on making your first API request, what endpoints are available, and how to handle responses.

Random Image & Fact

The Random Image & Fact endpoint allows you to request a random image URL and a fact for a specific celestial object. The API will return a JSON object containing the image URL and a fact, which can be used directly in your applications.

Endpoint

GET /all

Base URL

https://api.bootprint.space/all

Example Request

curl -X GET "https://api.bootprint.space/all/mars"

fetch('https://api.bootprint.space/all/mars')
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

import requests
 
response = requests.get('https://api.bootprint.space/all/mars')
data = response.json()
print(data)

Parameters

Example Response

{
  "object": "mars",
  "image": "https://cdn.bootprint.space/mars/1.png",
  "image_id": "c3a1f9a7-29e4-4f91-9f1c-7d2e987f8d7d",
  "fact": "Mars is home to the tallest mountain in the solar system.",
  "fact_id": "e8b4b024-52b7-4d1c-b64b-329d6c0f3f0e"
}

Random Image

The Random Image endpoint allows you to request only a random image URL for a specific celestial object.

Endpoint

GET /img

Base URL

https://api.bootprint.space/img

Example Request

curl -X GET "https://api.bootprint.space/img/mars"

Example Response

{
  "object": "mars",
  "image": "https://cdn.bootprint.space/mars/1.png",
  "image_id": "c3a1f9a7-29e4-4f91-9f1c-7d2e987f8d7d"
}

Random Fact

The Random Fact endpoint allows you to request only a random fact for a specific celestial object.

Endpoint

GET /fact

Base URL

https://api.bootprint.space/fact

Example Request

curl -X GET "https://api.bootprint.space/fact/mars"

Example Response

{
  "object": "mars",
  "fact": "Mars is home to the tallest mountain in the solar system.",
  "fact_id": "e8b4b024-52b7-4d1c-b64b-329d6c0f3f0e"
}

Error Responses

If the request is invalid or the object is not supported, the API will return an error message.

Example Error Response

{
  "error": "Invalid object name. Please provide a valid celestial object."
}

Rate Limiting

The Bootprint API currently does not impose strict rate limits. However, please be mindful of excessive requests to ensure fair usage for all users.

For updates, please check our Discord server or follow our GitHub repository.

If you’d like to contribute or suggest new features, feel free to submit a pull request on our GitHub page.