stunlockstudios / battlerite-docs Goto Github PK
View Code? Open in Web Editor NEWDocumentation and Guides
battlerite-docs's People
Contributors
Stargazers
Watchers
Forkers
sime1battlerite-docs's Issues
Team data undocumented makes it hard to make 'correct' calls
Heya!
I'd love to start contributing more actively to this API, as I am in the process of exploring the API and building an application with it.
That being said, I'm noticing a fallacy in the team call (https://github.com/gamelocker/battlerite-docs/blob/master/source/teams/teams.rst).
First of, I don't know which number for season should be used, I think this could use more documentation.
I'm guessing 6, from the example - although the game is actually currently running its first real season? This needs clearing up :)
Second, I used this call:
https://api.dc01.gamelockerapp.com/shards/global/teams?tag[season]=6&tag[playerIds]=786946724437581824,786630647182667776 which uses mine and a friends ID, and it returns a lot of teams: Even nameless ones. Why is this?
I do see one, I believe to be a real team, which has the 'name' field filled out, but what are all the 'empty' ones? And why are so many returned?
I'd love clearing this up, I'm unsure if I even make the correct API calls, since the lack of documentation.
I'd love to help fill it out too, if only I knew more!
Let me know how I can help further.
Best
Match parameters
I'm using endpoint like this;
https://api.dc01.gamelockerapp.com/shards/global/matches?sort=-createdAt&page[limit]=20&filter[playerIds]=XXX
But it doesn't give matches that are at least 15 minutes old. Can I make it receive matches that are just finished with filters? I tried createdAt-start/end but couldn't achieve anything.
Making requests for player, based on name rather than id
Just comparing this feature visually to another application such as porofessor.gg, it may seem odd to many users of the api to have to use their player ID rather than their player name.
I don't even remember how I found my playerID, but I do remember something about grabbing my steam ID first.
Is it possible, to implement the feature of making a lookup based on playername?
Does the api not currently support it? If so, are Stunlock maintaining and developing it?
Can we search for a player via there username please?
Or is there a simpler method of getting an userID than searching output files?
Players' stats mapping
Hello guys, first of all thanks for the awesome api you made!
But i have a big unanswered question:
What does all the number in the player's stats refers to?
I can retro engineer to find that 12011 represents the game won with Poloma, but it's a really painstacking thing to do with all those values...
Filtering players by playerNames / steamIds
Hi,
I'm trying to use the API to return player data from a given playername, but so far have been unable.
I have been able to receive player data by filtering by playerId, but this doesn't seem particularly useful as a player is unlikely to know their playerId.
Below is the code I have been using in Java to try and get player data
URL url = new URL("https://api.dc01.gamelockerapp.com/shards/global/players?filter[playerNames]=Averse");
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Authorization"," Obviously removed my key");
conn.setRequestProperty("Accept", "application/vnd.api+json");
BufferedReader in = new BufferedReader(new InputStreamReader(conn.getInputStream()));
String inputLine;
while ((inputLine = in.readLine()) != null)
System.out.println(inputLine);
in.close();`
The response that I get from this request is as below, obviously this isn't the desired response.
{
"data":[
],
"links":{
"self":"https://api.dc01.gamelockerapp.com/shards/global/players?filter[playerNames]=Averse"
},
"meta":{
}
}
I have also tried filtering by steamId as a possible work around, but this results in a FileNotFoundException.
Any help would be appreciated!
/teams endpoint using userID instead of accountId
This is coming from the teams endpoint,
I requested with season=6 and playerIds=805576310947717120
If we look at the telemetry from a ranked matched that I played, you can see the same ID ending in 00 here:
Scattered throughout the telemetry data, you can see userId and accountId being used interchangeably - This is probably causing you some issues.
Can the examples include PHP
Is it possible to add the PHP version of how you do stuff to the examples ?
Champion data
Is there no way to pull champion data, or find corresponding information about champions?
If you pull data using the player call (example: https://api.dc01.gamelockerapp.com/shards/global/players/786946724437581824), it returns an array of stats.
However these stats are just numbers, and I'm unsure what they represent. I would guess champions from 1 through 100, and something else for the numbers of 10.000+.
I don't know what though.
Is it possible to document this, so it is possible to translate it into Champion names etc. when building an application?
Let me know what I can do to help!
Best
Spectators coming through as participants
If you look at participants, you'll see a bunch of players that have no details about them - except their IDs and championId 0.
** you might notice this JSON structure is a bit different than yours - we are doing a bit of data mapping for ease of use on our end.
{
"id":"857D0E69EF5F4C0EAF3A794E5BD1E6E9",
"createdAt":"2017-12-18T00:45:49.000Z",
"duration":583,
"gameMode":"1733162751",
"patchVersion":"39931",
"shardId":"global",
"matchType":"PRIVATE",
"mapId":"319DDC57E70174B6C85EF137BAF34E9E",
"map":{
"id":"319DDC57E70174B6C85EF137BAF34E9E",
"name":"Blackstone Arena - Night"
},
"links":{
"schema":"",
"self":"https://api.dc01.gamelockerapp.com/shards/global/matches/857D0E69EF5F4C0EAF3A794E5BD1E6E9"
},
"assets":[
{
"id":"3e7d0ee9-e38f-11e7-a8ef-0a586460f089",
"URL":"https://cdn.gamelockerapp.com/stunlock-studios-battlerite/global/2017/12/18/01/03/3e7d0ee9-e38f-11e7-a8ef-0a586460f089-telemetry.json",
"createdAt":"2017-12-18T01:03:22.000Z",
"description":"",
"name":"telemetry"
}
],
"rosters":[
{
"id":"e2f7be8c-2d96-485c-b137-7fd52cdeede4",
"shardId":"global",
"score":1,
"won":false,
"participants":[
{
"id":"c195076b-b2d9-4a67-b30d-83356ba8ee89",
"championId":"870711570",
"champion":{
"id":"870711570",
"name":"Destiny"
},
"shardId":"global",
"stats":{
"abilityUses":353,
"attachment":294066347,
"damageDone":2381,
"damageReceived":2625,
"deaths":5,
"disablesDone":429,
"disablesReceived":285,
"emote":1398835377,
"energyGained":1280,
"energyUsed":675,
"healingDone":73,
"healingReceived":1106,
"kills":3,
"mount":493133584,
"outfit":258487385,
"score":2883,
"side":1,
"timeAlive":322
},
"player":{
"id":"778276383183998976",
"name":"",
"patchVersion":"",
"shardId":"",
"stats":null,
"links":{
"schema":"",
"self":"https://api.dc01.gamelockerapp.com/shards//players/778276383183998976"
}
}
},
{
"id":"785dfe6a-360a-48fe-8a95-626583dbc5a4",
"championId":"369797039",
"champion":{
"id":"369797039",
"name":"Varesh"
},
"shardId":"global",
"stats":{
"abilityUses":350,
"attachment":706854042,
"damageDone":2298,
"damageReceived":3887,
"deaths":5,
"disablesDone":153,
"disablesReceived":347,
"emote":1653602285,
"energyGained":1394,
"energyUsed":1075,
"healingDone":1268,
"healingReceived":1504,
"kills":0,
"mount":1157189786,
"outfit":2063891754,
"score":3719,
"side":1,
"timeAlive":344
},
"player":{
"id":"7854",
"name":"",
"patchVersion":"",
"shardId":"",
"stats":null,
"links":{
"schema":"",
"self":"https://api.dc01.gamelockerapp.com/shards//players/7854"
}
}
},
{
"id":"bdc32286-b497-460b-bb8c-b8e3d32a85f5",
"championId":"1134478706",
"champion":{
"id":"1134478706",
"name":"Poloma"
},
"shardId":"global",
"stats":{
"abilityUses":459,
"attachment":2088268574,
"damageDone":1575,
"damageReceived":2565,
"deaths":5,
"disablesDone":203,
"disablesReceived":219,
"emote":1170337850,
"energyGained":1376,
"energyUsed":975,
"healingDone":2891,
"healingReceived":1045,
"kills":0,
"mount":1772305103,
"outfit":390954791,
"score":4669,
"side":1,
"timeAlive":321
},
"player":{
"id":"132",
"name":"",
"patchVersion":"",
"shardId":"",
"stats":null,
"links":{
"schema":"",
"self":"https://api.dc01.gamelockerapp.com/shards//players/132"
}
}
}
]
},
{
"id":"8d354e51-ebff-41dd-91aa-9e97a232fb9f",
"shardId":"global",
"score":5,
"won":true,
"participants":[
{
"id":"6da80b9b-6217-436b-94fd-d8fe3dfc4f14",
"shardId":"global",
"stats":{
"attachment":0,
"emote":0,
"mount":0,
"outfit":0,
"side":0
},
"player":{
"id":"778323489210900480",
"name":"",
"patchVersion":"",
"shardId":"",
"stats":null,
"links":{
"schema":"",
"self":"https://api.dc01.gamelockerapp.com/shards//players/778323489210900480"
}
}
},
{
"id":"34d7f316-2977-414b-9c5f-a4a4f44252c8",
"championId":"39373466",
"champion":{
"id":"39373466",
"name":"Jumong"
},
"shardId":"global",
"stats":{
"abilityUses":409,
"attachment":177447353,
"damageDone":3601,
"damageReceived":2260,
"deaths":1,
"disablesDone":469,
"disablesReceived":265,
"emote":553323459,
"energyGained":1906,
"energyUsed":1550,
"healingDone":324,
"healingReceived":1570,
"kills":7,
"mount":355237393,
"outfit":1471164257,
"score":4394,
"side":2,
"timeAlive":352
},
"player":{
"id":"776450744541908992",
"name":"",
"patchVersion":"",
"shardId":"",
"stats":null,
"links":{
"schema":"",
"self":"https://api.dc01.gamelockerapp.com/shards//players/776450744541908992"
}
}
},
{
"id":"524b853d-59d9-47de-8e24-10ec2edaa9ac",
"championId":"1134478706",
"champion":{
"id":"1134478706",
"name":"Poloma"
},
"shardId":"global",
"stats":{
"abilityUses":460,
"attachment":175987216,
"damageDone":2232,
"damageReceived":1292,
"deaths":1,
"disablesDone":164,
"disablesReceived":193,
"emote":1170337850,
"energyGained":1345,
"energyUsed":950,
"healingDone":2361,
"healingReceived":936,
"kills":3,
"mount":355237393,
"outfit":1421950681,
"score":4761,
"side":2,
"timeAlive":342
},
"player":{
"id":"784917280495644672",
"name":"",
"patchVersion":"",
"shardId":"",
"stats":null,
"links":{
"schema":"",
"self":"https://api.dc01.gamelockerapp.com/shards//players/784917280495644672"
}
}
},
{
"id":"ea498a8a-2478-4234-9c5a-f4f010d7ab66",
"championId":"763360732",
"champion":{
"id":"763360732",
"name":"Shifu"
},
"shardId":"global",
"stats":{
"abilityUses":458,
"attachment":24061436,
"damageDone":3593,
"damageReceived":2319,
"deaths":1,
"disablesDone":218,
"disablesReceived":327,
"emote":268615719,
"energyGained":1713,
"energyUsed":1000,
"healingDone":907,
"healingReceived":1429,
"kills":5,
"mount":1777386147,
"outfit":548281660,
"score":4718,
"side":2,
"timeAlive":362
},
"player":{
"id":"804919733530013696",
"name":"",
"patchVersion":"",
"shardId":"",
"stats":null,
"links":{
"schema":"",
"self":"https://api.dc01.gamelockerapp.com/shards//players/804919733530013696"
}
}
},
{
"id":"2c5b3b46-0c0c-4d2f-a8d8-45b77bda94d4",
"shardId":"global",
"stats":{
"attachment":0,
"emote":0,
"mount":0,
"outfit":0,
"side":0
},
"player":{
"id":"778308050036596736",
"name":"",
"patchVersion":"",
"shardId":"",
"stats":null,
"links":{
"schema":"",
"self":"https://api.dc01.gamelockerapp.com/shards//players/778308050036596736"
}
}
},
{
"id":"6357acf9-6c79-49df-9981-3c501269680a",
"shardId":"global",
"stats":{
"attachment":0,
"emote":0,
"mount":0,
"outfit":0,
"side":0
},
"player":{
"id":"782064337878671360",
"name":"",
"patchVersion":"",
"shardId":"",
"stats":null,
"links":{
"schema":"",
"self":"https://api.dc01.gamelockerapp.com/shards//players/782064337878671360"
}
}
},
{
"id":"f124454a-a07e-43d9-995c-4e8209f36196",
"shardId":"global",
"stats":{
"attachment":0,
"emote":0,
"mount":0,
"outfit":0,
"side":0
},
"player":{
"id":"781929883885531136",
"name":"",
"patchVersion":"",
"shardId":"",
"stats":null,
"links":{
"schema":"",
"self":"https://api.dc01.gamelockerapp.com/shards//players/781929883885531136"
}
}
}
]
}
],
"rounds":[
{
"id":"b1879071-8bfe-476b-b3b9-af2f9d04763f",
"duration":57,
"ordinal":0,
"winningTeam":2
},
{
"id":"77e7f8d7-3f3e-441d-b75b-f2f988359a43",
"duration":57,
"ordinal":1,
"winningTeam":2
},
{
"id":"8627f734-040e-4568-bf63-0d96c098a1a2",
"duration":81,
"ordinal":2,
"winningTeam":1
},
{
"id":"ee15166b-3371-42b7-aa69-1a9024965112",
"duration":46,
"ordinal":3,
"winningTeam":2
},
{
"id":"281674a9-b583-433e-86e4-439a9875565e",
"duration":58,
"ordinal":5,
"winningTeam":2
},
{
"id":"9af4425c-ebdb-4cf0-acde-c5ae36d55e4a",
"duration":64,
"ordinal":4,
"winningTeam":2
}
],
"spectators":[
],
"telemetry":"https://cdn.gamelockerapp.com/stunlock-studios-battlerite/global/2017/12/18/01/03/3e7d0ee9-e38f-11e7-a8ef-0a586460f089-telemetry.json"
}filter[gameMode] Misleading
In the query parameters table, the filter[gameMode] description is misleading.
Filter by gameMode Usage: filter[gameMode]=casual,ranked,…
Both casual and ranked return 404 responses. Using a value of 1733162751 works, but currently every match on the API uses that mode, so it doesn't actually filter anything.
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.