@sashke-er/hltv v2.15.14

Table of contents

• Installation
• Usage
• API
  • getMatch
  • getMatches
  • getMatchesStats
  • getMatchStats
  • getMatchMapStats
  • getResults
  • getStreams
  • getRecentThreads
  • getTeamRanking
  • getTeam
  • getTeamStats
  • getPlayer
  • getPlayerStats
  • getPlayerRanking
  • getEvents
  • getEvent
  • connectToScorebot

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.

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({hltvUrl: /* my-proxy-server */, loadPage: /* my custom request library */})

See config schema

API

getMatch

Parses most information from a match page

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

See schema

getMatches

Parses all matches from the hltv.org/matches/ page

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

See schema for Live Matches

See schema for Upcoming Matches

getMatchesStats

Parses all matches from the hltv.org/stats/matches page

HLTV.getMatchesStats({startDate: '2017-07-10', endDate: '2017-07-18'}).then((res) => {
  ...
})

See schema

getMatchStats

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

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

See schema

getMatchMapStats

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

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

See schema

getResults

Parses all matches from the hltv.org/results/ page

// Note: if you pass `eventID` to getResults you cannot pass a `pages` parameter
// since HLTV doesn't have pages for the event filter.
HLTV.getResults({pages: 2}).then((res) => {
  ...
})

See schema

getStreams

Parses all streams present on the front page of HLTV

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

See schema

getRecentThreads

Parses the latest threads on the front page of HLTV

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

See schema

getTeamRanking

Parses the info from the hltv.org/ranking/teams/ page

// 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

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

See schema

getTeamStats

Parses the info from the hltv.org/stats/teams/ page

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

See schema

getPlayer

Parses the info from the hltv.org/player/ page

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

See schema

getPlayerStats

Parses the info from hltv.org/stats/players/*

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

See schema

getPlayerRanking

Parses the info from hltv.org/stats/players page

// 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

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

See schema

getEvent

Parses the info from the hltv.org/event/ page

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

See schema

connectToScorebot

Presents an interface to receive data when the HLTV scorebot updates

NOTE: While connectToScorebot returns a Promise, the promise will never resolve. Instead you should pass the callbacks described below.

HLTV.connectToScorebot({id: 2311609, onScoreboardUpdate: (data) => {
    ...
}, onLogUpdate: (data) => {
    ...
}})

The onLogUpdate callback is passed an LogUpdate object

The onScoreboardUpdate callback is passed an ScoreboardUpdate object