This project was cancelled in June 2023 and archived due to limitations in the API.

Apex Legends Data Tool (apex-dt)

A cross-platform text-based client for the Apex Legends Status API written in Python.

Table of Contents

1. Background
2. Install
   • Via PyPI
   • Via GitHub
   • Setting up your credentials
3. Usage
4. Information currently available through apex-dt
5. Requirements
6. Limitations
7. Acknowledgements
8. Contributing
9. License

Background

I made apex-dt to solve two problems:

• I wanted to be able to get useful information quickly while I'm in a game or matchmaking queue, without needing to open my browser, navigate to some website, search for the info, distinguish ads from content, etc.

• I also wanted to capture my match history and save it in a structured database, so that I can do my own analysis with tools of my choice, and not need to rely on third party tools.

Install

Install apex-dt using one of the following methods.

Via PyPI.org

TODO. Coming soon!

pip install apex-dt

Via GitHub

git clone https://github.com/1npo/apex-dt.git
cd apex-dt
pip install .

Setting up your credentials

TODO: ...

Usage

TODO: ...

Information currently available through apex-dt

apex-dt makes the following information available:

• All the information made available through my apex-wiki-get package.
• Information made available through Hugo's Apex Legends API:
  • General player stats for the players you're tracking
  • Match history for the players you're tracking
  • Current crafting rotation
  • Current map rotation
  • Predator/other leaderboards
  • Server status
  • Apex Legends News

Please see the TODO file for features I'm working on, and the change log for the features added in each version.

Requirements

This section was last updated on 2022-Dec-4.

• You must link your Apex Legends account to Apex Legends Status.
  1. Create a free account at the Apex Legends Status website.
  2. Follow the instructions on the "Link Apex Legends Account" page of your account page.
• You must have an API key.
  • You can create one for free at the API portal.
• To use the "Match History" and "Shop History" endpoints:
  • You must be a Tier3 subscriber to Hugo's Patreon page.
  • You must be whitelisted to use each API.
    1. Once you're a T3 Patreon subscriber, submit a ticket in the #open-ticket channel on the Apex Legends Status Discord Server.
    2. Ask to be whitelisted for each API you plan to use, and give Hugo your API key and Patreon email address.

Limitations

• The "Match History" endpoint will only return data for the legend you currently have selected.
  • To get data for another legend:
    1. Open Apex Legends
    2. Click "Legends" on the top bar
    3. Pick the legend that you want to get data for
    4. Refresh your match history data in apex-dt

Acknowledgements

A big thanks to Hugo Derave for creating, maintaining, and hosting both Apex Legends Status and the unofficial Apex Legends API. This project wouldn't be possible without his efforts.

Contributing

PRs are welcome. Please see the contributing file before submitting a PR.

License

MIT © 2022 1npo