hltv-wrapper v3.4.4

Table of contents

• Installation
• Usage
• API
  • getMatch
  • getMatches
  • getMatchesStats
  • getMatchStats
  • getMatchMapStats
  • getStreams
  • getRecentThreads
  • getTeamRanking
  • getTeam
  • getTeamByName
  • getTeamStats
  • getPlayer
  • getPlayerByName
  • getPlayerStats
  • getPlayerRanking
  • getEvents
  • getEvent
  • getEventByName
  • getPastEvents
  • getResults
  • getNews
  • connectToScorebot
  • TEAM_PLACEHOLDER_IMAGE
  • PLAYER_PLACEHOLDER_IMAGE

Installation

Usage

:warning: WARNING: Abusing this library will likely result in an IP ban from HLTV simply because of Cloudflare bot protection.

Please 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.

import HLTV from 'hltv'
// Or if you're stuck with CommonJS
const { HLTV } = require('hltv')

Configuration

You can create an instance of HLTV with a custom config if you want to.

const myHLTV = HLTV.createInstance({ loadPage: (url) => axios.get(url) })
// or
const myHLTV = HLTV.createInstance({ loadPage: (url) => fetch(url) })
// or you can just use the HLTV export directly to use the default settings
import HLTV from 'hltv'

HLTV.getMatch({ ... })

See config schema

API

getMatch

Parses most information from a match page (1 request)

HLTV.getMatch({ id: 2306295 }).then(res => {
    ...
})

See schema

getMatches

Parses all matches from the hltv.org/matches/ page (1 request)

HLTV.getMatches().then((res) => {
  ...
})

See schema

getMatchesStats

Parses all matches from the hltv.org/stats/matches page (1 request per page of results)

// ! BE CAREFUL, THIS CAN MAKE A LOT OF REQUESTS IF THERE ARE A LOT OF PAGES
HLTV.getMatchesStats({ startDate: '2017-07-10', endDate: '2017-07-18' }).then((res) => {
  ...
})

See schema

getMatchStats

Parses info from the hltv.org/stats/matches/*/* all maps stats page (1 request)

HLTV.getMatchStats({ id: 62979 }).then((res) => {
  ...
})

See schema

getMatchMapStats

Parses info from the hltv.org/stats/matches/mapstatsid/*/* single map stats page (2 requests)

HLTV.getMatchMapStats({ id: 49968 }).then((res) => {
  ...
})

See schema

getStreams

Parses all streams present on the front page of HLTV (1 request + 1 request per stream if loadLinks is true)

HLTV.getStreams().then((res) => {
  ...
})

See schema

getRecentThreads

Parses the latest threads on the front page of HLTV (1 request)

HLTV.getRecentThreads().then((res) => {
  ...
})

See schema

getTeamRanking

Parses the info from the hltv.org/ranking/teams/ page (1 request)

// If you don't provide a filter the latest ranking will be parsed
HLTV.getTeamRanking()
HLTV.getTeamRanking({ country: 'Thailand' })
HLTV.getTeamRanking({ year: 2017, month: 'may', day: 29 }).then((res) => {
  ...
})

See schema

getTeam

Parses the info from the hltv.org/team/ page (1 request)

HLTV.getTeam({ id: 6137 }).then(res => {
    ...
})

See schema

getTeamByName

Same as getTeam but accepts a team name instead of ID. (2 requests)

HLTV.getTeamByName({ name: "BIG" }).then(res => {
    ...
})

See getTeam schema

getTeamStats

Parses the info from the hltv.org/stats/teams/* page (4 requests + 1 more if currentRosterOnly is true)

HLTV.getTeamStats({ id: 6137 }).then(res => {
    ...
})

See schema

getPlayer

Parses the info from the hltv.org/player/* page (1 request)

HLTV.getPlayer({ id: 6137 }).then(res => {
    ...
})

See schema

getPlayerByName

Same as getPlayer but accepts a player name instead of ID. (2 requests)

HLTV.getPlayerByName({ name: "chrisJ" }).then(res => {
    ...
})

See getPlayer schema

getPlayerStats

Parses the info from hltv.org/stats/players/* (3 requests)

HLTV.getPlayerStats({ id: 7998 }).then(res => {
    ...
})

See schema

getPlayerRanking

Parses the info from hltv.org/stats/players page (1 request)

// If you don't provide a filter the latest ranking will be parsed
HLTV.getPlayerRanking({ startDate: '2018-07-01', endDate: '2018-10-01' }).then(res => {
    ...
})

See schema

getEvents

Parses the info from the hltv.org/events page (1 request)

HLTV.getEvents().then(res => {
    ...
})

See schema

getEvent

Parses the info from the hltv.org/event/ page (1 request)

HLTV.getEvent({ id: 3389 }).then(res => {
    ...
})

See schema

getEventByName

Same as getEvent but accepts a event name instead of ID. (2 requests)

HLTV.getEventByName({ name: "IEM Katowice 2019" }).then(res => {
    ...
})

See getEvent schema

getPastEvents

Parses the info from the hltv.org/events/archive page (1 request per page of results)

// ! BE CAREFUL, THIS CAN MAKE A LOT OF REQUESTS IF THERE ARE A LOT OF PAGES
HLTV.getPastEvents({ startDate: '2019-01-01', endDate: '2019-01-10' }).then(res => {
    ...
})

See schema

getResults

Parses the info from the hltv.org/results page (1 request per page of results)

// ! BE CAREFUL, THIS CAN MAKE A LOT OF REQUESTS IF THERE ARE A LOT OF PAGES
HLTV.getResults({ eventIds: [1617], bestOfX: [BestOfFilter.BO3] }).then(res => {
    ...
})

See schema

getNews

Parses the info from the hltv.org/news/archive/ page (1 request)

// If you don't provide a filter the latest news will be parsed
HLTV.getNews()
HLTV.getNews({ eventIds: [3491] })
HLTV.getNews({ year: 2020, month: 'may' }).then((res) => {
  ...
})

See schema

connectToScorebot

Presents an interface to receive data when the HLTV scorebot updates

HLTV.connectToScorebot({
  id: 2311609,
  onScoreboardUpdate: (data, done) => {
    // if you call done() the socket connection will close.
  },
  onLogUpdate: (data, done) => {
      ...
  }
})

The onLogUpdate callback is passed an LogUpdate object

The onScoreboardUpdate callback is passed an ScoreboardUpdate object

TEAM_PLACEHOLDER_IMAGE

HLTV.TEAM_PLACEHOLDER_IMAGE
// https://www.hltv.org/img/static/team/placeholder.svg

PLAYER_PLACEHOLDER_IMAGE

HLTV.PLAYER_PLACEHOLDER_IMAGE
// https://static.hltv.org/images/playerprofile/bodyshot/unknown.png