Get Realm / Server

A Realm, in most cases, would be a Discord server. In the future, a Realm can be a a group of servers.

NOTE: A Realm ID is not the same as a Discord ServerID. You will receive the Realm ID from us when you request access

Get a Realm's data

GET https://api.badbears.io/api/v4/realms/{realmID}

Path Parameters

Name	Type	Description
realmID*	String

200: OK

401: Unauthorized Invalid API Key

403: Forbidden You are trying to access a Realm that you do not have access to

Get a Realm's analytical data

GET https://api.badbears.io/api/v4/realms/{realmID}/analytics

Path Parameters

Name	Type	Description
realmID*	String

200: OK

401: Unauthorized Invalid API Key

403: Forbidden You are trying to access a Realm that you do not have access to

---

Authorization

All these endpoints require the Authorization header to be set like this:

{
    "Authorization": "Bearer <YourAPIKey>"
}

Each API key is linked to a specific Realm.

Trying to access other Realms will result in an error code 403: Forbidden.

Entering an incorrect or non-existing API Key will result in an error code 401: Unauthorized