Skip to main content

Async wrapper for the faceit API for csgo

Project description

Async faceit API

Async wrapper for the faceit API for csgo.

Here are the docs

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')

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()

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for async_faceit_api-0.1.1.tar.gz
Algorithm Hash digest
SHA256 cc2cde1ba99f6633ec812b13f7403c57c65819f92c8374bbaf82ee5968d9b6c8
MD5 0d5b21b7fe44641186fd4c3f5bd6b7c2
BLAKE2b-256 44af4ccbc59754da4ac9179defa226017dcbc4dd340734d2022ddff796aa1cc1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for async_faceit_api-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c74af3e7ab17c9bc5cda7a93df5b96a5432273220a65e5637d46bdb48925422f
MD5 8f217e1a4dec64e0c8654c267ff810f7
BLAKE2b-256 95420e292bab3a0ae4b8b1d785fbac722a6f2639828b5dee9425c4000d8ba548

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