Documentation

Found a bug? A question?

Open a ticket on discord, or PM HeyImLifeline (hugo#0069) :-) Discord here

API Key

By generating an API key, you accept that your account can be suspended without any notice and for any reason. It's also highly recommended to join our Discord for any support & info.


Project URL (not required):


(Very) short usage description:

Player stats API

Basic query

Endpoint: https://api.mozambiquehe.re/bridge / Parameters: version [1,2,4,5], 5 is the default one and the only one actively supported. | Platform [PC,PS4,X1], Nintendo Switch users cannot be fetched. For PC player, you must use the Origin account name linked to the Steam account otherwise you may run into errors. | Auth [YOURAPIKEY], use the API key generated.

Authorization You can either put your API Key as a GET parameter in your query ("auth") or use an "Authorization" header with your API Key.

Request example:

GET https://api.mozambiquehe.re/bridge?version=5&platform=PC&player=HeyImLifeline&auth=YOURAPIKEY

You can also query multiple players at the same time, response will be as an array of players. The more players you add, the longer the query will take:

GET https://api.mozambiquehe.re/bridge?version=5&platform=PC&player=PlayerA,PlayerB,PlayerC&auth=YOURAPIKEY

UID query

You can query users by their UIDs, multiple UID queries will also work with the syntax above. Example query:

GET https://api.mozambiquehe.re/bridge?platform=PC&uid=1000575543540&auth=YOURAPIKEY

API response

The response will be as follows, for version 5

"global" -> Contains main account data, such as avatar, name, UID, ranked informations and battlepass data (For battlepass data to be displayed, the user must have the Battlepass badge displayed on his currently selected legend). The "badges" array contains all ACCOUNT WIDE saved badges in our database. Legend specific badges will be saved in the "legends" array.
"realtime" -> Contains some basic information about the account, such as the lobbyState (open/invite), if the player is in game, online or offline, if his party is full and his currently selected legend.
"legends" -> The currently selected legend will ONLY return currently selected trackers and badges. For past saved data, look into the "all" array. Each legend will be displayed in the "all" array, with current and past saved data for trackers and badges. Each tracker data saved will also include a "rank" array, which is the player ladder position from our database. This value is updated each 6 hours, and will return a string "NOT_CALCULATED_YET" if it has not been updated yet. The lower topPercent is, the better.
"total" -> A sum of each stats saved from the player.
All stats trackers keys can be found on https://api.mozambiquehe.re/keydump.txt

Match history API

This API is only available to Supporters

This API uses lots of server ressources. Only people who help us paying the bills get access to it. You can support us on Patreon, and you can ask questions on discord if needed.

Query structure

Like any other request, you must have an API key. It is highly to use UIDs instead of Names in this query, as if the user changes name, his data will no longer be saved anymore. DO NOT mix names and UIDs in your tracked players list. Only use one type.

An example query would be, with UIDs (you can replace uid=UID by name=NAME, like in the Stats API if you really want to):

GET https://api.mozambiquehe.re/bridge?uid=1000575543540&platform=PC&auth=YOURAPIKEY&history=1&action=info

The "history" parameter must be set to 1 to access the match history API. Data returned differs according to the "action" parameter


info

The action=info parameter will return the players you're currently tracking. If you're using UIDs, the name field will be replaced by uid as an int. "registered" is your total currently tracked players.

{ "registered": 2, "data": [ { "name": "mrc9h13n", "platform": "PC" }, { "name": "heyimlifeline", "platform": "PC" } ] }


get

This parameter will return ALL tracked events for the player given in the player and platform parameter. An example response would be

[ { "uid": "1000575543540", "player": "HeyImLIFELINE", "timestamp": "1575905943", "eventType": "Game", "xpProgress": "180", "gameLength": "3", "legendPlayed": "Lifeline", "event": [ { "value": 95, "key": "damage", "name": "Damage" }, { "value": 1, "key": "games_played", "name": "Games played" } ] }, { "uid": "1000575543540", "player": "HeyImLIFELINE", "timestamp": "1575905943", "eventType": "Session", "event": { "action": "leave", "sessionDuration": "9" } }, { "uid": "1000575543540", "player": "HeyImLIFELINE", "timestamp": "1575905673", "eventType": "Level", "event": { "newLevel": "89" } }, { "uid": "1000575543540", "player": "HeyImLIFELINE", "timestamp": "1575905673", "eventType": "Game", "xpProgress": "16740", "gameLength": "4", "legendPlayed": "Lifeline", "event": [ { "value": 1, "key": "games_played", "name": "Games played" } ] }, { "uid": "1000575543540", "player": "HeyImLIFELINE", "timestamp": "1575905403", "eventType": "Level", "event": { "newLevel": "88" } }, { "uid": "1000575543540", "player": "HeyImLIFELINE", "timestamp": "1575905403", "eventType": "Session", "event": { "action": "join" } } ]

There are 4 events tracked: Login, leave, level up, rank up and game played.

Game will return the data from the player's trackers displayed on his profile (max 3), the legend he was using, timestamp, XP progress (approx.) and the game duration.

delete

Removes the given user from the tracked users list. Will return your current registered users.


add

Add the given player to your current registered users. Maximum amount depends on your API access type.


Map rotation API

Return the current and next map in rotation for Battle Royale, Arenas and Ranked modes. Returned data should be self-explanatory.

GET https://api.mozambiquehe.re/maprotation?version=2&auth=YOURAPIKEY

News API

Simple.

Make a call with your API key to the following endpoint

GET https://api.mozambiquehe.re/news?lang=en-us&auth=YOURAPIKEY

You can change en-us by your wanted language.

Server status API

Gives Origin logins, EA novafusion, EA accounts, Apex Crossplay Oauth (any platform other than Mobile), our core systems and 3rd party gaming platforms (Xbox live/PSN). Update every 3 to 5 minutes. Status may be "UP", "DOWN", "SLOW", "OVERLOADED" or "NO DATA".

GET https://api.mozambiquehe.re/servers?auth=YOURAPIKEY

Origin/EA API

Used to query a player without getting his Apex Legends Stats. This player must however have already played Apex Legends, otherwise you will get a player not found error. If you want to find ANY player on ANY platform, see "Name to UID" API below.
the "showAllHits" parameter may be added to your request to show all users returned, instead of the player with the highest matching score.

GET https://api.mozambiquehe.re/origin?player=heyimlifeline&auth=YOURAPIKEY

Name to UID API

Used find the UID of a player on any platform, even if he has not played Apex before. Platforms may be [PC,PS4,X1] like Stats API.

GET https://api.mozambiquehe.re/nametouid?player=heyimlifeline&platform=PC&auth=YOURAPIKEY