Skip to main content

Async wrapper for the faceit API

Project description

Async faceit API

Async wrapper for the faceit API.

Here are the docs

Getting started

If you dont already have a loop in your programm you need to create one. Here is a basic example which will search players by the username and prints out a dict with the nicknames and player_ids:

import asyncio
from src.async_faceit_api import FaceitAPI


async def my_task():
    api_key = "..."
    api = FaceitAPI(api_key)
    players = await api.search_players("username")
    print({player.nickname: player.player_id for player in players.items})


if __name__ == "__main__":
    loop = asyncio.new_event_loop()
    loop.run_until_complete(my_task())
    loop.close()

Its recomended to store the api_key somewhere safe (e.g .env file)! Here is another example on how you can implement the api:

class MyApi(FaceitAPI):
    def __init__(self):
        api_key = os.getenv('faceit_api_key')
        super().__init__(api_key)

    async def get_played_maps_parallel(self, player_id):
        matches = await self.player_history(player_id, Game.CS_GO)
        all_match_stats = await asyncio.gather(*[self.match_stats(match.match_id) for match in matches.items])
        maps = {}
        for match_stat in all_match_stats:
            match_stat: MatchStats
            map = match_stat.rounds[0].round_stats['Map']
            if map in maps:
                maps[map] += 1
            else:
                maps[map] = 1
        return maps


async def my_task():
    api = MyApi()
    player_id = "..."
    print(await api.get_played_maps_parallel(player_id))


if __name__ == "__main__":
    loop = asyncio.new_event_loop()
    loop.run_until_complete(my_task())
    loop.close()

Error Handling

Note that the async api methods return an object of type FaceitApiError if the request was not successful. To distinguish between a successful response and an error, you can easily use the object as a boolean expression:

    games = await api.games()
    if games:
        print('success')
    else:
        print('error')

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

async_faceit_api-0.1.5.tar.gz (22.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

async_faceit_api-0.1.5-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

Details for the file async_faceit_api-0.1.5.tar.gz.

File metadata

  • Download URL: async_faceit_api-0.1.5.tar.gz
  • Upload date:
  • Size: 22.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.7

File hashes

Hashes for async_faceit_api-0.1.5.tar.gz
Algorithm Hash digest
SHA256 0a795f41f847b3d16a867b1f3e34e9a14ae1fcbf5fa5188e5f6714d65397c1c2
MD5 d247a4c4b49da11481d3051d3e919873
BLAKE2b-256 ccd3b3c405f49e1f18580b56ad6da2ea73e0a574cc7d04798aeb6f3385f6b5cf

See more details on using hashes here.

File details

Details for the file async_faceit_api-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for async_faceit_api-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d659aec906fe09e00af31cef79277f4d1b7715ef64ee19c857c4697134ef1473
MD5 4c75e4e7e8906b315ee0b0a2ae9c9fcb
BLAKE2b-256 7f92a1899603f6685ff52ebabeaf97ab23a138699d8473628ff961ef669f5605

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page