REST API v1.0

BracketFlow Developer API

Access high-frequency live and archived esports tournament data, global FGC leaderboards, player career analytics, set histories, and character meta statistics.

Requesting an API Key (Closed Beta)

API access is currently available in closed beta on request. To generate your personal API key (free of charge for developers, esports organizers, and community tools), please reach out directly:

DM on X / Twitter (@DizioLabs) 💬 Discord: dizio

Base URL https://bracketflow.fr/api/v1

Authentication Games & Slugs Players & Search Match History Tournaments Character Meta

1. Authentication

Every request to the v1 API must include your personal API key. You can authenticate via the HTTP Authorization header or as a URL query parameter:

HTTP Header (Recommended)

Authorization: Bearer bf_your_api_key_here

Query Parameter

GET https://bracketflow.fr/api/v1/players?api_key=bf_your_api_key_here

2. Supported Game Slugs

Pass the game parameter in endpoints to filter or target a specific title:

game/tekken-8 game/street-fighter-6 game/ultimate game/melee game/dragon-ball-fighterz game/guilty-gear-strive game/2xko game/marvel-tokon-fighting-souls

3. Player Endpoints

GET /players

Global leaderboard & fuzzy player search

Returns a paginated list of players with their consolidated stats, winrates, and main characters. Ideal for auto-complete and gamerTag lookups.

Parameter	Type	Default	Description
q	string	—	GamerTag fuzzy search (case-insensitive).
game	string	`all`	Game slug (e.g. `game/tekken-8`).
char	string	—	Filter by main character played (e.g. `Kazuya`).
page	number	`1`	Requested page number.
limit	number	`50`	Results per page (max: `200`).

cURL Example

curl "https://bracketflow.fr/api/v1/players?q=Tanzen&game=game/tekken-8" \
  -H "Authorization: Bearer YOUR_API_KEY"

GET /players/:slug

Comprehensive player career dossier

Returns detailed career analytics, winrates, character usage distribution, top 10 rivals, and tournament placements.

The :slug parameter accepts a StartGG userSlug (e.g. c07024c5), a numerical playerId, or a gamerTag.

cURL Example

curl "https://bracketflow.fr/api/v1/players/c07024c5?game=game/tekken-8" \
  -H "Authorization: Bearer YOUR_API_KEY"

4. Match History (Paginated)

GET /players/:slug/history

Paginated list of historical tournament sets

Optimized for high-speed delivery with small payload sizes across extensive player match histories (up to 500+ archived sets).

Parameter	Type	Default	Description
page	number	`1`	Page index.
limit	number	`50`	Sets per page (max: `100`).
game	string	—	Filter match history to a specific game slug.

cURL Example

curl "https://bracketflow.fr/api/v1/players/c07024c5/history?page=1&limit=20" \
  -H "Authorization: Bearer YOUR_API_KEY"

5. Tournament Endpoints

GET /tournaments

Live and upcoming tournament directory

Parameter	Type	Description
status	string	`ACTIVE` (live now), `CREATED` (upcoming), `COMPLETED` (archived).
country	string	ISO-2 country code (`FR`, `US`, `JP`...) or `online`.
game	string	Game slug filter.
q	string	Text search by tournament title or city name.

cURL Example

curl "https://bracketflow.fr/api/v1/tournaments?status=ACTIVE&country=FR" \
  -H "Authorization: Bearer YOUR_API_KEY"

GET /tournaments/:eventId

Event details & real-time sets

Retrieves specific event bracket metadata and its associated sets with optional set pagination (sets_page and sets_limit, up to 500 sets/page).

cURL Example

curl "https://bracketflow.fr/api/v1/tournaments/123456?sets_page=1&sets_limit=50" \
  -H "Authorization: Bearer YOUR_API_KEY"

6. Character Meta & Tier Lists

GET /tier-list

Tournament winrate meta & tier classifications

Returns statistical meta data computed by BracketFlow across competitive matches: tournament winrate, efficiency scores, and tier brackets (S, A, B, C, D).

Parameter	Type	Default	Description
game	string	`game/ultimate`	Game slug (e.g. `game/tekken-8`).
year	string	`all`	Analysis year (`2024`, `2025`, `2026`, or `all`).

cURL Example

curl "https://bracketflow.fr/api/v1/tier-list?game=game/tekken-8&year=all" \
  -H "Authorization: Bearer YOUR_API_KEY"