> ## Documentation Index
> Fetch the complete documentation index at: https://heimdall.gg/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# PlanetSide 2

> Census API lookups, outfit management, and real-time population tracking for PlanetSide 2.

The PlanetSide 2 integration connects your Discord server to the Daybreak Census API, giving members access to character lookups, outfit management tools, and live server population data directly inside Discord.

![Integrations Planetside2](https://mintcdn.com/bifrost-77/cWdWsyIXuC0bGrEs/images/Integrations_Planetside2.png?fit=max\&auto=format\&n=cWdWsyIXuC0bGrEs\&q=85\&s=3b719dba5964690fe1de10f90eee574f)

## Account linking

Members link their PlanetSide 2 character to their Discord account:

```text theme={null}
/ps2-link <character_name>
```

Once linked, members can reference their own stats without specifying a character name in lookup commands.

## Character lookup

```text theme={null}
/ps2-lookup <character_name>
```

Displays a profile card for the specified character showing:

* Battle rank and ASP rank
* Outfit membership and rank
* Faction
* Last login timestamp
* Lifetime kill/death statistics

```text theme={null}
/ps2-info
```

Displays the linked character's profile (equivalent to running `/ps2 lookup view` with your own character name).

## Outfit management

```text theme={null}
/ps2-outfit [outfit_tag]
```

Displays information about an outfit - membership count, creation date, faction, and the current online member count. Requires the outfit tag (the short 1–4 character identifier, not the full name).

```text theme={null}
/ps2-promote <member> <rank>
```

Promotes a member within the outfit. Requires appropriate outfit officer rank and RCON-equivalent API permissions configured in [**PlanetSide > Configuration**](https://bot.bifrost.gg/go/planetside/config).

## Server population

```text theme={null}
/ps2-population [server]
```

Displays the current population breakdown across all three factions on the specified server (or your configured default server). Updated from the Census real-time stream.

The dashboard [**PlanetSide > API Status**](https://bot.bifrost.gg/go/planetside/status) page displays population data in a continuously updating format.

## Setup

Navigate to [**PlanetSide > Configuration**](https://bot.bifrost.gg/go/planetside/config) in the dashboard:

```text theme={null}
/ps2-setup
```

Or configure entirely through [**PlanetSide > Configuration**](https://bot.bifrost.gg/go/planetside/config). Key settings:

| Setting | Description |
| - | - |
| **Default server** | The world (server) used when no server is specified in commands |
| **Outfit tag** | Your community's outfit tag for outfit-related commands |
| **Census API key** | Optional; increases rate limits on API requests. Free from Daybreak. |

## Required permissions

| Action | Permission key |
| - | - |
| Character lookups and population | `planetside.use` (default allow) |
| Linking an account | `planetside.use` (default allow) |
| Viewing linked players | `planetside.players.view_players` |
| Managing player data | `planetside.players.manage_players` |
| Viewing population stats | `planetside.monitoring.view_population` |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.