ToneAPI/ToneAPI_backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
bd06e3f5e2d6c29a8a7ce74aaa6b1e1b653298cf
ToneAPI_backend/docs/openapi.md
T
legonzaur 86118d37f2 update documentation
2023-04-04 18:31:24 +02:00

17 KiB
Raw Blame History

title, language_tabs, language_clients, toc_footers, includes, search, highlight_theme, headingLevel
title language_tabs language_clients toc_footers includes search highlight_theme headingLevel
ToneAPI v1.0
javascript
JavaScript
javascript
request.
true darkula 2

ToneAPI v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Stats tracking API for Titanfall 2 Northstar

Base URLs:

Web: Legonzaur License: The Unlicense

Authentication

  • HTTP Authentication, scheme: basic

Default

get-server-list

Code samples


const headers = {
  'Accept':'application/json'
};

fetch('https://tone.sleepycat.date/v1/client/servers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /client/servers

List of servers

An array containing the list of servers as objects

Example responses

OK

[
  {
    "id": 1,
    "name": "fvnknoots 7v7"
  }
]

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» Server object false none none
»» id integer false none none
»» name string false none none

get-client-weapons

Code samples


const headers = {
  'Accept':'application/json'
};

fetch('https://tone.sleepycat.date/v1/client/weapons',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /client/weapons

Statistics for all weapons

A JSON Object with weapon IDs as key and weapon data as value

Body parameter

Parameters

Name In Type Required Description
server query number false Fetch data for specific server
player query number false Fetch data for specific player

Example responses

OK

{
  "hemlock": {
    "max_kill_distance": 0,
    "avg_kill_distance": 0,
    "kills": 0
  },
  "lstar": {
    "max_kill_distance": 0,
    "avg_kill_distance": 0,
    "kills": 0
  }
}

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» hemlock object false none none
»» max_kill_distance integer false none none
»» avg_kill_distance number false none none
»» kills integer false none none

get-client-weapons-weaponId

Code samples


const headers = {
  'Accept':'application/json'
};

fetch('https://tone.sleepycat.date/v1/client/weapons/{weaponId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /client/weapons/{weaponId}

Statistics for a single weapon

Data for a specific weapon

Body parameter

Parameters

Name In Type Required Description
server query number false Fetch data for specific server
player query number false Fetch data for specific player
weaponId path string true ID of a weapon

Example responses

200 Response

{
  "max_kill_distance": 0,
  "avg_kill_distance": 0,
  "kills": 0
}

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Weapon

Name Type Required Restrictions Description
» max_kill_distance integer false none none
» avg_kill_distance number false none none
» kills integer false none none

get-client-players

Code samples


const headers = {
  'Accept':'application/json'
};

fetch('https://tone.sleepycat.date/v1/client/players',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /client/players

Statistics for all players

A JSON Object with player IDs as key and player data as value

Parameters

Name In Type Required Description
weapon query string false Fetch data for specific weapon
server query number false Fetch data for specific server

Example responses

OK

{
  "2250125460": {
    "name": "Legonzaur",
    "deaths": 0,
    "kills": 0,
    "max_kill_distance": 0,
    "avg_kill_distance": 0
  }
}

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» 2250125460 object false none none
»» name string false none none
»» deaths integer false none none
»» kills integer false none none
»» max_kill_distance integer false none none
»» avg_kill_distance number false none none

get-client-players-playerId

Code samples


const headers = {
  'Accept':'application/json'
};

fetch('https://tone.sleepycat.date/v1/client/players/{playerId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /client/players/{playerId}

Statistics for a single player

Data for a specific player

Parameters

Name In Type Required Description
server query number false Fetch data for specific server
weapon query string false Fetch data for specific weapon
playerId path string true ID of a player

Example responses

200 Response

{
  "name": "Legonzaur",
  "deaths": 0,
  "kills": 0,
  "max_kill_distance": 0,
  "avg_kill_distance": 0
}

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Player

Name Type Required Restrictions Description
» name string false none none
» deaths integer false none none
» kills integer false none none
» max_kill_distance integer false none none
» avg_kill_distance number false none none

post-servers-serverId

Code samples


fetch('https://tone.sleepycat.date/v1/servers/{serverId}',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /servers/{serverId}

Used to test auth

Parameters

Name In Type Required Description
serverId path string true ID of the server

Responses

Status Meaning Description Schema
200 OK OK None
403 Forbidden Forbidden None

post-kills

Code samples

const inputBody = '{
  "tone_version": "string",
  "match_id": "string",
  "game_mode": "string",
  "map": "string",
  "game_time": "14:15:22Z",
  "player_count": 0,
  "attacker_name": "string",
  "attacker_id": 0,
  "attacker_current_weapon": "string",
  "attacker_current_weapon_mods": 0,
  "attacker_weapon_1": "string",
  "attacker_weapon_1_mods": 0,
  "attacker_weapon_2": "string",
  "attacker_weapon_2_mods": 0,
  "attacker_weapon_3": "string",
  "attacker_weapon_3_mods": 0,
  "attacker_offhand_weapon_1": 0,
  "attacker_offhand_weapon_2": 0,
  "victim_name": "string",
  "victim_id": 0,
  "victim_current_weapon": "string",
  "victim_current_weapon_mods": 0,
  "victim_weapon_1": "string",
  "victim_weapon_1_mods": 0,
  "victim_weapon_2": "string",
  "victim_weapon_2_mods": 0,
  "victim_weapon_3": "string",
  "victim_weapon_3_mods": 0,
  "victim_offhand_weapon_1": 0,
  "victim_offhand_weapon_2": 0,
  "cause_of_death": "string",
  "distance": 0
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('https://tone.sleepycat.date/v1/servers/{serverId}/kills',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /servers/{serverId}/kills

Post kills

Allows a Northstar server to record kills on the database

Body parameter

{
  "tone_version": "string",
  "match_id": "string",
  "game_mode": "string",
  "map": "string",
  "game_time": "14:15:22Z",
  "player_count": 0,
  "attacker_name": "string",
  "attacker_id": 0,
  "attacker_current_weapon": "string",
  "attacker_current_weapon_mods": 0,
  "attacker_weapon_1": "string",
  "attacker_weapon_1_mods": 0,
  "attacker_weapon_2": "string",
  "attacker_weapon_2_mods": 0,
  "attacker_weapon_3": "string",
  "attacker_weapon_3_mods": 0,
  "attacker_offhand_weapon_1": 0,
  "attacker_offhand_weapon_2": 0,
  "victim_name": "string",
  "victim_id": 0,
  "victim_current_weapon": "string",
  "victim_current_weapon_mods": 0,
  "victim_weapon_1": "string",
  "victim_weapon_1_mods": 0,
  "victim_weapon_2": "string",
  "victim_weapon_2_mods": 0,
  "victim_weapon_3": "string",
  "victim_weapon_3_mods": 0,
  "victim_offhand_weapon_1": 0,
  "victim_offhand_weapon_2": 0,
  "cause_of_death": "string",
  "distance": 0
}

Parameters

Name In Type Required Description
body body object false none
» id body integer false none
» server body string false none
» tone_version body string false none
» match_id body string false none
» game_mode body string false none
» map body string false none
» game_time body string(time) false none
» player_count body integer false none
» attacker_name body string false none
» attacker_id body integer false none
» attacker_current_weapon body string false none
» attacker_current_weapon_mods body integer false none
» attacker_weapon_1 body string false none
» attacker_weapon_1_mods body integer false none
» attacker_weapon_2 body string false none
» attacker_weapon_2_mods body integer false none
» attacker_weapon_3 body string false none
» attacker_weapon_3_mods body integer false none
» attacker_offhand_weapon_1 body integer false none
» attacker_offhand_weapon_2 body integer false none
» victim_name body string false none
» victim_id body integer false none
» victim_current_weapon body string false none
» victim_current_weapon_mods body integer false none
» victim_weapon_1 body string false none
» victim_weapon_1_mods body integer false none
» victim_weapon_2 body string false none
» victim_weapon_2_mods body integer false none
» victim_weapon_3 body string false none
» victim_weapon_3_mods body integer false none
» victim_offhand_weapon_1 body integer false none
» victim_offhand_weapon_2 body integer false none
» cause_of_death body string true none
» distance body number false none
serverId path string true ID of the server

Responses

Status Meaning Description Schema
201 Created Created None
400 Bad Request Bad Request None
401 Unauthorized Unauthorized None

Schemas

Player

{
  "name": "Legonzaur",
  "deaths": 0,
  "kills": 0,
  "max_kill_distance": 0,
  "avg_kill_distance": 0
}

Player

Properties

Name Type Required Restrictions Description
name string false none none
deaths integer false none none
kills integer false none none
max_kill_distance integer false none none
avg_kill_distance number false none none

Weapon

{
  "max_kill_distance": 0,
  "avg_kill_distance": 0,
  "kills": 0
}

Weapon

Properties

Name Type Required Restrictions Description
max_kill_distance integer false none none
avg_kill_distance number false none none
kills integer false none none

Server

{
  "id": 1,
  "name": "fvnknoots 7v7"
}

Server

Properties

Name Type Required Restrictions Description
id integer false none none
name string false none none

Kill

{
  "id": 0,
  "server": "string",
  "tone_version": "string",
  "match_id": "string",
  "game_mode": "string",
  "map": "string",
  "game_time": "14:15:22Z",
  "player_count": 0,
  "attacker_name": "string",
  "attacker_id": 0,
  "attacker_current_weapon": "string",
  "attacker_current_weapon_mods": 0,
  "attacker_weapon_1": "string",
  "attacker_weapon_1_mods": 0,
  "attacker_weapon_2": "string",
  "attacker_weapon_2_mods": 0,
  "attacker_weapon_3": "string",
  "attacker_weapon_3_mods": 0,
  "attacker_offhand_weapon_1": 0,
  "attacker_offhand_weapon_2": 0,
  "victim_name": "string",
  "victim_id": 0,
  "victim_current_weapon": "string",
  "victim_current_weapon_mods": 0,
  "victim_weapon_1": "string",
  "victim_weapon_1_mods": 0,
  "victim_weapon_2": "string",
  "victim_weapon_2_mods": 0,
  "victim_weapon_3": "string",
  "victim_weapon_3_mods": 0,
  "victim_offhand_weapon_1": 0,
  "victim_offhand_weapon_2": 0,
  "cause_of_death": "string",
  "distance": 0
}

Kill

Properties

Name Type Required Restrictions Description
id integer false read-only none
server string false read-only none
tone_version string false none none
match_id string false none none
game_mode string false none none
map string false none none
game_time string(time) false none none
player_count integer false none none
attacker_name string false none none
attacker_id integer false none none
attacker_current_weapon string false none none
attacker_current_weapon_mods integer false none none
attacker_weapon_1 string false none none
attacker_weapon_1_mods integer false none none
attacker_weapon_2 string false none none
attacker_weapon_2_mods integer false none none
attacker_weapon_3 string false none none
attacker_weapon_3_mods integer false none none
attacker_offhand_weapon_1 integer false none none
attacker_offhand_weapon_2 integer false none none
victim_name string false none none
victim_id integer false none none
victim_current_weapon string false none none
victim_current_weapon_mods integer false none none
victim_weapon_1 string false none none
victim_weapon_1_mods integer false none none
victim_weapon_2 string false none none
victim_weapon_2_mods integer false none none
victim_weapon_3 string false none none
victim_weapon_3_mods integer false none none
victim_offhand_weapon_1 integer false none none
victim_offhand_weapon_2 integer false none none
cause_of_death string true none none
distance number false none none
Reference in New Issue View Git Blame Copy Permalink