VlrDevApi

events.list_events()

List events with filters for tier, region, and status

Signature

import vlrdevapi as vlr

result = vlr.events.list_events(
    tier: EventTier | Literal["all", "vct", "vcl", "t3", "gc", "cg", "offseason"] = "all",
    region: str | None = None,
    status: EventStatus | Literal["all", "upcoming", "ongoing", "completed"] = "all",
    page: int = 1,
    limit: int | None = None,
    timeout: float = 5.0
) -> list[ListEvent]

Parameters

Prop

Type

Return Value

Type: list[ListEvent]

Returns a list of event summaries. Each ListEvent object contains:

Prop

Type

Examples

List VCT Events

List VCT events
import vlrdevapi as vlr
from vlrdevapi.events import EventTier, EventStatus

# Get ongoing VCT events
events = vlr.events.list_events(
    tier=EventTier.VCT,
    status=EventStatus.ONGOING,
    limit=10
)

for event in events:
    print(f"{event.name}")
    print(f"  Status: {event.status}")
    print(f"  Prize: {event.prize or 'TBD'}")
    print(f"  Region: {event.region or 'Global'}")

Browse with Pagination

Browse with pagination
import vlrdevapi as vlr

# Get page 2 of completed events
events = vlr.events.list_events(
    tier="gc",
    status="completed",
    page=2,
    limit=20
)

print(f"Found {len(events)} events on page 2")
for event in events:
    if event.start_date and event.end_date:
        duration = (event.end_date - event.start_date).days
        print(f"{event.name} - {duration} days")

Find Events by Region

Find events by region
import vlrdevapi as vlr

# Get all upcoming events in Americas
na_events = vlr.events.list_events(
    region="Americas",
    status="upcoming",
    limit=15
)

print(f"Americas events: {len(na_events)}")
for event in na_events[:5]:  # Show first 5
    print(f"• {event.name} ({event.tier})")

Search by Tier String

Search by tier string
import vlrdevapi as vlr

# Get all VCL events (using string instead of enum)
vcl_events = vlr.events.list_events(tier="vcl")

print(f"VCL events: {len(vcl_events)}")
for event in vcl_events:
    if event.prize:
        print(f"{event.name} - {event.prize}")

Count Events by Status

Count events by status
import vlrdevapi as vlr
from collections import Counter

# Get recent events
events = vlr.events.list_events(limit=100)

# Count by status
status_counts = Counter(event.status for event in events)
print("Event status distribution:")
for status, count in status_counts.items():
    print(f"  {status.title()}: {count}")

Error Handling

  • Network failures: Returns an empty list []
  • Invalid parameters: Uses defaults (e.g., unknown tier defaults to VCT)
  • No results: Returns an empty list []

The function never raises exceptions, making it safe to use without try-catch blocks.

Tips

  • Use EventTier and EventStatus enums for IDE autocomplete and type safety
  • Combine limit with page for efficient pagination through large result sets
  • Filter by region to narrow down results to specific geographic areas

Source

Data scraped from: https://www.vlr.gg/events