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/apiEndpoints
Health Check
GET /healthReturns 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 /parrotReturns a frame of the party parrot animation or signal strength visualization.
Parameters:
frame(optional): Index of the frame (0-9).mode(optional): Set tosignalfor signal strength bars.
Example:
GET /api/parrot?mode=signalSensor Data (Internal)
POST /sensor-dataIngests telemetry from Starphone booths. Requires authentication.
SEO & Metadata
We provide standard files for bots and LLMs:
- robots.txt
- sitemap.xml
- llms.txt (Project Context)
- llms-full.txt (Full Documentation)
JSON-LD Schema
All pages include structured data for Organization, WebSite, and BreadcrumbList to enhance search visibility.