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

Uploaded Python 3

File details

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

File metadata

  • Download URL: async_faceit_api-0.1.6.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.6.tar.gz
Algorithm Hash digest
SHA256 6f53ad179a549f20d46c1c7990f2a4e7c80e14e4cab15e09f5b43f7bdf545737
MD5 1790ca963446e99f1a76c35e3a8dc418
BLAKE2b-256 749812f9bf531a22f6efe6ee827eb1e889b9e6788ae23cd44fd9eb3703b53200

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for async_faceit_api-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 874b0d143d214c8e726140fec250595e50c11c69466e32de9a2110443bd9d812
MD5 2b54a07c064f038f5cec9b0dc3772555
BLAKE2b-256 10a2e0880f8fe2b009c62643f98dae268fcf91d40cb6241211d1ee6308687abe

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