Skip to main content

Python wrapper for https://apexlegendsapi.com

Project description

apex-legends-api

Python wrapper for https://apexlegendsapi.com

Downloads

Installation

You can install it from source, or pip (recommended)

Requirements

python >= 3.9

Source installation

python ./setup.py install

Pip installation

pip install apex-legends-api

Usage

  • Register for an API Key at Apex Legends API
  • Here's a quick snippet to get started
  • All method calls return a dictionary representing the JSON in the response.
import sys
from apex_legends_api import ApexLegendsAPI,\
    ALPlatform,\
    ALPlayer,\
    ALAction,\
    ALHTTPExceptionFromResponse
from apex_legends_api.al_base import print_description

api = ApexLegendsAPI(api_key='<api_key>')

player_name = str("PlayerName")
player_uid = str("1234567890")
platform = ALPlatform.PC
action = ALAction.GET

# Example 1:
# straight API calls
try:
    basic = api.basic_player_stats(player_name=player_name, platform=platform)
    # or query by UID
    # basic = api.basic_player_stats_by_uid(uid=player_uid, platform=platform)
    history = api.events(player_name=player_name, platform=platform, action=action)
    origin_player = api.get_player_origin(player_name=player_name, show_all_hits=True)
except ALHTTPExceptionFromResponse as exception:
    print(exception)
    sys.exit()

print(basic)
print(history)
print(origin_player)

# Example 2:
# retrieve an 'ALPlayer' object
player: ALPlayer = api.get_player(name=player_name, platform=platform)
print_description(player)

Notes

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

apex-legends-api-2.0.3.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

apex_legends_api-2.0.3-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

Details for the file apex-legends-api-2.0.3.tar.gz.

File metadata

  • Download URL: apex-legends-api-2.0.3.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for apex-legends-api-2.0.3.tar.gz
Algorithm Hash digest
SHA256 e9cc411edc6516d6ff0ef48ce7cd71797fb3365d453fb6d26dc7b7f929915e33
MD5 205fd4302b56c42eaacaf45ade09bf7d
BLAKE2b-256 1d6f1b8d92f9fc2dd9f56cb9666630e1edaa50f65d99cc9dbecd8f3933a0e1de

See more details on using hashes here.

File details

Details for the file apex_legends_api-2.0.3-py3-none-any.whl.

File metadata

  • Download URL: apex_legends_api-2.0.3-py3-none-any.whl
  • Upload date:
  • Size: 10.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for apex_legends_api-2.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c352819357b761e6d20f0571882151c3425d60854469279eabb190e59e4e7c47
MD5 b8ad41fa1805c21fd61958c472b9a02b
BLAKE2b-256 3f607edb39387385162da20959ab1f1ec19641c833d0a6c1c7350d4b282602d6

See more details on using hashes here.

Supported by

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