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.7.tar.gz (23.0 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.7-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: async_faceit_api-0.1.7.tar.gz
  • Upload date:
  • Size: 23.0 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.7.tar.gz
Algorithm Hash digest
SHA256 0494d6debee805b45e43229004aaf08a66053546dbc0dcd947b4d81ac3561528
MD5 470bdd6397d13e1105ca3aab8694720c
BLAKE2b-256 27f68e89c02b87fec31f593d407504d2a308f5a6f39e76548eaf29ef93614e5b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for async_faceit_api-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 204cea1bd29e9ca4a76ab1567e3349c7fd6de789bf179e4264aef1b0c2b30cbb
MD5 87f965ad57a136b85664ddcbc63a679f
BLAKE2b-256 ccb1e86985106f6355e3aa76da49c778a740a01fb2707f86819a3b786ed15d6e

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