Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/s32x/ovrstat
:video_game: An Unofficial Overwatch Stats API
https://github.com/s32x/ovrstat
api blizzard container docker golang overwatch overwatch-api stats
Last synced: 13 days ago
JSON representation
:video_game: An Unofficial Overwatch Stats API
- Host: GitHub
- URL: https://github.com/s32x/ovrstat
- Owner: s32x
- License: bsd-3-clause
- Archived: true
- Created: 2016-07-16T22:11:34.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-10-01T22:59:05.000Z (about 2 years ago)
- Last Synced: 2024-06-20T12:50:48.082Z (5 months ago)
- Topics: api, blizzard, container, docker, golang, overwatch, overwatch-api, stats
- Language: Go
- Homepage: https://ovrstat.com
- Size: 11.3 MB
- Stars: 98
- Watchers: 7
- Forks: 18
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-overwatch - ovrstat - 🎮 A Fast and Detailed Unofficial Overwatch Stats API written in Go. (Community / Github)
README
# The Public Ovrstat API was shutdown on October 1st 2022 and this project has been archived. Please check out [ow-api](https://ow-api.com/docs/) as a possible alternative.
`ovrstat` is a simple web scraper for the Overwatch stats site that parses and serves the data retrieved as JSON. Included is the go package used to scrape the info for usage in any go binary. This is a single endpoint web-scraping API that takes the full payload of information that we retrieve from Blizzard and passes it through to you in a single response. Things like caching and splitting data across multiple responses could likely improve performance, but in pursuit of keeping things simple, ovrstat does not implement them.
## Getting Started
### Installing Locally with Go
To start using ovrstat on your local system, install Go and run `go get`:
```
$ go get github.com/s32x/ovrstat
```
This will install the ovrstat service on your machine. Running the following will then launch the service.
```
$ ovrstat
```
### Local API Usage
Below is an example of using the REST endpoint (note: CASE matters for the username/tag):
```
http://localhost:8080/stats/pc/Viz-1213
http://localhost:8080/stats/xbl/Lt%20Evolution
http://localhost:8080/stats/psn/TayuyaBreast
http://localhost:8080/stats/nintendo-switch/Mario-70af1a16ae4913bde139d46edb43df55
```
### Using Go to retrieve Stats
```go
package main
import (
"log"
"github.com/s32x/ovrstat/ovrstat"
)
func main() {
log.Println(ovrstat.PCStats("Viz-1213"))
log.Println(ovrstat.ConsoleStats(ovrstat.PlatformXBL, "Lt%20Evolution"))
log.Println(ovrstat.ConsoleStats(ovrstat.PlatformPSN, "TayuyaBreast"))
log.Println(ovrstat.ConsoleStats(ovrstat.PlatformNS, "Mario-70af1a16ae4913bde139d46edb43df55"))
}
```
## Disclaimer
ovrstat isn’t endorsed by Blizzard and doesn’t reflect the views or opinions of Blizzard or anyone officially involved in producing or managing Overwatch. Overwatch and Blizzard are trademarks or registered trademarks of Blizzard Entertainment, Inc. Overwatch © Blizzard Entertainment, Inc.
The BSD 3-clause License
========================
Copyright (c) 2022, s32x. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
- Neither the name of ovrstat nor the names of its contributors may
be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.