Starphone API Documentation

Welcome to the developer hub for Starphone. Access our public endpoints, integrate with our sensor network, or just play with the parrot.

Base URL

https://www.thestarphone.com/api

Endpoints

Health Check

GET /health

Returns the current status, uptime, and version of the API.

{
  "status": "ok",
  "uptime": 1234.56,
  "timestamp": "2023-10-27T10:00:00Z",
  "version": "2.0.0",
  "message": "Starphone API is operational"
}

Party Parrot

GET /parrot

Returns a frame of the party parrot animation or signal strength visualization.

Parameters:

  • frame (optional): Index of the frame (0-9).
  • mode (optional): Set to signal for signal strength bars.

Example:

GET /api/parrot?mode=signal

Sensor Data (Internal)

POST /sensor-data

Ingests telemetry from Starphone booths. Requires authentication.

SEO & Metadata

We provide standard files for bots and LLMs:

JSON-LD Schema

All pages include structured data for Organization, WebSite, and BreadcrumbList to enhance search visibility.

💝 Donate