Skip to content

Latest commit

 

History

History
148 lines (98 loc) · 3.53 KB

README.md

File metadata and controls

148 lines (98 loc) · 3.53 KB
Raw

Counter Strike Global Offensive HLTV-API

A Rest API for CS:GO professional matches through match data gathered by HLTV.

MIT License

API Reference

Get all matches

  GET /api/findall

Get match

  GET /api/match/{id}
Parameter Type Description
id string Required. Id of match to fetch

Get team matches

  GET /api/team/{name}
Parameter Type Description
name string Required. Name of team in match

Get matches in competion

  GET /api/comp/{name}
Parameter Type Description
name string Required. Name of tournament

Get matches of same type

  GET /api/type/{typename}
Parameter Type Description
typename string Required. Type of match(bo3,bo5)

Get X # of most recent matches

  GET /api/top/{number}
Parameter Type Description
number int Required. # of matches you want?

Add matches to the database

  POST /admin/add/
Parameter Type Description
HltvMatch json String Required Match 
{   
    "teamA": "fnatic",
    "teamB": "NIP",
    "url": "https://hltv.org/results/",
    "competition": "bo3",
    "typeofmatch": "comp",
    "scoreA": 2,
    "scoreB": 1,
    "matchid": 532323
}

Acknowledgements

Documentation

Documentation

Roadmap

  • Base Functionality
    • Full Match Search
    • Advanced Match Breakdown
    • Documentation Completion
  • [] Automation
    • [] Automated Webscraping for HLTV Match Data
    • [] Connection to database to upload data
  • [] Server
    • Physical server setup
    • Port Exisiting SQL databse to server
  • [] Potential Future
    • [] Setup a Web App to interact with the match data
    • [] Data Analysis on said CS: GO matches
    • [] Make API public use/setup auth key

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Support

For support, create a pull request or email jparkhurst120@gmail.com

Authors

License

MIT