MudVerse API

Build with MudVerse's directory, ranking, review, connection, MSSP, and player-history data. API v1 is a read-only JSON API intended for server-to-server use.

Get an API key Read the API reference OpenAPI 3.1 document

What you can build

Discover games

Search and filter active games, browse new or recently updated listings, and sort by votes or reviews. Archived listings remain available by direct ID.

Show useful details

Retrieve descriptions, connection settings, URLs, review summaries, rankings, tags, and online status.

Analyze crawler data

Read the latest normalized MSSP snapshot and chronological raw or daily player-count samples.

Get started

  1. Create an account or sign in. Open the API tab on your account.
  2. Generate your single API key. Copy it when it is shown; MudVerse stores only a secure digest and cannot display it again.
  3. Send it as a Bearer token. Make your first request to the production base URL shown below.

Base URL: https://www.mudverse.com/api/v1

curl --request GET \
  --url 'https://www.mudverse.com/api/v1/games?sort=top_voted&per_page=5' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'
Protect your key. Never put it in a URL, browser-side JavaScript, a public repository, or a support message. Replace the key from your account if it may have been exposed.

Authentication, limits, and usage

Every endpoint requires an API key in the Authorization: Bearer YOUR_API_KEY header. Browser cross-origin access is not enabled, so requests should originate from your server.

New keys currently receive limits of 60 requests per minute and 10,000 requests per UTC day. After successful authentication and rate-limit accounting, responses include X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and X-Request-ID. A limited request returns HTTP 429 and a Retry-After header.

MudVerse keeps daily per-key usage totals for operations and abuse prevention. In the account API console, you can inspect the current minute and UTC-day budgets with their reset times, review daily usage history, replace or revoke your key, and try safe read-only queries.

Explore the API

The complete API v1 reference documents every endpoint, parameter, response shape, status code, and curl example. Tooling can consume the OpenAPI 3.1 document.

  • GET /games — search, filter, and sort games
  • GET /games/{gameId} — retrieve one game's full details
  • GET /games/{gameId}/mssp — retrieve its latest MSSP snapshot
  • GET /games/{gameId}/players — retrieve player-count history
  • GET /tags — retrieve filterable tag groups and values