events.match_summary()
Get aggregated match statistics for an event
Signature
import vlrdevapi as vlr
result = vlr.events.match_summary(
event_id: int,
timeout: float = 5.0
) -> MatchSummary | NoneParameters
Prop
Type
Return Value
Type: MatchSummary | None
Returns aggregated match statistics or None if not found.
Prop
Type
StageMatches fields:
Prop
Type
Examples
Get Match Summary
import vlrdevapi as vlr
# Get match statistics for an event
summary = vlr.events.match_summary(event_id=2498)
if summary:
print(f"Event ID: {summary.event_id}")
print(f"Total Matches: {summary.total_matches}")
print(f" Completed: {summary.completed}")
print(f" Upcoming: {summary.upcoming}")
print(f" Ongoing: {summary.ongoing}")
# Calculate completion percentage
if summary.total_matches > 0:
completion = (summary.completed / summary.total_matches) * 100
print(f"\nCompletion: {completion:.1f}%")
else:
print("Match summary not available")Monitor Event Progress
import vlrdevapi as vlr
summary = vlr.events.match_summary(event_id=1189)
if summary:
remaining = summary.upcoming + summary.ongoing
print(f"Completed: {summary.completed}/{summary.total_matches}")
print(f"Remaining: {remaining}")Error Handling
- Network failures: Returns
None - Invalid event ID: Returns
None - No matches found: Returns
None
Always check if the return value is not None before accessing properties.
Tips
- Use this function for quick event progress overview without fetching all match details
- Combine with
matches()to get detailed match information after checking the summary - All count fields (
total_matches,completed,upcoming,ongoing) are always non-negative integers - The sum of
completed + upcoming + ongoingshould equaltotal_matches
Related
events.matches()
Get detailed match information
events.info()
Get event header information
events.list_events()
Browse all events
Source
Data scraped from: https://www.vlr.gg/event/matches/{event_id}