NewCraftRank SitesA free website and storeMake yours ›
1.10.41CraftRank Launcher is out Download ›AshlarFree server software built on Paper, with DDoS and backdoor protection See Ashlar ›Server ownersYour own launcher with your name, logo and one click onto your server See themes ›
Docs / Developers

API overview

2 min read

The CraftRank API is a free, read-only JSON API for server owners, plugin authors and website builders. Public data needs no key. The full reference with live examples is on the API for developers page.

Base URL

https://craftrank.org/api/v1

All endpoints use GET. Public endpoints can be called from JavaScript on any website.

/servers/{id}One server: status, players, rank, votes. Details
/topThe current ranking
/statsTotals for the whole list
/awardsMonthly winners
/servers/{id}/votedHas a player voted? Details
/servers/{id}/votesYour vote list (needs a key)

The server ID is in the server page address (/server/12-name) and in your dashboard.

API keys

Only the vote list needs a key. Each server has its own. Open your server's Plugin & API page in the dashboard and press Create API key. Create a new key replaces it, and the old one stops working at once. The CraftRank plugin uses the same key.

Caching and rate limits

Public responses are cached for 30 seconds and /stats is updated every minute, so polling faster brings nothing new. Please do not poll more than once a minute per server. Vote checks and the vote list are never cached. Too many requests from one address are slowed down.

Response format

Responses are UTF-8 JSON. Dates are ISO 8601 with a time zone (2026-10-12T19:59:54+00:00); the vote list also gives Unix timestamps in seconds.

Errors

Errors use normal HTTP status codes and a JSON body:

{ "error": "not_found", "message": "No live server with this ID." }
400A bad parameter, for example bad_username
401bad_key: the API key is missing or wrong
404not_found: no live server with this ID, or no such endpoint