Public API
NodeWorld's web API answers in JSON at https://api.nodeworldvr.com. This documentation covers its public, read-only part: what anyone may read without an account, for a community website, a bot or a status page.
bash
curl https://api.nodeworldvr.com/servers/regionsThe public routes
| To… | Route | Page |
|---|---|---|
| list the servers and their worlds, as Explore shows them | GET /servers, GET /servers/regions | Server list |
| list the published avatars | GET /avatars/catalogue | Avatar catalogue |
| know whether a newer game or game server is out | GET /releases/latest | Update check |
| know whether the API is up | GET /health, GET /health/ready | API status |
Everything else needs a player's account and is used by the game and the website; it is not documented here and may change at any time.
Answers and errors
- Answers are JSON, in UTF-8. Dates are ISO 8601 strings in UTC (
2026-10-27T09:30:00.000Z). - An error has an HTTP status (
400for a wrong parameter,404for something that does not exist) and a body{ "error": "<message>" }. - Picture addresses in answers are signed and expire after a few minutes: fetch them soon, do not store them.
Calling it
- No key, no account: send the request.
- Browsers only allow NodeWorld's own websites to call the API. Call it from your server, a bot or a script, not from the JavaScript of another website.
- Ask once a minute at most for lists that change slowly (servers, avatars) and keep the answer in between.
