👷 PicelBoi

The site about whatever I do.

PicelAPI Documentation

Locally sourced!

This covers how to use my public API.


Is Kaerutomo Up?
  • What is PicelAPI?

    A set of endpoints I allow the public to use.

  • Why?

    Because I think the public may benefit from this.

  • Terms Of Usage?

    Covered here.
  • Usage Guidelines

    • User-Agent doesn't exactly matter, but if you can, please set such User-Agent!
    • An API Key system might be implemented in the future.
  • Fun Fact

    This is running on a Libre Computing Renegade with 4GBs of RAM.

List of Endpoints

  • Kaerutomo

    Kaerutomo-related endpoints.


    • Kaerutomo Status Checker (https://picelboi.xyz/api/miitomo_up)

      Reports the status of the Kaerutomo servers provided by Kaeru Team based on the endpoint used to grab player Mii data. Responds with a JSON response. Doesn't check if any other part of the service is up.

      Definitions

      • message

        A status message. Is a string.

        Example: Kaerutomo is fully functional! (or really, the part that deals with grabbing Mii data...) For more information, check out https://iskaerutomoup.picelboi.xyz

      • up

        True if Kaerutomo is up, False if not.

        Example: True

    • Kaerutomo Status Checker (Image) (https://picelboi.xyz/api/miitomo_up_image)

      Reports the status of the Kaerutomo servers provided by Kaeru Team based on the endpoint used to grab player Mii data. Responds with a PNG image file response. Doesn't check if any other part of the service is up.