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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for async_faceit_api-0.1.4.tar.gz
Algorithm Hash digest
SHA256 add5fa3064c2a41e4853d4b0871015e3afd2ae650f8f94cff91ba42e8690f8ae
MD5 960bb3e978f4ae6682a5b0a9c6094f6e
BLAKE2b-256 b63e6d05ebbdd00fce8249c585afe2e17a0a3c2fd312ac261d0e8f58f29f83ed

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for async_faceit_api-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2c85cc444c99becbb298d124eaafa60bb91492e976610bea43643f22fc319560
MD5 2a23aad64de47c2f04a09275d447d2ca
BLAKE2b-256 09b1eac579899651a39dec5e074a43c0600d4d9d1f8b7b4546a518d975bd647e

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