MozambiqueAPI
Core of mozambique-api-wrapper
Kind: global class
-
MozambiqueAPI
- new MozambiqueAPI(apiKey)
-
.search(query) =>
JSON
Object
-
.news([lang]) =>
JSON
Array
-
.server() =>
JSON
-
.server() =>
ServerStatus
-
.history(query) =>
JSON
Object
-
..gamedatagamedata((dataTypedataType))=>=>JSON
Object
-
.mapRotation() =>
JSON
new MozambiqueAPI(apiKey)
Core of mozambique-api-wrapper
Param | Type | Description |
---|---|---|
apiKey | String | Your mozambiquehe.re Auth Key |
Param | Type | Description |
---|---|---|
apiKey | String | Your apexlegendsapi Auth Key |
mozambiqueAPI.search(query) => JSON
Object
JSON
Search a player using player name or UID
Kind: instance method of MozambiqueAPI
Returns: JSON
- JsonObject
- Object with player info
Param | Type | Description |
---|---|---|
query | Any | Query parameters |
[query.player] | String | Player name |
[query.uid] |
String | Number
| Player UID |
[query.platform] | String | Player platform (PC, PS4, X1) |
Param | Type | Description |
---|---|---|
query | Object | Query parameters |
[query.player] | String | Player name |
[query.uid] |
String | Number
| Player UID |
[query.platform] | String | Player platform (PC, PS4, X1) |
mozambiqueAPI.news([lang]) => JSON
Array
JSON
Get recent news about Apex Legends
Kind: instance method of MozambiqueAPI
Returns: JSON
- Json with an arrayArray
- Array of Apex Legends news
Param | Type | Default | Description |
---|---|---|---|
[lang] | String | "en-us" | News language |
Param | Type | Default | Description |
---|---|---|---|
[lang] | String | "en-us" | Language of the news |
mozambiqueAPI.server() => JSON
ServerStatus
JSON
Get server status for Origin, EA, Apex Legends and Mozambiquehe.reapexlegendsapi API
Kind: instance method of MozambiqueAPI
Returns: JSON
- JsonServerStatus
- Object with status of all servers
mozambiqueAPI.history(query) => JSON
Object
JSON
Avaliable for everyone but with limitations depending on your api access type
Kind: instance method of MozambiqueAPI
Returns: JSON
Object
- JsonObject differs depending on action parameter. Please refer to API documentation for more info (https://mozambiquehe.re/api)
Param | Type | Description |
---|---|---|
query | Any | Query parameters |
[query.player] | String | Player name |
[query.uid] |
String | Number
| Player UID |
[query.platform] | String | Player platform (PC, PS4, X1) |
[query.action] | String | Action for the Match History API (info, get, delete, add) |
Param | Type | Description |
---|---|---|
query | Object | Query parameters |
[query.player] | String | Player name |
[query.uid] |
String | Number
| Player UID |
[query.platform] | String | Player platform (PC, PS4, X1) |
[query.action] | String | Action for the Match History API (info, get, delete, add) |
mozambiqueAPI.gamedata(dataType) => JSON
mozambiqueAPI.gamedata(dataType) => Object
JSON
Get all game data avaliable on mozambiquehe.re separated by data type
Deprecated
WARNING: endpoint data not updated anymore
Avaliable data types: assault_rifles, attachments, consumables, equipment, grenades, legends, light_machine_guns, pistols, shotguns, sniper_rifles, sub_machine_guns
Kind: instance method of MozambiqueAPI
Returns: JSON
- JsonObject
- Object with requested game data
Param | Type | Description |
---|---|---|
dataType | String | Type of data requested |
mozambiqueAPI.mapRotation() => JSON
Get the map rotation
Kind: instance method of MozambiqueAPI
Returns: JSON
- Json with map rotation data
Param | Type | Description |
---|---|---|
dataType | String | Type of data requested |