vlrdevapi

Getting Started

  • Installation
    • Requirements
    • Installation
    • Verify Installation
    • Development Setup
    • Troubleshooting
      • lxml Installation Issues
      • Connection Issues
    • Next Steps
  • Quick Start Guide
    • Installation
    • Basic Usage
      • Import the Library
      • Search for Anything
      • Get Match Schedules
      • Player Information
      • Team Information
      • Event Information
      • Match Details
    • Common Patterns
      • Error Handling
      • Pagination
      • Caching
      • Async Fetching
      • Filtering
    • Next Steps
  • Usage Examples
    • Search Examples
      • Search Across All Types
      • Type-Specific Searches
    • Match Tracking Examples
      • Track Tournament Progress
      • Live Match Monitor
    • Player Analysis Examples
      • Player Performance Analysis
    • Match Analysis Examples
      • Match Deep Dive
    • Team Analysis Examples
      • Team Comparison
      • Team Analysis and Tracking
      • Team Roster History and Transactions
    • Data Export Examples
      • Export to CSV
    • Comprehensive Team Analysis
  • Performance
    • Built-in Optimizations
      • HTTP Connection Pooling & HTTP/2
      • In-Memory Caching
      • Fast HTML Parser
      • Brotli & Gzip Compression
    • Best Practices
      • Cache Management
      • Connection Cleanup
      • Controlled Fetches
  • Rate Limiting
    • Default Configuration
    • Configuring Rate Limits
    • How It Works
    • Example
    • Concurrent Requests
    • Best Practices
    • Troubleshooting
    • Technical Details
  • Configuration
    • Overview
    • Available Options
    • Quick Examples
      • Increase HTTP timeout and retries
      • Customize User-Agent
      • Change Base URL (advanced)
    • Rate Limiting
    • Reset to Defaults
    • Interaction With fetcher
    • Notes

