Realms

Realm discovery and information endpoints

List available realms

get

Returns all healthy catalyst realms plus the main realm if available. Each realm includes its server name, URL, and current user count.

Responses

200

Successful response with list of realms

application/json

Represents a catalyst realm with its connection information

serverNamestringRequired

Name of the realm server

Example: main

urlstring · uriRequired

Base URL of the realm

Example: https://peer.decentraland.org

usersCountnumberRequired

Current number of users connected to this realm

Example: 150

400

Bad request

application/json

500

Internal server error

application/json

get

/realms

HTTPcURLJavaScriptPython

GET /realms HTTP/1.1
Host: realm-provider.decentraland.org
Accept: */*

[
  {
    "serverName": "main",
    "url": "https://peer.decentraland.org",
    "usersCount": 150
  },
  {
    "serverName": "catalyst-1",
    "url": "https://peer-ec1.decentraland.org",
    "usersCount": 75
  },
  {
    "serverName": "catalyst-2",
    "url": "https://peer-wc1.decentraland.org",
    "usersCount": 42
  }
]

Get main realm about information

get

Returns detailed About information for the main realm, including catalyst content server details, comms configuration, and other realm-specific metadata.

The response follows the About type from @dcl/catalyst-api-specs and the ADR-110. The content server provided to the user will be one of the closest most updated nodes based on the user location.

Query parameters

catalyststring · uriOptional

Preferred catalyst URL to use as the main realm. When this parameter is used, the prefer catalyst will be returned as the content server.

Example: https://peer.decentraland.org

Responses

200

Successful response with main realm about information

application/json

Detailed information about the main realm, following the About type from @dcl/catalyst-api-specs. Includes catalyst content server details, comms configuration, and realm metadata.

healthybooleanRequired

Whether the realm is healthy and operational

Example: true

acceptingUsersbooleanOptional

Whether the realm is currently accepting new users

Example: true

400

Bad request

application/json

500

Internal server error

application/json

503

Service unavailable when no catalysts are available

application/json

get

/main/about

HTTPcURLJavaScriptPython

GET /main/about HTTP/1.1
Host: realm-provider.decentraland.org
Accept: */*

{
  "healthy": true,
  "acceptingUsers": true,
  "content": {
    "healthy": true,
    "version": "6.0.0",
    "commitHash": "abc123def456",
    "publicUrl": "https://peer.decentraland.org/content"
  },
  "configurations": {
    "networkId": 1,
    "globalScenesUrn": [
      "text"
    ],
    "scenesUrn": [
      "text"
    ]
  },
  "comms": {
    "healthy": true,
    "protocol": "v3",
    "adapter": "ws-room-service"
  },
  "bff": {
    "healthy": true,
    "userCount": 150
  },
  "lambdas": {
    "healthy": true,
    "version": "5.0.0",
    "publicUrl": "https://peer.decentraland.org/lambdas"
  }
}