An open API service indexing awesome lists of open source software.

https://github.com/anthok/overwatch-api

Python Overwatch API Wrapper
https://github.com/anthok/overwatch-api

api overwatch overwatch-api python

Last synced: 3 months ago
JSON representation

Python Overwatch API Wrapper

Awesome Lists containing this project

README

          

# overwatch-api
Python Overwatch API

## Install
Requires Python 3.5 or greater!

``` bash
pip install overwatch-api
```

### [0.5.0] - 2017-04-21
#### Changes
- Now using Async, thanks @Drummersbrother!
- Moving API provider to OWAPI, thanks @Drummersbrother!

## Example Code - Supported calls
A segment from example_test.py, which can provide more info on how to use the API.

#### Call
``` python
get_profile(self, battletag: str, regions=(EUROPE, KOREA, AMERICAS, CHINA, JAPAN, ANY),
platform=None, _session=None, handle_ratelimit=None, max_tries=None, request_timeout=None)

#Platform defaults to PC if not specified.
#Session can be passed through for a custom aiohttp.Client.
client.get_profile("Danielfrogs#2552")
```

#### Code
``` python
import asyncio, aiohttp
from overwatch_api.core import AsyncOWAPI
from overwatch_api.constants import *

client = AsyncOWAPI()
await client.get_profile("Danielfrogs#2552", platform=PC)
await client.get_stats("Danielfrogs#2552", platform=XBOX)
await client.get_achievements("Danielfrogs#2552", platform=PLAYSTATION)
await client.get_hero_stats("Danielfrogs#2552")
```

## Testing (Not working in 0.5 yet!)

``` bash
python setup.py test
```

## Deprecated Calls (0.4 and below)
``` python
from overwatch_api import *

ow = OverwatchAPI()

ow.get_patch_notes()
ow.get_achievements(PC,AMERICAS,'elyK-1940')
ow.get_platforms(PC,AMERICAS,'elyK-1940')
ow.get_profile(PC,AMERICAS,'elyK-1940')
ow.get_stats_all_heroes(PC,AMERICAS,'elyK-1940',COMP)
ow.get_stats_selected_heroes(PC,AMERICAS,'elyK-1940',COMP,[heroes['MERCY'],heroes['LUCIO']])
ow.get_stats_heroes_used(PC,AMERICAS,'elyK-1940',COMP)
```