Skip to main content
GET
Get league featured match

Authorizations

Authorization
string
header
required

Bearer token issued by Softmax

Path Parameters

league_id
string
required

League associated with the requested resource.

Pattern: ^league_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Query Parameters

mode
enum<string>
default:default

Featured-match lens to evaluate.

Available options:
default,
showcase,
closest,
top-two,
title,
upset,
blowout,
mine,
player,
latest,
live,
random,
step
division_id
string | null

Division whose standings scope the rank lenses (1st vs 2nd, Title match, Upset).

Pattern: ^div_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
player_id
string | null

Player featured by the 'mine' and 'player' lenses and the default chain.

Pattern: ^ply_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
seed
integer
default:0

Seed for the random lens.

Required range: 0 <= x <= 2147483647
from_episode
string | null

Episode the step lens starts from (a round episode entry ID).

Maximum string length: 100
step
enum<string> | null

Step direction for the step lens.

Available options:
newer,
older

Response

LeagueFeaturedMatchPublic · object | null

Successful Response

One featured-match pick: the episode a showcase lens landed on, and why.

mode
enum<string>
required

Lens that produced this pick; the default lens resolves to one of its chain.

Available options:
default,
showcase,
closest,
top-two,
title,
upset,
blowout,
mine,
player,
latest,
live,
random,
step
kind
enum<string>
required

Whether the pick is a live match or a completed replay.

Available options:
live,
replay
round
RoundPublic · object
required

Round the picked episode belongs to.

episode
V2RoundEpisodeRow · object
required

The picked episode.

has_newer_replay
boolean
required

Whether a newer replay exists in the window to step to.

has_older_replay
boolean
required

Whether an older replay exists in the window to step to.

reason
FeaturedMatchReasonPublic · object
required

Structured facts behind the pick.

episode_number
integer | null

1-based position within the round's episodes, newest first, or null when unknown.

replay_position
integer | null

1-based position among the window's replays, newest first, or null for live picks.

replay_total
integer | null

Number of replays in the recent-round window.