\n\nTable of contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [API](#api)\n - [getMatch](#getmatch)\n - [getMatches](#getmatches)\n - [getMatchesStats](#getmatchesstats)\n - [getMatchStats](#getmatchstats)\n - [getMatchMapStats](#getmatchmapstats)\n - [getStreams](#getstreams)\n - [getRecentThreads](#getrecentthreads)\n - [getTeamRanking](#getteamranking)\n - [getTeam](#getteam)\n - [getTeamByName](#getteambyname)\n - [getTeamStats](#getteamstats)\n - [getPlayer](#getplayer)\n - [getPlayerByName](#getplayerbyname)\n - [getPlayerStats](#getplayerstats)\n - [getPlayerRanking](#getplayerranking)\n - [getEvents](#getevents)\n - [getEvent](#getevent)\n - [getEventByName](#geteventbyname)\n - [getPastEvents](#getpastevents)\n - [getResults](#getresults)\n - [getNews](#getnews)\n - [connectToScorebot](#connecttoscorebot)\n - [TEAM_PLACEHOLDER_IMAGE](#team_placeholder_image)\n - [PLAYER_PLACEHOLDER_IMAGE](#player_placeholder_image)\n\n## Installation\n\n[](https://nodei.co/npm/hltv/)\n\n## Usage\n\n:warning: **WARNING:** Abusing this library will likely result in an IP ban from HLTV simply because of Cloudflare bot protection.\n\nPlease use with caution and try to limit the rate and amount of your requests if you value your access to HLTV. Each method has the number of requests it makes to HLTV documented in this README. This is important if you want to implement some kind of throttling yourself.\n\n```javascript\n// In .mjs files and if you're using a bundler\nimport HLTV from 'hltv'\n// Or if you're stuck with CommonJS\nconst { HLTV } = require('hltv')\n```\n\n#### Configuration\n\nYou can create an instance of HLTV with a custom config if you want to.\n\n| Option | Type | Default value | Description |\n| :-------: | :--------------------------------: | :----------------------------: | :-----------------------------------------------------------------------------: |\n| loadPage | (url: string) => Promise\\ | based on the 'got' library | Function that will be called when the library makes a request to HLTV |\n| httpAgent | HttpAgent | HttpsAgent | Http agent used when sending a request and connecting to the scorebot websocket |\n\n```javascript\nconst myHLTV = HLTV.createInstance({ loadPage: (url) => axios.get(url) })\n// or\nconst myHLTV = HLTV.createInstance({ loadPage: (url) => fetch(url) })\n// or you can just use the HLTV export directly to use the default settings\nimport HLTV from 'hltv'\n\nHLTV.getMatch({ ... })\n```\n\n**[See config schema](https://github.com/gigobyte/HLTV/blob/master/src/config.ts)**\n\n## API\n\n#### getMatch\n\nParses most information from a match page (1 request)\n\n| Option | Type | Default value | Description |\n| :----: | :----: | :-----------: | :----------: |\n| id | number | - | The match id |\n\n```javascript\nHLTV.getMatch({ id: 2306295 }).then(res => {\n ...\n})\n```\n\n**[See schema](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getMatch.ts#L79)**\n\n---\n\n#### getMatches\n\nParses all matches from the `hltv.org/matches/` page (1 request)\n\n| Option | Type | Default Value | Description |\n| :-------: | :--------------------------------------------------------------------------------------------: | :-----------: | :------------------------------------------------------------: |\n| eventIds | number[]? | - | Filter matches by event IDs. |\n| eventType | [MatchEventType](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getMatches.ts#L8)? | - | Filter matches by event type. |\n| filter | [MatchFilter](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getMatches.ts#L14)? | - | Filter matches by pre-set categories. Overrides other filters. |\n| teamIds | number[]? | - | - |\n\n```javascript\nHLTV.getMatches().then((res) => {\n ...\n})\n```\n\n**[See schema](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getMatches.ts#L25)**\n\n#### getMatchesStats\n\nParses all matches from the `hltv.org/stats/matches` page (1 request per page of results)\n\n| Option | Type | Default Value | Description |\n| :----------------------: | :----------------------------------------------------------------------------------------: | :-----------: | :----------------------------------------: |\n| startDate | string? | - | - |\n| endDate | string? | - | - |\n| matchType | [MatchType](https://github.com/gigobyte/HLTV/blob/master/src/shared/MatchType.ts)? | - | - |\n| maps | [GameMap](https://github.com/gigobyte/HLTV/blob/master/src/shared/GameMap.ts)[]? | - | - |\n| rankingFilter | [RankingFilter](https://github.com/gigobyte/HLTV/blob/master/src/shared/RankingFilter.ts)? | - | - |\n| delayBetweenPageRequests | number? | 0 | Used to prevent CloudFlare throttling (ms) |\n\n```javascript\n// ! BE CAREFUL, THIS CAN MAKE A LOT OF REQUESTS IF THERE ARE A LOT OF PAGES\nHLTV.getMatchesStats({ startDate: '2017-07-10', endDate: '2017-07-18' }).then((res) => {\n ...\n})\n```\n\n**[See schema](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getMatchStats.ts#L15)**\n\n---\n\n#### getMatchStats\n\nParses info from the `hltv.org/stats/matches/*/*` all maps stats page (1 request)\n\n| Option | Type | Default Value | Description |\n| :----: | :----: | :-----------: | :---------: |\n| id | number | - | - |\n\n```javascript\nHLTV.getMatchStats({ id: 62979 }).then((res) => {\n ...\n})\n```\n\n**[See schema](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getMatchStats.ts#L15)**\n\n---\n\n#### getMatchMapStats\n\nParses info from the `hltv.org/stats/matches/mapstatsid/*/*` single map stats page (2 requests)\n\n| Option | Type | Default Value | Description |\n| :----: | :----: | :-----------: | :---------: |\n| id | number | - | - |\n\n```javascript\nHLTV.getMatchMapStats({ id: 49968 }).then((res) => {\n ...\n})\n```\n\n**[See schema](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getMatchMapStats.ts#L80)**\n\n---\n\n#### getStreams\n\nParses all streams present on the front page of HLTV (1 request + 1 request per stream if `loadLinks` is true)\n\n| Option | Type | Default Value | Description |\n| :-------: | :-----: | :-----------: | :-----------------------------------------------------------------------------------: |\n| loadLinks | boolean | false | Enables parsing of the stream links (every stream is an additional separate request). |\n\n```javascript\nHLTV.getStreams().then((res) => {\n ...\n})\n```\n\n**[See schema](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getStreams.ts#L12)**\n\n---\n\n#### getRecentThreads\n\nParses the latest threads on the front page of HLTV (1 request)\n\n| Option | Type | Default Value | Description |\n| :----: | :--: | :-----------: | :---------: |\n| - | - | - | - |\n\n```javascript\nHLTV.getRecentThreads().then((res) => {\n ...\n})\n```\n\n**[See schema](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getRecentThreads.ts#L11)**\n\n#### getTeamRanking\n\nParses the info from the `hltv.org/ranking/teams/` page (1 request)\n\n| Option | Type | Default Value | Description |\n| :-----: | :--------------------------------------------------------------------------------------------------------------------------------------------: | :-----------: | :----------------------------------------------: |\n| year | 2015 \\| 2016 \\| 2017 \\| 2018 \\| 2019 \\| 2020 \\| 2021 \\| 2022 | - | - |\n| month | 'january' \\| 'february' \\| 'march' \\| 'april' \\| 'may' \\| 'june' \\| 'july' \\| 'august' \\| 'september' \\| 'october' \\| 'november' \\| 'december' | - | - |\n| day | number? | - | - |\n| country | string? | - | Must be capitalized (`'Brazil'`, `'France'` etc) |\n\n```javascript\n// If you don't provide a filter the latest ranking will be parsed\nHLTV.getTeamRanking()\nHLTV.getTeamRanking({ country: 'Thailand' })\nHLTV.getTeamRanking({ year: 2017, month: 'may', day: 29 }).then((res) => {\n ...\n})\n```\n\n**[See schema](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getTeamRanking.ts#L6)**\n\n---\n\n#### getTeam\n\nParses the info from the `hltv.org/team/` page (1 request)\n\n| Option | Type | Default value | Description |\n| :----: | :----: | :-----------: | :---------: |\n| id | number | - | The team id |\n\n```javascript\nHLTV.getTeam({ id: 6137 }).then(res => {\n ...\n})\n```\n\n**[See schema](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getTeam.ts#L21)**\n\n---\n\n#### getTeamByName\n\nSame as getTeam but accepts a team name instead of ID. (2 requests)\n\n| Option | Type | Default value | Description |\n| :----: | :----: | :-----------: | :-----------: |\n| name | string | - | The team name |\n\n```javascript\nHLTV.getTeamByName({ name: \"BIG\" }).then(res => {\n ...\n})\n```\n\n**[See getTeam schema](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getTeam.ts#L21)**\n\n---\n\n#### getTeamStats\n\nParses the info from the `hltv.org/stats/teams/*` page (4 requests + 1 more if `currentRosterOnly` is true)\n\n| Option | Type | Default value | Description |\n| :---------------: | :----------------------------------------------------------------------------------------: | :-----------: | :----------------------------------------: |\n| id | number | - | The team id |\n| currentRosterOnly | boolean? | false | Return stats about the current roster only |\n| startDate | string? | - | - |\n| endDate | string? | - | - |\n| matchType | [MatchType](https://github.com/gigobyte/HLTV/blob/master/src/shared/MatchType.ts)? | - | - |\n| rankingFilter | [RankingFilter](https://github.com/gigobyte/HLTV/blob/master/src/shared/RankingFilter.ts)? | - | - |\n| maps | [GameMap](https://github.com/gigobyte/HLTV/blob/master/src/shared/GameMap.ts)[]? | - | - |\n| bestOfX | [BestOfFilter](https://github.com/gigobyte/HLTV/blob/master/src/shared/BestOfFilter.ts)? | - | - |\n\n```javascript\nHLTV.getTeamStats({ id: 6137 }).then(res => {\n ...\n})\n```\n\n**[See schema](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getTeamStats.ts#L28)**\n\n---\n\n#### getPlayer\n\nParses the info from the `hltv.org/player/*` page (1 request)\n\n| Option | Type | Default value | Description |\n| :----: | :----: | :-----------: | :-----------: |\n| id | number | - | The player id |\n\n```javascript\nHLTV.getPlayer({ id: 6137 }).then(res => {\n ...\n})\n```\n\n**[See schema](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getPlayer.ts#L20)**\n\n---\n\n#### getPlayerByName\n\nSame as getPlayer but accepts a player name instead of ID. (2 requests)\n\n| Option | Type | Default value | Description |\n| :----: | :----: | :-----------: | :-------------: |\n| name | string | - | The player name |\n\n```javascript\nHLTV.getPlayerByName({ name: \"chrisJ\" }).then(res => {\n ...\n})\n```\n\n**[See getPlayer schema](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getPlayer.ts#L20)**\n\n#### getPlayerStats\n\nParses the info from `hltv.org/stats/players/*` (3 requests)\n\n| Option | Type | Default value | Description |\n| :-----------: | :----------------------------------------------------------------------------------------: | :-----------: | :---------: |\n| id | number | - | - |\n| startDate | string? | - | - |\n| endDate | string? | - | - |\n| matchType | [MatchType](https://github.com/gigobyte/HLTV/blob/master/src/shared/MatchType.ts)? | - | - |\n| rankingFilter | [RankingFilter](https://github.com/gigobyte/HLTV/blob/master/src/shared/RankingFilter.ts)? | - | - |\n| maps | [GameMap](https://github.com/gigobyte/HLTV/blob/master/src/shared/GameMap.ts)[]? | - | - |\n| bestOfX | [BestOfFilter](https://github.com/gigobyte/HLTV/blob/master/src/shared/BestOfFilter.ts)? | - | - |\n| eventIds | number[]? | - | - |\n\n```javascript\nHLTV.getPlayerStats({ id: 7998 }).then(res => {\n ...\n})\n```\n\n**[See schema](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getPlayerStats.ts#L23)**\n\n---\n\n#### getPlayerRanking\n\nParses the info from `hltv.org/stats/players` page (1 request)\n\n| Option | Type | Default value | Description |\n| :-----------: | :----------------------------------------------------------------------------------------: | :-----------: | :---------: |\n| startDate | string? | - | - |\n| endDate | string? | - | - |\n| matchType | [MatchType](https://github.com/gigobyte/HLTV/blob/master/src/shared/MatchType.ts)? | - | - |\n| rankingFilter | [RankingFilter](https://github.com/gigobyte/HLTV/blob/master/src/shared/RankingFilter.ts)? | - | - |\n| maps | [GameMap](https://github.com/gigobyte/HLTV/blob/master/src/shared/GameMap.ts)[]? | - | - |\n| minMapCount | number? | - | - |\n| countries | string[] | - | - |\n| bestOfX | [BestOfFilter](https://github.com/gigobyte/HLTV/blob/master/src/shared/BestOfFilter.ts)? | - | - |\n\n```javascript\n// If you don't provide a filter the latest ranking will be parsed\nHLTV.getPlayerRanking({ startDate: '2018-07-01', endDate: '2018-10-01' }).then(res => {\n ...\n})\n```\n\n**[See schema](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getPlayerRanking.ts#L12)**\n\n---\n\n#### getEvents\n\nParses the info from the `hltv.org/events` page (1 request)\n\n| Option | Type | Default value | Description |\n| :----------------: | :--------------------------------------------------------------------------------: | :-----------: | :-------------------------------------------------: |\n| eventType | [EventType](https://github.com/gigobyte/HLTV/blob/master/src/shared/EventType.ts)? | - | Event type e.g. EventSize.Major, EventSize.LocalLAN |\n| prizePoolMin | number? | - | Minimum prize pool (USD$) |\n| prizePoolMax | number? | - | Maximum prize pool (USD$) |\n| attendingTeamIds | number[]? | - | - |\n| attendingPlayerIds | number[]? | - | - |\n\n```javascript\nHLTV.getEvents().then(res => {\n ...\n})\n```\n\n**[See schema](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getEvents.ts#L8)**\n\n---\n\n#### getEvent\n\nParses the info from the `hltv.org/event/` page (1 request)\n\n| Option | Type | Default value | Description |\n| :----: | :----: | :-----------: | :----------: |\n| id | number | - | The event id |\n\n```javascript\nHLTV.getEvent({ id: 3389 }).then(res => {\n ...\n})\n```\n\n**[See schema](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getEvent.ts#L43)**\n\n---\n\n#### getEventByName\n\nSame as getEvent but accepts a event name instead of ID. (2 requests)\n\n| Option | Type | Default value | Description |\n| :----: | :----: | :-----------: | :------------: |\n| name | string | - | The event name |\n\n```javascript\nHLTV.getEventByName({ name: \"IEM Katowice 2019\" }).then(res => {\n ...\n})\n```\n\n**[See getEvent schema](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getEvent.ts#L43)**\n\n---\n\n#### getPastEvents\n\nParses the info from the `hltv.org/events/archive` page (1 request per page of results)\n\n| Option | Type | Default value | Description |\n| :----------------------: | :--------------------------------------------------------------------------------: | :-----------: | :-------------------------------------------------: |\n| eventType | [EventType](https://github.com/gigobyte/HLTV/blob/master/src/shared/EventType.ts)? | - | Event type e.g. EventSize.Major, EventSize.LocalLAN |\n| startDate | string? | - | - |\n| endDate | string? | - | - |\n| prizePoolMin | number? | - | Minimum prize pool (USD$) |\n| prizePoolMax | number? | - | Maximum prize pool (USD$) |\n| attendingTeamIds | number[]? | - | - |\n| attendingPlayerIds | number[]? | - | - |\n| delayBetweenPageRequests | number? | 0 | Used to prevent CloudFlare throttling (ms) |\n\n```javascript\n// ! BE CAREFUL, THIS CAN MAKE A LOT OF REQUESTS IF THERE ARE A LOT OF PAGES\nHLTV.getPastEvents({ startDate: '2019-01-01', endDate: '2019-01-10' }).then(res => {\n ...\n})\n```\n\n**[See schema](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getPastEvents.ts#L8)**\n\n---\n\n#### getResults\n\nParses the info from the `hltv.org/results` page (1 request per page of results)\n\n| Option | Type | Default value | Description |\n| :----------------------: | :---------------------------------------------------------------------------------------------: | :-----------: | :----------------------------------------: |\n| startDate | string? | - | - |\n| endDate | string? | - | - |\n| matchType | [ResultMatchType](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getResults.ts#L9)? | - | - |\n| stars | 1 \\| 2 \\| 3 \\| 4 \\| 5 | - | - |\n| maps | [GameMap](https://github.com/gigobyte/HLTV/blob/master/src/shared/GameMap.ts)[]? | - | - |\n| countries | string[] | - | - |\n| bestOfX | [BestOfFilter](https://github.com/gigobyte/HLTV/blob/master/src/shared/BestOfFilter.ts)? | - | - |\n| contentFilters | [ContentFilter](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getResults.ts#L14)? | - | - |\n| eventIds | number[]? | - | - |\n| playerIds | number[]? | - | - |\n| teamIds | number[]? | - | - |\n| game | [GameType](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getResults.ts#L21)? | - | - |\n| delayBetweenPageRequests | number? | 0 | Used to prevent CloudFlare throttling (ms) |\n\n```javascript\n// ! BE CAREFUL, THIS CAN MAKE A LOT OF REQUESTS IF THERE ARE A LOT OF PAGES\nHLTV.getResults({ eventIds: [1617], bestOfX: [BestOfFilter.BO3] }).then(res => {\n ...\n})\n```\n\n**[See schema](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getResults.ts#L31)**\n\n#### getNews\n\nParses the info from the `hltv.org/news/archive/` page (1 request)\n\n| Option | Type | Default Value | Description |\n| :------: | :--------------------------------------------------------------------------------------------------------------------------------------------: | :-----------: | :--------------------------------------------------------: |\n| year | 2005 \\| 2006 \\| 2007 \\| 2008 \\| 2009 \\| 2010 \\| 2011 \\| 2012 \\| 2013 \\| 2014 \\| 2015 \\| 2016 \\| 2017 \\| 2018 \\| 2019 \\| 2020 \\| 2021 \\| 2022 | - | If you specify a `year` you must specify a `month` as well |\n| month | 'january' \\| 'february' \\| 'march' \\| 'april' \\| 'may' \\| 'june' \\| 'july' \\| 'august' \\| 'september' \\| 'october' \\| 'november' \\| 'december' | - | If you specify a `month` you must specify a `year` as well |\n| eventIds | number[]? | - | - |\n\n```javascript\n// If you don't provide a filter the latest news will be parsed\nHLTV.getNews()\nHLTV.getNews({ eventIds: [3491] })\nHLTV.getNews({ year: 2020, month: 'may' }).then((res) => {\n ...\n})\n```\n\n**[See schema](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/getNews.ts#L7)**\n\n#### connectToScorebot\n\nPresents an interface to receive data when the HLTV scorebot updates\n\n| Option | Type | Default Value | Description |\n| :----------------: | :-------: | :-----------: | :--------------------------------------------------------------------------------------------: |\n| id | number | - | The match ID |\n| onScoreboardUpdate | function? | - | Callback that is called when there is new scoreboard data |\n| onLogUpdate | function? | - | Callback that is called when there is new game log data |\n| onFullLogUpdate | function? | - | It's still unclear when this is called and with what data, if you find out please let me know! |\n| onConnect | function? | - | Callback that is called when a connection with the scorebot is established |\n| onDisconnect | function? | - | Callback that is called when the scorebot disconnects |\n\n```javascript\nHLTV.connectToScorebot({\n id: 2311609,\n onScoreboardUpdate: (data, done) => {\n // if you call done() the socket connection will close.\n },\n onLogUpdate: (data, done) => {\n ...\n }\n})\n\n```\n\nThe `onLogUpdate` callback is passed an [LogUpdate](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/connectToScorebot.ts#L117) object\n\nThe `onScoreboardUpdate` callback is passed an [ScoreboardUpdate](https://github.com/gigobyte/HLTV/blob/master/src/endpoints/connectToScorebot.ts#L161) object\n\n---\n\n#### TEAM_PLACEHOLDER_IMAGE\n\n```javascript\nHLTV.TEAM_PLACEHOLDER_IMAGE\n// https://www.hltv.org/img/static/team/placeholder.svg\n```\n\n---\n\n#### PLAYER_PLACEHOLDER_IMAGE\n\n```javascript\nHLTV.PLAYER_PLACEHOLDER_IMAGE\n// https://static.hltv.org/images/playerprofile/bodyshot/unknown.png\n```\n","readmeFilename":"README.md"}
![\"HLTV](\"https://www.hltv.org/img/static/TopLogo2x.png\")
\n