Skip to content
BlockFrontBlockFront DocsOfficial Documentation for BlockFront

Brigades and matches

These routes need an API key.

A brigade’s public page. Name it with tag or id.

GET /api/v2/?type=clan&tag=TAG
{
"id": "00000000-0000-0000-0000-000000000000",
"tag": "TAG",
"name": "Example Brigade",
"founded": 1793380001526,
"memberCount": 2,
"owner": "00000000-0000-0000-0000-000000000000",
"skillRank": { "id": "gold_master", "title": "Gold Master" },
"score": { "monthly": 53728, "rank": 1 },
"members": [
{
"role": "owner",
"uuid": "00000000-0000-0000-0000-000000000000",
"username": "Example",
"rank": { "id": 12, "title": "Sergeant" }
},
{ "role": "member", "hidden": true }
]
}
Field Description
founded When the brigade was founded, in milliseconds since the Unix epoch.
owner The owner’s UUID. Left out if they’ve opted out of the API.
skillRank The brigade’s skill rank, or null if it has none.
score The monthly score and scoreboard position. rank is null with no score.
members[].role owner, officer or member.
members[].hidden Set for a member who has opted out of the API.

One completed match. Name it with id, the matchId from player_matches.

GET /api/v2/?type=match&id=00000000-0000-0000-0000-000000000000
{
"matchId": "00000000-0000-0000-0000-000000000000",
"mode": "dom",
"map": "Storm",
"environment": "day",
"endedAt": 1793380001526,
"durationSeconds": 1015,
"winnerTeam": "Allies",
"axisScore": 496,
"alliedScore": 501,
"axisCasualties": 1120,
"alliedCasualties": 1177,
"players": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"username": "Example",
"team": "Allies",
"result": "WIN",
"placement": 1,
"kills": 40,
"deaths": 12,
"assists": 9,
"score": 610
},
{
"hidden": true,
"team": "Axis",
"result": "LOSS",
"placement": 2,
"kills": 31,
"deaths": 15,
"assists": 4,
"score": 480
}
]
}

A player who has opted out keeps their line of the scoreboard, with "hidden": true in place of their name and id.