Mudhaven Developer Platform
Connect your world.
Report live game activity, read hosting-area weather notices, and publish standards-friendly world information through small, versioned APIs built for MUD and BYOND servers.
- Current version
- v1
- Base URL
https://mudhaven.net/api/v1- Response format
- JSON
- Transport
- HTTPS only
Choose an integration
Three APIs, one narrow purpose each.
Mudhaven does not ask for game databases, player identities, chat, saves, or remote-control access. Each endpoint accepts or returns only the public facts needed for its job.
MUD Game API
Report status, player counts, uptime, versions, world totals, protocol support, and approved custom facts.
/mud/worlds/{endpoint-key}/heartbeat
Read the MUD guide →
POST
BYOND hosting
BYOND Game API
Send a current project heartbeat from Dream Maker or another server-side integration.
/byond/projects/{project-key}/heartbeat
Read the BYOND guide →
GET
Public feed
Weather Alerts API
Read public-safe weather messaging for Mudhaven's hosting area and announce each new revision once.
/weather/alerts
Read the weather guide →
Heartbeat tokens stay in private game configuration and never belong in downloadable source or client code.
Heartbeat updates replace the previous snapshot instead of producing an unlimited reporting history.
Unknown fields are rejected, custom fields must be configured first, and private player data is prohibited.
Offline and stale states come from receipt age; a game cannot falsely submit an offline claim for another service.
Authentication boundary
Documentation is public. Controls are not.
Anyone may read these contracts. Creating or rotating a heartbeat token still requires the verified owner of an approved, active hosting service.