# Realms

Realm discovery and information endpoints

## List available realms

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

```json
{"openapi":"3.1.0","info":{"title":"Realm Provider API","version":"1.0.0"},"tags":[{"name":"Realms","description":"Realm discovery and information endpoints"}],"servers":[{"url":"https://realm-provider.decentraland.org","description":"Production server"}],"security":[],"paths":{"/realms":{"get":{"summary":"List available realms","description":"Returns all healthy catalyst realms plus the main realm if available.\nEach realm includes its server name, URL, and current user count.\n","operationId":"getRealms","tags":["Realms"],"responses":{"200":{"description":"Successful response with list of realms","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Represents a catalyst realm with its connection information","required":["serverName","url","usersCount"],"properties":{"serverName":{"type":"string","description":"Name of the realm server"},"url":{"type":"string","format":"uri","description":"Base URL of the realm"},"usersCount":{"type":"number","description":"Current number of users connected to this realm"}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"code":{"type":"integer","description":"Error code"}},"required":["error"]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"code":{"type":"integer","description":"Error code"}},"required":["error"]}}}}}}}}}
```

## Get main realm about information

> 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]\(<https://adr.decentraland.org/adr/ADR-110>). The content server provided to the user will be one of the closest most updated nodes based on the user location. <br>

```json
{"openapi":"3.1.0","info":{"title":"Realm Provider API","version":"1.0.0"},"tags":[{"name":"Realms","description":"Realm discovery and information endpoints"}],"servers":[{"url":"https://realm-provider.decentraland.org","description":"Production server"}],"security":[],"paths":{"/main/about":{"get":{"summary":"Get main realm about information","description":"Returns detailed About information for the main realm, including catalyst content server details,\ncomms configuration, and other realm-specific metadata.\n\nThe response follows the About type from @dcl/catalyst-api-specs and the [ADR-110](https://adr.decentraland.org/adr/ADR-110). The content server provided to the user will be one of the closest most updated nodes based on the user location. \n","operationId":"getMainAbout","tags":["Realms"],"parameters":[{"name":"catalyst","in":"query","description":"Preferred catalyst URL to use as the main realm. When this parameter is used, the prefer catalyst will be returned as the content server.","required":false,"schema":{"type":"string","format":"uri"}}],"responses":{"200":{"description":"Successful response with main realm about information","content":{"application/json":{"schema":{"type":"object","description":"Detailed information about the main realm, following the About type from @dcl/catalyst-api-specs.\nIncludes catalyst content server details, comms configuration, and realm metadata.\n","required":["healthy","content","configurations"],"properties":{"healthy":{"type":"boolean","description":"Whether the realm is healthy and operational"},"acceptingUsers":{"type":"boolean","description":"Whether the realm is currently accepting new users"},"content":{"type":"object","description":"Content server information","properties":{"healthy":{"type":"boolean"},"version":{"type":"string"},"commitHash":{"type":"string"},"publicUrl":{"type":"string","format":"uri"}}},"configurations":{"type":"object","description":"Realm configuration settings","properties":{"networkId":{"type":"number"},"globalScenesUrn":{"type":"array","items":{"type":"string"}},"scenesUrn":{"type":"array","items":{"type":"string"}}}},"comms":{"type":"object","description":"Communications server configuration","properties":{"healthy":{"type":"boolean"},"protocol":{"type":"string"},"adapter":{"type":"string","description":"Communications adapter being used"}}},"bff":{"type":"object","description":"Backend-for-frontend service information","properties":{"healthy":{"type":"boolean"},"userCount":{"type":"number"}}},"lambdas":{"type":"object","description":"Lambda functions service information","properties":{"healthy":{"type":"boolean"},"version":{"type":"string"},"publicUrl":{"type":"string","format":"uri"}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"code":{"type":"integer","description":"Error code"}},"required":["error"]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"code":{"type":"integer","description":"Error code"}},"required":["error"]}}}},"503":{"description":"Service unavailable when no catalysts are available","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.decentraland.org/apis/apis/realm-provider/realms.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
