/hltv-api

An unofficial JSON api for popular CS:GO website hltv.org. Check available methods on https://hltv-api.vercel.app/

Primary LanguageTypeScriptMIT LicenseMIT

HLTV API

Build Status npm Codecov dependencies Status devDependencies Status

This is my experimental project, but also small useful module for node.js which helps you to easy implement data from popular CS:GO website hltv.org.

Installation

$ npm install hltv-api

Methods

  1. getNews
  2. getResults
  3. getMatches
  4. getStatsByMatchId

Check all the available methods: https://hltv-api.vercel.app/

How to use

Simple API example
  • Using CommonJS module:
const HLTV = require('hltv-api').default
const express = require('express')
const app = express()

app.get('/', async (req, res) => {
  const news = await HLTV.getNews()
  res.json(news)
})

app.get('/results', async (req, res) => {
  const results = await HLTV.getResults()
  res.json(results)
})

app.get('/matches', async (req, res) => {
  const matches = await HLTV.getMatches()
  res.json(stats)
})

app.get('/:matchId(*)', async (req, res) => {
  const stats = await HLTV.getStatsByMatchId(req.params.matchId)
  res.json(stats)
})

app.listen(3000, () => {
  console.log('Listening on port 3000...')
})
  • Using babel and necessary plugins (demo app)
import HLTV from 'hltv-api'
News
app.get('/', async (req, res) => {
  const news = await HLTV.getNews()
  res.json(news)
}
  • request
http://localhost:3000/
  • response
[
  {
    "title": "ESL Pro League Season 5 Finals preview",
    "description": "The next big offline event, the ESL Pro League Season 5 Finals, is kicking off tomorrow, May 30, with the round-robin group stage. We have put together a preview where we delve into each of the 12 teams taking part in the $750,000 tournament.",
    "link": "https://www.hltv.org/news/20567/esl-pro-league-season-5-finals-preview",
    "time": "2017-05-29T23:27:00.000Z"
  }
]
Results
app.get('/results', async (req, res) => {
  const results = await HLTV.getResults()
  res.json(results)
})
  • request
http://localhost:3000/results
  • response
[
  {
    "event": "ECS Season 4 Europe",
    "maps": "trn",
    "time": "2017-08-29T22:05:00.000Z",
    "team1": {
      "name": "fnatic",
      "crest": "https://static.hltv.org/images/team/logo/4991",
      "result": 13
    },
    "team2": {
      "name": "FaZe",
      "crest": "https://static.hltv.org/images/team/logo/6667",
      "result": 16
    },
    "matchId": "/matches/2316387/fnatic-vs-faze-ecs-season-4-europe"
  }
]
Matches
All Matches
app.get('/matches', async (req, res) => {
  const matches = await getMatches()
  res.json(matches)
})
  • request
http://localhost:3000/matches
  • response
[
  {
    "id": 2336543,
    "link": "/matches/2336543/yalla-vs-ez5-extremesland-2019-middle-regional-finals",
    "time": "2019-09-27T14:40:00.000Z",
    "event": {
      "name": "eXTREMESLAND 2019 Middle Regional Finals",
      "crest": "https://static.hltv.org/images/eventLogos/4927.png"
    },
    "stars": 0,
    "map": "Inferno",
    "teams": [
      {
        "name": "Yalla",
        "crest": "https://static.hltv.org/images/team/logo/8280"
      },
      {
        "name": "EZ5",
        "crest": "https://static.hltv.org/images/team/logo/10395"
      }
    ]
  }
]
Single Match
app.get('/:matchId(*)', async (req, res) => {
  const { matchId } = req.params
  const stats = await getStatsByMatchId(matchId)
  res.json(stats)
})
  • request
http://localhost:3000/matches/2316387/fnatic-vs-faze-ecs-season-4-europe
  • response
[
  {
    "playerName": "Robin flusha Rönnquist",
    "playerId": "/player/3055/flusha",
    "kills": 19,
    "deaths": 19,
    "plusMinus": 0,
    "adr": 73.7,
    "kast": 62.1,
    "rating": 0.97
  }
]