Get Game State — guildGetGameState | Bifrost Developer Center

POSThttps://api.dev.bifrostgaming.com/v1/graphql

guildGetGameState

Get real-time game state data from a remote game server, including map, mode, player counts, and team scores.

Operation Type

Query

Rate Limit: 1 request per 30 seconds per server

Designed for near real-time polling of live game state.

Input Fields

Field	Type	Required	Description
`serverId`	ID!	Required	Unique server identifier
`gameType`	String	Optional	Game type filter (e.g., 'HLL')

Code Examples

curl -X POST https://api.dev.bifrostgaming.com/v1/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{
    "query": "query { guildGetGameState(serverId: \"YOUR_SERVER_ID\", gameType: \"HLL\") { data timestamp matchTimeRemainingSeconds team1 { teamName playerCount score faction } team2 { teamName playerCount score faction } nextMap nextMapGameMode pendingNextMap } }"
  }'

Postman Collection

Download a ready-to-use Postman collection for this endpoint. Import it into Postman to start testing immediately.

How to import into Postman

Open Postman and click Import (top-left)
Drag and drop the downloaded .json file, or click Upload Files and select it
Click Import to confirm
The collection appears in your sidebar — expand it and select the request
In the Body tab, update the placeholder values (your-partner-id, etc.) with your actual credentials
Click Send

The collection uses Postman's GraphQL body type, which provides syntax highlighting and variable editing. Make sure your Postman version is 7.2+ for GraphQL support.

Success Response200

{
  "data": {
    "guildGetGameState": {
      "data": {
        "serverName": "My Community Server #1",
        "currentMap": "Hurtgen Forest",
        "currentGameMode": "Warfare",
        "playerCount": 87,
        "maxPlayers": 100,
        "timeRemaining": "0:45:32",
        "score": { "allies": 3, "axis": 2 }
      },
      "timestamp": "2025-01-15T12:34:56.789Z",
      "matchTimeRemainingSeconds": 2732,
      "team1": { "name": "Allies", "score": 3 },
      "team2": { "name": "Axis", "score": 2 },
      "nextMap": "Carentan",
      "nextMapGameMode": "Offensive",
      "pendingNextMap": null
    }
  }
}

Error Responses

Response Fields

Field	Type	Required	Description
`data`	JSON	Optional	Dynamic object containing normalized server state data
`timestamp`	String	Optional	ISO 8601 timestamp when data was last updated
`matchTimeRemainingSeconds`	Int	Optional	Seconds remaining in current match
`team1`	Object	Optional	Team 1 data: teamName, playerCount, score, faction
`team2`	Object	Optional	Team 2 data: teamName, playerCount, score, faction
`nextMap`	String	Optional	Friendly name of next map
`nextMapGameMode`	String	Optional	Game mode of next map
`pendingNextMap`	String	Optional	If a next map has already been set for this match (e.g. by a Discord vote), this field contains the map RCON name. Null if no map is pending.

In partnership with

Brilliant game servers for communities large and small.

Get yours today!

A Shrapnelworks product