API Reference

  • Search API
    • Overview
      • SearchPlayerResult
        • SearchPlayerResult.player_id
        • SearchPlayerResult.url
        • SearchPlayerResult.ign
        • SearchPlayerResult.real_name
        • SearchPlayerResult.country
        • SearchPlayerResult.image_url
        • SearchPlayerResult.result_type
        • SearchPlayerResult.__init__()
      • SearchTeamResult
        • SearchTeamResult.team_id
        • SearchTeamResult.url
        • SearchTeamResult.name
        • SearchTeamResult.country
        • SearchTeamResult.logo_url
        • SearchTeamResult.is_inactive
        • SearchTeamResult.result_type
        • SearchTeamResult.__init__()
      • SearchEventResult
        • SearchEventResult.event_id
        • SearchEventResult.url
        • SearchEventResult.name
        • SearchEventResult.date_range
        • SearchEventResult.prize
        • SearchEventResult.image_url
        • SearchEventResult.result_type
        • SearchEventResult.__init__()
      • SearchSeriesResult
        • SearchSeriesResult.series_id
        • SearchSeriesResult.url
        • SearchSeriesResult.name
        • SearchSeriesResult.image_url
        • SearchSeriesResult.result_type
        • SearchSeriesResult.__init__()
      • SearchResults
        • SearchResults.query
        • SearchResults.total_results
        • SearchResults.players
        • SearchResults.teams
        • SearchResults.events
        • SearchResults.series
        • SearchResults.__init__()
      • search()
      • search_players()
      • search_teams()
      • search_events()
      • search_series()
    • Functions
      • search
      • search_players
      • search_teams
      • search_events
      • search_series
    • Data Models
      • SearchResults
        • SearchResults
      • SearchPlayerResult
        • SearchPlayerResult
      • SearchTeamResult
        • SearchTeamResult
      • SearchEventResult
        • SearchEventResult
      • SearchSeriesResult
        • SearchSeriesResult
    • Examples
      • Basic Search
      • Type-Specific Searches
  • Matches API
    • Overview
      • Team
        • Team.name
        • Team.id
        • Team.country
        • Team.score
        • Team.__init__()
      • Match
        • Match.match_id
        • Match.team1
        • Match.team2
        • Match.event_phase
        • Match.event
        • Match.time
        • Match.status
        • Match.date
        • Match.__init__()
      • upcoming()
      • completed()
      • live()
    • Functions
      • upcoming
      • live
      • completed
    • Data Models
      • Team
        • Team
      • Match
        • Match
    • Examples
      • Upcoming Matches
      • Live Matches
      • Completed Matches
  • Players API
    • Overview
      • SocialLink
        • SocialLink.label
        • SocialLink.url
        • SocialLink.__init__()
      • Team
        • Team.role
        • Team.id
        • Team.name
        • Team.joined_date
        • Team.left_date
        • Team.__init__()
      • Profile
        • Profile.player_id
        • Profile.handle
        • Profile.real_name
        • Profile.country
        • Profile.avatar_url
        • Profile.aliases
        • Profile.socials
        • Profile.current_teams
        • Profile.past_teams
        • Profile.__init__()
      • MatchTeam
        • MatchTeam.name
        • MatchTeam.tag
        • MatchTeam.core
        • MatchTeam.__init__()
      • Match
        • Match.match_id
        • Match.url
        • Match.player_team
        • Match.opponent_team
        • Match.event
        • Match.stage
        • Match.phase
        • Match.player_score
        • Match.opponent_score
        • Match.result
        • Match.date
        • Match.time
        • Match.time_text
        • Match.__init__()
      • AgentStats
        • AgentStats.agent
        • AgentStats.agent_image_url
        • AgentStats.usage_count
        • AgentStats.usage_percent
        • AgentStats.rounds_played
        • AgentStats.rating
        • AgentStats.acs
        • AgentStats.kd
        • AgentStats.adr
        • AgentStats.kast
        • AgentStats.kpr
        • AgentStats.apr
        • AgentStats.fkpr
        • AgentStats.fdpr
        • AgentStats.kills
        • AgentStats.deaths
        • AgentStats.assists
        • AgentStats.first_kills
        • AgentStats.first_deaths
        • AgentStats.__init__()
      • profile()
      • matches()
      • agent_stats()
    • Functions
      • profile
      • matches
      • agent_stats
    • Data Models
      • SocialLink
        • SocialLink
      • Team
        • Team
      • Profile
        • Profile
      • MatchTeam
        • MatchTeam
      • Match
        • Match
      • AgentStats
        • AgentStats
    • Examples
      • Player Profile
      • Match History
      • Agent Statistics
  • Teams API
    • Overview
      • SocialLink
        • SocialLink.label
        • SocialLink.url
        • SocialLink.__init__()
      • PreviousTeam
        • PreviousTeam.team_id
        • PreviousTeam.name
        • PreviousTeam.__init__()
      • SuccessorTeam
        • SuccessorTeam.team_id
        • SuccessorTeam.name
        • SuccessorTeam.__init__()
      • RosterMember
        • RosterMember.role
        • RosterMember.player_id
        • RosterMember.ign
        • RosterMember.real_name
        • RosterMember.country
        • RosterMember.is_captain
        • RosterMember.photo_url
        • RosterMember.__init__()
      • TeamInfo
        • TeamInfo.team_id
        • TeamInfo.name
        • TeamInfo.tag
        • TeamInfo.logo_url
        • TeamInfo.logo_url_light
        • TeamInfo.logo_url_dark
        • TeamInfo.country
        • TeamInfo.is_active
        • TeamInfo.socials
        • TeamInfo.previous_team
        • TeamInfo.current_team
        • TeamInfo.__init__()
      • MatchTeam
        • MatchTeam.team_id
        • MatchTeam.name
        • MatchTeam.tag
        • MatchTeam.logo
        • MatchTeam.score
        • MatchTeam.__init__()
      • TeamMatch
        • TeamMatch.team1
        • TeamMatch.team2
        • TeamMatch.match_id
        • TeamMatch.match_url
        • TeamMatch.tournament_name
        • TeamMatch.phase
        • TeamMatch.series
        • TeamMatch.match_datetime
        • TeamMatch.__init__()
      • EventPlacement
        • EventPlacement.event_id
        • EventPlacement.event_name
        • EventPlacement.event_url
        • EventPlacement.placements
        • EventPlacement.year
        • EventPlacement.__init__()
      • PlacementDetail
        • PlacementDetail.series
        • PlacementDetail.place
        • PlacementDetail.prize_money
        • PlacementDetail.__init__()
      • PlayerTransaction
        • PlayerTransaction.date
        • PlayerTransaction.action
        • PlayerTransaction.player_id
        • PlayerTransaction.ign
        • PlayerTransaction.real_name
        • PlayerTransaction.country
        • PlayerTransaction.position
        • PlayerTransaction.reference_url
        • PlayerTransaction.__init__()
      • PreviousPlayer
        • PreviousPlayer.status
        • PreviousPlayer.player_id
        • PreviousPlayer.ign
        • PreviousPlayer.real_name
        • PreviousPlayer.country
        • PreviousPlayer.position
        • PreviousPlayer.join_date
        • PreviousPlayer.leave_date
        • PreviousPlayer.transactions
        • PreviousPlayer.__init__()
      • info()
      • roster()
      • upcoming_matches()
      • completed_matches()
      • placements()
      • transactions()
      • previous_players()
    • Functions
      • info
      • roster
      • upcoming_matches
      • completed_matches
      • placements
      • transactions
      • previous_players
    • Data Models
      • TeamInfo
        • TeamInfo
      • SocialLink
        • SocialLink
      • PreviousTeam
        • PreviousTeam
      • SuccessorTeam
        • SuccessorTeam
      • RosterMember
        • RosterMember
      • MatchTeam
        • MatchTeam
      • TeamMatch
        • TeamMatch
      • EventPlacement
        • EventPlacement
      • PlacementDetail
        • PlacementDetail
      • PlayerTransaction
        • PlayerTransaction
      • PreviousPlayer
        • PreviousPlayer
    • Usage Examples
      • Get Team Information
      • Get Team Logos
      • Get Team Roster
      • Get Team Matches
      • Get Event Placements
      • Get Team Transactions
      • Get Previous Players
      • Pagination
  • Events API
    • Overview
      • EventTier
        • EventTier.ALL
        • EventTier.VCT
        • EventTier.VCL
        • EventTier.T3
        • EventTier.GC
        • EventTier.CG
        • EventTier.OFFSEASON
      • EventStatus
        • EventStatus.ALL
        • EventStatus.UPCOMING
        • EventStatus.ONGOING
        • EventStatus.COMPLETED
      • ListEvent
        • ListEvent.id
        • ListEvent.name
        • ListEvent.status
        • ListEvent.url
        • ListEvent.region
        • ListEvent.start_date
        • ListEvent.end_date
        • ListEvent.start_text
        • ListEvent.end_text
        • ListEvent.prize
        • ListEvent.__init__()
      • Info
        • Info.id
        • Info.name
        • Info.subtitle
        • Info.date_text
        • Info.start_date
        • Info.end_date
        • Info.prize
        • Info.location
        • Info.regions
        • Info.__init__()
      • MatchTeam
        • MatchTeam.name
        • MatchTeam.id
        • MatchTeam.country
        • MatchTeam.score
        • MatchTeam.is_winner
        • MatchTeam.__init__()
      • Match
        • Match.match_id
        • Match.event_id
        • Match.status
        • Match.teams
        • Match.url
        • Match.stage
        • Match.phase
        • Match.date
        • Match.time
        • Match.__init__()
      • StageMatches
        • StageMatches.name
        • StageMatches.match_count
        • StageMatches.completed
        • StageMatches.upcoming
        • StageMatches.ongoing
        • StageMatches.start_date
        • StageMatches.end_date
        • StageMatches.__init__()
      • MatchSummary
        • MatchSummary.event_id
        • MatchSummary.total_matches
        • MatchSummary.completed
        • MatchSummary.upcoming
        • MatchSummary.ongoing
        • MatchSummary.stages
        • MatchSummary.__init__()
      • StandingEntry
        • StandingEntry.place
        • StandingEntry.prize
        • StandingEntry.team_id
        • StandingEntry.team_name
        • StandingEntry.team_country
        • StandingEntry.note
        • StandingEntry.__init__()
      • Standings
        • Standings.event_id
        • Standings.stage_path
        • Standings.url
        • Standings.entries
        • Standings.__init__()
      • EventStage
        • EventStage.name
        • EventStage.series_id
        • EventStage.url
        • EventStage.__init__()
      • Team
        • Team.id
        • Team.name
        • Team.type
        • Team.__init__()
      • list_events()
      • info()
      • matches()
      • match_summary()
      • standings()
      • stages()
      • teams()
    • Functions
      • info
      • list_events
      • match_summary
      • matches
      • stages
      • standings
      • teams
    • Enums
      • EventTier
        • EventTier
      • EventStatus
        • EventStatus
    • Data Models
      • EventStage
        • EventStage
      • Info
        • Info
      • ListEvent
        • ListEvent
      • Match
        • Match
      • MatchSummary
        • MatchSummary
      • MatchTeam
        • MatchTeam
      • StageMatches
        • StageMatches
      • StandingEntry
        • StandingEntry
      • Standings
        • Standings
      • Team
        • Team
    • Usage Examples
      • List Events
      • Get Event Details
      • Get Event Matches
      • Get Event Standings
      • Get Event Teams
  • Series API
    • Overview
      • TeamInfo
        • TeamInfo.name
        • TeamInfo.id
        • TeamInfo.short
        • TeamInfo.country
        • TeamInfo.country_code
        • TeamInfo.score
        • TeamInfo.__init__()
      • MapAction
        • MapAction.action
        • MapAction.team
        • MapAction.map
        • MapAction.__init__()
      • Info
        • Info.match_id
        • Info.teams
        • Info.score
        • Info.status_note
        • Info.event
        • Info.event_phase
        • Info.best_of
        • Info.date
        • Info.time
        • Info.patch
        • Info.map_actions
        • Info.picks
        • Info.bans
        • Info.remaining
        • Info.__init__()
      • PlayerStats
        • PlayerStats.name
        • PlayerStats.country
        • PlayerStats.team_short
        • PlayerStats.team_id
        • PlayerStats.player_id
        • PlayerStats.agents
        • PlayerStats.r
        • PlayerStats.acs
        • PlayerStats.k
        • PlayerStats.d
        • PlayerStats.a
        • PlayerStats.kd_diff
        • PlayerStats.kast
        • PlayerStats.adr
        • PlayerStats.hs_pct
        • PlayerStats.fk
        • PlayerStats.fd
        • PlayerStats.fk_diff
        • PlayerStats.__init__()
      • MapTeamScore
        • MapTeamScore.is_winner
        • MapTeamScore.id
        • MapTeamScore.name
        • MapTeamScore.short
        • MapTeamScore.score
        • MapTeamScore.attacker_rounds
        • MapTeamScore.defender_rounds
        • MapTeamScore.__init__()
      • RoundResult
        • RoundResult.number
        • RoundResult.winner_side
        • RoundResult.method
        • RoundResult.score
        • RoundResult.winner_team_id
        • RoundResult.winner_team_short
        • RoundResult.winner_team_name
        • RoundResult.__init__()
      • MapPlayers
        • MapPlayers.game_id
        • MapPlayers.map_name
        • MapPlayers.players
        • MapPlayers.teams
        • MapPlayers.rounds
        • MapPlayers.__init__()
      • info()
      • matches()
    • Functions
      • info
      • matches
    • Data Models
      • TeamInfo
        • TeamInfo
      • MapAction
        • MapAction
      • Info
        • Info
      • PlayerStats
        • PlayerStats
      • MapTeamScore
        • MapTeamScore
      • RoundResult
        • RoundResult
      • MapPlayers
        • MapPlayers
    • Usage Examples
      • Get Series Information
      • Map Picks and Bans
      • Get Detailed Map Statistics
      • Round-by-Round Results
      • Top Performers
  • Exceptions
    • Exception Hierarchy
    • Exception Classes
      • VlrdevapiError
        • VlrdevapiError
      • NetworkError
        • NetworkError
      • RateLimitError
        • RateLimitError
    • Usage Examples
      • Basic Error Handling
      • Handle Rate Limiting
      • Catch All Library Errors
      • Specific Error Handling
      • Retry Logic
      • Logging Errors
    • Best Practices
      • Always Handle Exceptions
      • Be Specific
      • Respect Rate Limits
      • Use Library Caching
  • Data Models
    • Model Features
    • Common Patterns
      • Accessing Model Data
      • Converting to Dictionary
      • Optional Fields
      • Lists and Nested Objects
    • Events Models
    • Matches Models
    • Players Models
    • Series Models
    • Field Types
      • Primitive Types
      • Date and Time
      • Collections
      • Literals
    • Runtime Validation
    • Best Practices
      • Type Hints
      • None Checks
      • Iteration

Additional Resources

  • Contributing
    • Getting Started
      • Development Setup
    • Running Tests
      • Run All Tests
      • Run Specific Test File
      • Run with Coverage
    • Code Quality
      • Linting
      • Formatting
    • Contribution Guidelines
      • Before Submitting
    • Pull Request Process
    • Code Style Guidelines
    • Testing Guidelines
    • Documentation Guidelines
    • Questions?
    • License
vlrdevapi
  • Search

© Copyright 2025, Vansh.

Built with Sphinx using a theme provided by Read the Docs.